Reference
CLI reference
brigade on its own is shorthand for brigade tui. Run brigade --help or brigade <command> --help for full flags. Commands are grouped by area below.
Core#
| Command | What it does |
|---|---|
brigade · brigade tui | Start the chat TUI (auto-starts the gateway if needed) |
brigade connect | Attach a thin TUI to a running gateway (--host, --port) |
brigade agent <msg> | Drive a single turn (--provider, --model, -m) |
brigade onboard | Run the provider/model setup wizard |
brigade status | Snapshot config, sessions, and gateway state (--json) |
brigade doctor | Health-check Node, config, providers, prompts, logs, gateway (--json, --strict, --host, --port) |
brigade logs | Tail today's gateway log (--follow) |
brigade mcp | Serve long-term memory as an MCP server over stdio (--agent <id>) |
Gateway#
| Command | What it does |
|---|---|
brigade gateway run | Run the headless WebSocket gateway (--port, --host, --verbose, --quiet, --log-level) |
gateway status · stop · restart | Inspect / stop / restart the running gateway |
gateway install · uninstall | Install/remove as a system service (launchd / systemd / Task Scheduler) |
gateway supervise | Out-of-process crash watchdog |
Agents#
| Command | What it does |
|---|---|
brigade agents · agents list | List every configured agent (--json, --bindings) |
agents add [name] | Create an isolated agent (--workspace, --model, --provider, --bind, --non-interactive) |
agents delete <id> | Delete an agent + its workspace/sessions (--force) |
agents bind · unbind | Claim / release channel-account routing slots (--agent, --bind, --all) |
agents bindings | List routing bindings (--agent) |
agents set-identity | Set name / theme / emoji / avatar |
Org / Pride#
| Command | What it does |
|---|---|
brigade org init | Write a starter cfg.org block (--template solo|family|company|custom, --skip-editor) |
org show | Print an ASCII tree of the current org |
org explain <from> <to> | Show whether from can message to, and why |
org doctor | Run org lints (single-member dept, dangling overrides, depth > 5, …) |
Channels & pairing#
| Command | What it does |
|---|---|
channels list · status · add | List channels, probe status, add an account |
channels link · unlink | Pair / unpair a channel (e.g. WhatsApp QR) |
channels enable · disable | Toggle a channel |
channels allow list|add|remove | Manage the per-channel allowlist |
pairing list|approve|revoke | Review / approve / revoke pending pairing codes |
Cron#
| Command | What it does |
|---|---|
cron list · status · runs <jobId> | List jobs, service status, per-job run history |
cron add | Create a job (--cron/--every/--at, --tz, --message/--system-event, --model, --tools, --channel/--to) |
cron edit <jobId> · rm <jobId> | Modify / remove a job |
cron enable|disable|run <jobId> | Toggle or run a job on demand |
Storage, encryption & data#
| Command | What it does |
|---|---|
store mode show | Print the active storage mode (filesystem / convex) |
store mode set <mode> | Pin the mode (--convex-url for convex) |
store migrate --to <mode> | Copy data between backends (--dry-run, --keep-source) |
store reset | Factory-reset the Convex backend (--yes, --purge-local) |
encrypt status · init · test | Manage the AES-256-GCM at-rest key |
backup create · verify · restore | Snapshot / verify / restore your install as a .tar.gz |
secrets audit | Find suspected leaked credentials in your install |
Self-hosted Convex backend#
| Command | What it does |
|---|---|
brigade convex dev · start | Run the bundled backend (http://127.0.0.1:3210) + dashboard (http://127.0.0.1:6791) in the foreground; downloads the ~46 MB binary on first run, Ctrl-C to stop |
brigade convex status | Report whether the backend is running |
brigade convex stop | Explain how to stop the foreground backend (Ctrl-C) |
brigade convex push | Deploy the bundled convex/ functions to the running backend |
brigade convex codegen | Regenerate the Convex client (convex/_generated) |
Config, skills, sessions, exec#
| Command | What it does |
|---|---|
config list|get|set|unset|file|schema|validate | Read & write configuration |
skills list|info <name> | Inspect installed skills |
sessions list|cleanup | List + clean up session transcripts |
exec list|allow|allow-pattern|remove|deny-test|file | Manage the bash-tool approval allowlist |
Looking for a specific flag?
Every command supports
--help. For the storage, security, and gateway commands in context, see Storage, Security, and The gateway.