Skip to main content

CLI Reference

Command-line reference for the spectral-bridge package. For a guided walkthrough, see the Quickstart.

Installation​

Example
pip install spectral-bridge
# or, with extra dependencies for built-in adapters:
pip install "spectral-bridge[pass-through]"

Authentication​

All commands require the SPECTRAL_BRIDGE_API_KEY environment variable:

Example
export SPECTRAL_BRIDGE_API_KEY=<your-api-key>

Commands​

spectral-bridge start​

Starts both the relay client and a passthrough adapter.

Example
spectral-bridge start \
  --relay-url  wss://relay.example.com/connect \  # relay server WebSocket URL
  --adapter    pass-through \                     # built-in adapter to spawn
  --target     http://internal-host:8080          # base URL of your AI system

Optional flags: --port sets the local port for the adapter (default: 8840). --insecure-relay allows ws:// instead of wss:// (development only).

spectral-bridge start-relay​

Starts only the relay client, connecting it to an adapter you are already running.

Example
spectral-bridge start-relay \
  --relay-url    wss://relay.example.com/connect \  # relay server WebSocket URL
  --adapter-url  http://localhost:8000              # URL of your running adapter

Optional flag: --insecure-relay allows ws:// instead of wss:// (use it for development only).