displayName
amux launch
kind
cli-subcommand
surface
cli
parentBin
amux
subcommandVerb
launch
flags
- --api-key:1:provider API key
- --api-base:1:provider API endpoint
- --region:1:cloud region (Bedrock/Vertex)
- --project:1:cloud project (Vertex/Foundry)
- --resource-group:1:Azure resource group
- --endpoint-name:1:cloud endpoint name
- -t / --transport:1:wire protocol
- --auth-command:1:command emitting bearer token
- --with-proxy-if-needed:0:auto-launch proxy when harness lacks native support
- --with-proxy:0:force proxy
- --no-proxy:0:disable proxy
- --proxy-port:1:proxy port (0=auto)
- --proxy-log-level:1:proxy log level
- -r / --resume:1:resume session id
- -s / --session-id:1:explicit new session id
- -p / --prompt:1:non-interactive prompt
- --max-turns:1:turn limit
- --max-budget-usd:1:budget limit
- --dry-run:0:print plan without executing
- --provider-arg:N:KEY=VALUE provider param (repeatable)
- --observe:0:tee stdio to a log file
- --workspace:1:resolve existing workspace
- --workspace-create:0:create a workspace before launching
- --workspace-mode:1:worktree|symlink
- --workspace-repo:N:repo path (repeatable)
- --workspace-name:1:workspace name override
subcommandExitCodes
- 0:success:harness exited cleanly (or dry-run printed)
- 1:general-error:SPAWN_ERROR (proxy/ollama/runtime)
- 2:usage-error:VALIDATION_ERROR (missing harness, mutually-exclusive proxy flags)
- 3:agent-not-found:AGENT_NOT_FOUND (unknown harness or not installed)
- 6:capability-error:CAPABILITY_ERROR (resume unsupported)
description
Resolve a launch plan (provider/transport/proxy), optionally start the
transport-mux runtime, then spawn the harness with stdin/stdout
passthrough and signal forwarding. Source:
packages/agent-mux/cli/src/commands/launch.ts:268-580.