The CLI
Drive spawn from the terminal, configure it with flags or environment variables, and run the server.
spawn is driven from the terminal. The TUI is the primary surface for orchestrating parallel coding agents, and everything starts from the command line in the monorepo.
Getting started
Explore the options
Pass --help to any spawn command to see all available options.
bun dev:tui --helpConfiguration options
Every option is settable as a command-line flag or as an environment variable, so you can wire spawn into shells, scripts, and service managers however you prefer.
| CLI flag | Env var | Notes |
|---|---|---|
--mode <web|desktop> | SPAWN_MODE | Runtime mode. |
--port <number> | SPAWN_PORT | HTTP/WebSocket port. |
--host <address> | SPAWN_HOST | Bind interface/address. |
--base-dir <path> | SPAWN_HOME | Base directory. |
--dev-url <url> | VITE_DEV_SERVER_URL | Dev web URL redirect/proxy target. |
--no-browser | SPAWN_NO_BROWSER | Disable auto-open browser. |
--auth-token <token> | SPAWN_AUTH_TOKEN | WebSocket auth token. Use for standard CLI and remote-server flows. |
--bootstrap-fd <fd> | SPAWN_BOOTSTRAP_FD | Read a one-shot bootstrap envelope from an inherited file descriptor during startup. |
Running the server
For remote and production use, build everything first, then launch the server as the built app rather than in Vite dev redirect mode.
bun run build
bun run --cwd apps/server start -- --host 0.0.0.0 --port 3773 --auth-token "$TOKEN" --no-browserTo open spawn from another device, see Remote access. For what the server actually does, see the gateway.