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#

CommandWhat it does
brigade · brigade tuiStart the chat TUI (auto-starts the gateway if needed)
brigade connectAttach a thin TUI to a running gateway (--host, --port)
brigade agent <msg>Drive a single turn (--provider, --model, -m)
brigade onboardRun the provider/model setup wizard
brigade statusSnapshot config, sessions, and gateway state (--json)
brigade doctorHealth-check Node, config, providers, prompts, logs, gateway (--json, --strict, --host, --port)
brigade logsTail today's gateway log (--follow)
brigade mcpServe long-term memory as an MCP server over stdio (--agent <id>)

Gateway#

CommandWhat it does
brigade gateway runRun the headless WebSocket gateway (--port, --host, --verbose, --quiet, --log-level)
gateway status · stop · restartInspect / stop / restart the running gateway
gateway install · uninstallInstall/remove as a system service (launchd / systemd / Task Scheduler)
gateway superviseOut-of-process crash watchdog

Agents#

CommandWhat it does
brigade agents · agents listList 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 · unbindClaim / release channel-account routing slots (--agent, --bind, --all)
agents bindingsList routing bindings (--agent)
agents set-identitySet name / theme / emoji / avatar

Org / Pride#

CommandWhat it does
brigade org initWrite a starter cfg.org block (--template solo|family|company|custom, --skip-editor)
org showPrint an ASCII tree of the current org
org explain <from> <to>Show whether from can message to, and why
org doctorRun org lints (single-member dept, dangling overrides, depth > 5, …)

Channels & pairing#

CommandWhat it does
channels list · status · addList channels, probe status, add an account
channels link · unlinkPair / unpair a channel (e.g. WhatsApp QR)
channels enable · disableToggle a channel
channels allow list|add|removeManage the per-channel allowlist
pairing list|approve|revokeReview / approve / revoke pending pairing codes

Cron#

CommandWhat it does
cron list · status · runs <jobId>List jobs, service status, per-job run history
cron addCreate 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#

CommandWhat it does
store mode showPrint 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 resetFactory-reset the Convex backend (--yes, --purge-local)
encrypt status · init · testManage the AES-256-GCM at-rest key
backup create · verify · restoreSnapshot / verify / restore your install as a .tar.gz
secrets auditFind suspected leaked credentials in your install

Self-hosted Convex backend#

CommandWhat it does
brigade convex dev · startRun 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 statusReport whether the backend is running
brigade convex stopExplain how to stop the foreground backend (Ctrl-C)
brigade convex pushDeploy the bundled convex/ functions to the running backend
brigade convex codegenRegenerate the Convex client (convex/_generated)

Config, skills, sessions, exec#

CommandWhat it does
config list|get|set|unset|file|schema|validateRead & write configuration
skills list|info <name>Inspect installed skills
sessions list|cleanupList + clean up session transcripts
exec list|allow|allow-pattern|remove|deny-test|fileManage 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.