CLI

pulse run

Run the Pulse server and web development server together.

pulse run <app_file> [options]

Arguments

Options

Examples

# Run with defaults
pulse run app.py

# Production mode on specific port
pulse run app.py --prod --port 3000

# Development with specific address
pulse run app.py --address 0.0.0.0 --port 8080

# Run only backend (for separate frontend deployment)
pulse run app.py --server-only --react-server-address http://localhost:5173

In dev mode, before launching the web dev server pulse run installs web dependencies with Bun and generates the route files. Both steps are idempotent and fast on warm starts, so a fresh checkout works without a separate pulse check --fix or pulse generate first.

If another Pulse dev instance is already running for the same app, stop it first or rerun with --interrupt.

pulse generate

Generate TypeScript routes without starting the server.

pulse generate <app_file> [options]

Arguments

Options

Examples

# Generate routes for development
pulse generate app.py

# Generate for production (requires server_address)
pulse generate app.py --prod

In CI or production mode, server_address must be configured in the App constructor or via PULSE_SERVER_ADDRESS environment variable.

pulse check

Check if web project dependencies are in sync with Pulse app requirements.

pulse check <app_file> [options]

Arguments

Options

Examples

# Check dependencies
pulse check app.py

# Check and auto-fix
pulse check app.py --fix

Environment Variables

PULSE_ENV

PULSE_ENV=dev|ci|prod

Set the Pulse environment mode. Affects logging, security defaults, and error handling.

PULSE_APP_FILE

PULSE_APP_FILE=/path/to/app.py

Path to the Pulse application file. Used for resolving relative paths in CodegenConfig.

PULSE_APP_DIR

PULSE_APP_DIR=/path/to/app

Directory containing the Pulse application. Fallback for path resolution when PULSE_APP_FILE is not set.

PULSE_HOST

PULSE_HOST=0.0.0.0

Host address for the uvicorn server. Set automatically by pulse run.

PULSE_PORT

PULSE_PORT=8000

Port for the uvicorn server. Set automatically by pulse run.

PULSE_SERVER_ADDRESS

PULSE_SERVER_ADDRESS=https://api.example.com

Public server address for WebSocket connections. Required in production mode.

PULSE_REACT_SERVER_ADDRESS

PULSE_REACT_SERVER_ADDRESS=http://localhost:5173

React dev server address. Used in single-server mode with --server-only.

PULSE_SECRET

PULSE_SECRET=your-secret-key

Secret key for session signing. Auto-generated in development if not set.

PULSE_DISABLE_CODEGEN

PULSE_DISABLE_CODEGEN=1

Disable automatic code generation. Useful in production with pre-built routes.

Exit Codes