Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -158,3 +158,6 @@ dashboard/frontend/index.html.old

# Kind cluster configuration
tools/kind/kind-config.yaml

# Generated by 'vsr init' - contains environment-specific settings
config/config.yaml
53 changes: 52 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,58 @@ Watch the quick demo of the dashboard below:

## Quick Start 🚀

Get up and running in seconds with our interactive setup script:
### Using VSR CLI (Recommended)

The `vsr` CLI tool provides a unified interface for managing the vLLM Semantic Router across all environments. It reduces setup time from hours to minutes with intelligent auto-detection, comprehensive diagnostics, and beautiful CLI output.

#### Installation

```bash
# Clone and build
cd semantic-router/src/semantic-router
make build-cli
export PATH=$PATH:$(pwd)/bin

# Verify installation
vsr --version
```

#### Get Started in 4 Commands

```bash
vsr init # Initialize configuration
make download-models # Download AI models
vsr config validate # Validate setup
vsr deploy docker # Deploy with Docker Compose
```

#### Key Features

- **Multi-Environment Support**: Deploy to Local, Docker, Kubernetes, or Helm
- **Model Management**: Download, validate, list, and inspect models
- **Health Monitoring**: Status checks, diagnostics, and health reports
- **Debug Tools**: Interactive debugging and troubleshooting
- **Dashboard Integration**: Auto-detect and open dashboard in browser
- **Enhanced Logging**: Multi-environment log fetching with filtering

#### Common Commands

```bash
vsr status # Check deployment status
vsr logs --follow # View logs in real-time
vsr health # Quick health check
vsr dashboard # Open dashboard
vsr model list # List available models
vsr debug # Run diagnostics
vsr upgrade docker # Upgrade deployment
vsr undeploy docker # Stop deployment
```

For complete CLI documentation, see [src/semantic-router/cmd/vsr/README.md](src/semantic-router/cmd/vsr/README.md) or [Quick Start Guide](src/semantic-router/cmd/vsr/QUICKSTART.md).

### Using Quickstart Script

Alternatively, get up and running in seconds with our interactive setup script:

```bash
bash ./scripts/quickstart.sh
Expand Down
Loading
Loading