CLI reference

This page is regenerated by scripts/docs-cli-extract.ts. Running the extractor is idempotent; the CI workflow runs it on every PR and asserts the committed file is in sync with the CLI source.

Regenerate this section with bun run scripts/docs-cli-extract.ts.

declaragent

declaragent — interactive REPL

Usage:
  declaragent [--mode <default|plan|bypass|auto>] [--model <model>]
  declaragent auth login [<provider>] [--api-key <key>] [--callback-port <n>]
  declaragent auth status
  declaragent auth logout

  declaragent plugin install <path> [--yes]
  declaragent plugin list
  declaragent plugin info <id>
  declaragent plugin remove <id>

  declaragent skill list

  declaragent mcp add <name> --command <cmd> [--args a,b,c] [--protocol <ver>]
  declaragent mcp list
  declaragent mcp remove <name>

  declaragent extensions

  declaragent daemon
  declaragent daemon-status
  declaragent daemon-reload
  declaragent daemon-shutdown [--no-drain]

  declaragent events list [--kind <k>] [--last <n>] [--correlation <id>] [--outcome <kind>]
  declaragent events show <id>
  declaragent events replay <id>
  declaragent events replay-range --source <id> --from <ms> [--to <ms>] [--limit <n>] [--filter <expr>] [--no-dispatch]

  declaragent dlq list --source <id> [--since <ms>] [--limit <n>]
  declaragent dlq show --source <id> <entryId>
  declaragent dlq redrive --source <id> <entryId>

  declaragent events-config validate [path]

  declaragent source list
  declaragent source add <type> <id> --config '<json>' | --config-file <path>
  declaragent source remove <type:id | id>
  declaragent source-adapters list

  declaragent mailbox depth <agent-id>
  declaragent mailbox drain <agent-id>

  declaragent fleet new <name> [--out <dir>] [--force]
  declaragent fleet add --template <name> [--id <id>] [--force]
  declaragent fleet add --path <dir> [--id <id>] [--force]
  declaragent fleet promote <path> [--apply] [--id <id>] [--force]
  declaragent fleet demote [<id>] [--force]
  declaragent fleet run [--agent <id>...]
  declaragent fleet deploy [--target <name>] [--agent <id>...] [--strategy <rolling|all-or-nothing|per-agent>]
  declaragent fleet deploy --dry-run | --rollback | --target-config <path>
  declaragent fleet graph [--format <mermaid|dot|json>]
  declaragent fleet peers [--verify] [--json]
  declaragent fleet status [--history] [--limit <n>] [--json]
  declaragent fleet list [--json]
  declaragent fleet validate [--json]
  declaragent fleet capabilities [--json]

  declaragent init --fleet <name> [--out <dir>] [--force]   # shortcut for \`fleet new\`

  declaragent tenants list [--json]
  declaragent tenants show <id> [--json]
  declaragent tenants diff [--json]

  declaragent audit query [--tenant X] [--kind Y] [--since ms] [--until ms] [--limit N] [--json]
  declaragent audit verify [--tenant X] [--json]
  declaragent audit erase --user <platformUserId> [--reason R] [--json]
  declaragent audit prune --tenant <id> --retention-days <N> [--json]

  declaragent secrets list [--provider <name>] [--json]
  declaragent secrets describe <ref> [--json]
  declaragent secrets rotate <ref> [--tenant X] [--reason R] [--json]

  declaragent init [--out <dir>] [--force] [--multi-tenant] [--template <name>] [--provider <id>]

  declaragent deploy gcp-cloud-run [--out <dir>] [--force] [--project <id>] [--region <r>]
                                   [--service <name>] [--cpu <n>] [--memory-mib <n>]
                                   [--min-instances <n>] [--verify] [--json]

  declaragent migrate [--config-dir <path>] [--apply] [--json]

Providers:
  cloud:  {…}
  local:  {…}

Flags:
  --mode      Permission mode (default: default — prompts on each tool call)
  --model     Model id to use for this session.
  --version   Print the declaragent version.
  --help      Show this message.

Environment (per-provider, see registry for the full list):
  ANTHROPIC_API_KEY, OPENAI_API_KEY, OPENROUTER_API_KEY, GROQ_API_KEY,
  DEEPSEEK_API_KEY, TOGETHER_API_KEY, MISTRAL_API_KEY, XAI_API_KEY, ...

Credential file: {…}
Slash commands inside the REPL: /help

declaragent init

declaragent init — first-run wizard

Usage:
  declaragent init [--out <dir>] [--force] [--multi-tenant]
                   [--template <name>] [--provider <id>] [--tenant-id <id>]
                   [--skip-verify]

Flags:
  --out <dir>          Target directory (default: ./)
  --force              Overwrite an existing agent.yaml
  --multi-tenant       Scaffold tenants.yaml too + prompt for tenant id
  --template <name>    Non-interactive template pick
                       (concierge | oncall-escalator | pr-review |
                        kafka-pipeline | multi-tenant-starter)
  --provider <id>      Non-interactive provider pick (matches \`auth login <id>\`)
  --tenant-id <id>     Tenant id used when --multi-tenant is set
  --skip-verify        Skip the one-shot LLM verify call