SUPERVAIZER CLI

SUPERVAIZER includes a command-line interface to simplify setup and operation:

# Install Supervaizer
pip install supervaizer

# Get Help
supervaizer --help

# Create a supervaizer_control.py file in your current directory
supervaizer scaffold


# Start the server using the configuration file
supervaizer start

# Deploy to cloud platforms
supervaizer deploy up --platform cloud-run --name my-agent

# To get all the start options
supervaizer start --help

CLI Commands

install

Creates a starter configuration file (supervaizer_control.py)

# Basic usage (creates supervaizer_control.py in current directory)
supervaizer scaffold
# Specify a custom output path
supervaizer scaffold --output-path=my_config.py

# Force overwrite if file already exists
supervaizer scaffold --force

start

Starts the Supervaizer server

# Basic usage (loads supervaizer_control.py from current directory)
supervaizer start

# Specify a custom configuration file
supervaizer start my_config.py

# Configure server options
supervaizer start --host=0.0.0.0 --port=8080 --environment=production

# Enable debug mode and auto-reload
supervaizer start --debug --reload

# Set log level
supervaizer start --log-level=DEBUG

deploy

Deploy Supervaizer agents to cloud platforms with full automation

# Plan deployment (preview changes)
supervaizer deploy plan --platform cloud-run --name my-agent --env prod

# Test locally with Docker
supervaizer deploy local --name my-agent --generate-api-key

# Generate Docker files only (for CI/CD or manual testing)
supervaizer deploy local --docker-files-only --name my-agent --generate-api-key

# Custom source directory and controller file
supervaizer deploy local --source-dir . --controller-file my_controller.py

# Combined with docker-files-only
supervaizer deploy local --docker-files-only --source-dir lib --controller-file custom_controller.py

# Deploy to cloud platform
supervaizer deploy up --platform cloud-run --name my-agent --env prod

# Check deployment status
supervaizer deploy status --platform cloud-run --name my-agent --env prod

# Remove deployment
supervaizer deploy down --platform cloud-run --name my-agent --env prod

Supported Platforms:

• cloud-run - Google Cloud Run
• aws-app-runner - AWS App Runner
• do-app-platform - DigitalOcean App Platform

Common Options:

• --platform - Cloud platform (required)
• --name - Service name (default: current directory)
• --env - Environment (dev/staging/prod, default: dev)
• --region - Provider region
• --generate-api-key - Create secure API key
• --yes - Non-interactive mode

local

Test Supervaizer agents locally using Docker before cloud deployment

# Test locally with default settings
supervaizer deploy local --name my-agent

# Test with custom options
supervaizer deploy local \
  --name email-agent \
  --env dev \
  --port 8000 \
  --generate-api-key \
  --generate-rsa \
  --timeout 60 \
  --verbose

Local Testing Options:

• --name - Service name (default: current directory)
• --env - Environment (dev/staging/prod, default: dev)
• --port - Application port (default: 8000)
• --generate-api-key - Create secure API key for testing
• --generate-rsa - Generate RSA private key for testing
• --timeout - Seconds to wait for service startup (default: 30)
• --verbose - Show Docker Compose output
• --docker-files-only - Only generate Docker files without running them
• --source-dir - Source directory path (default: src)
• --controller-file - Controller file name (default: supervaizer_control.py)

For detailed deployment documentation, see the Cloud Deployment Guide.

Environment Variables

All CLI options can also be configured through environment variables:

Environment Variable	Description	Default Value
SUPERVAIZER_PUBLIC_URL	Url used for inbound connections	defaults to scheme+host+port
SUPERVAIZER_HOST	Host to bind the server to	0.0.0.0
SUPERVAIZER_PORT	Port to bind the server to	8000
SUPERVAIZER_ENVIRONMENT	Environment name	dev
SUPERVAIZER_LOG_LEVEL	Log level (DEBUG, INFO, etc.)	INFO
SUPERVAIZER_DEBUG	Enable debug mode (true/false)	false
SUPERVAIZER_RELOAD	Enable auto-reload (true/false)	false
SUPERVAIZER_SCRIPT_PATH	Path to configuration script	-
SUPERVAIZER_OUTPUT_PATH	Path for install command output	supervaizer_control.py
SUPERVAIZER_FORCE_INSTALL	Force overwrite existing file	false

Uploaded on 2025-08-12 14:19:38