Skip to main content
The synth-ai package installs a CLI with commands for the public infrastructure surfaces.
synth-ai --help

Auth

The CLI reads SYNTH_API_KEY and SYNTH_BACKEND_URL.
export SYNTH_API_KEY="sk_..."
synth-ai tunnels list
You can also pass flags per command:
synth-ai containers list --backend-url https://api.usesynth.ai

Containers

synth-ai containers list
synth-ai containers get container_123
synth-ai containers create \
  --name my-container \
  --task-type harbor_code \
  --definition '{"repo":"https://github.com/owner/repo"}'

Tunnels

synth-ai tunnels list
synth-ai tunnels create --subdomain my-dev --local-port 8000
synth-ai tunnels lease-create --client-instance-id local-dev --local-port 8000

Pools and rollouts

synth-ai pools list
synth-ai pools get pool_123
synth-ai pools rollout-create pool_123 --request @rollout.json
synth-ai pools rollout-summary pool_123 rollout_123
synth-ai pools rollout-artifacts pool_123 rollout_123
CLI output is JSON so it can be piped into other tools.