coderClaw

CLI reference

This page describes the current CLI behavior. If commands change, update this doc.

Command pages

Global flags

Output styling

Color palette

CoderClaw uses a lobster palette for CLI output.

Palette source of truth: src/terminal/palette.ts (aka “lobster seam”).

Command tree

coderclaw [--dev] [--profile <name>] <command>
  setup
  onboard
  configure
  config
    get
    set
    unset
  doctor
  security
    audit
  reset
  uninstall
  update
  channels
    list
    status
    logs
    add
    remove
    login
    logout
  skills
    list
    info
    check
  plugins
    list
    info
    install
    enable
    disable
    doctor
  memory
    status
    index
    search
  message
  agent
  agents
    list
    add
    delete
  acp
  status
  health
  sessions
  gateway
    call
    health
    status
    probe
    discover
    install
    uninstall
    start
    stop
    restart
    run
  logs
  system
    event
    heartbeat last|enable|disable
    presence
  models
    list
    status
    set
    set-image
    aliases list|add|remove
    fallbacks list|add|remove|clear
    image-fallbacks list|add|remove|clear
    scan
    auth add|setup-token|paste-token
    auth order get|set|clear
  sandbox
    list
    recreate
    explain
  cron
    status
    list
    add
    edit
    rm
    enable
    disable
    runs
    run
  nodes
  devices
  node
    run
    status
    install
    uninstall
    start
    stop
    restart
  approvals
    get
    set
    allowlist add|remove
  browser
    status
    start
    stop
    reset-profile
    tabs
    open
    focus
    close
    profiles
    create-profile
    delete-profile
    screenshot
    snapshot
    navigate
    resize
    click
    type
    press
    hover
    drag
    select
    upload
    fill
    dialog
    wait
    evaluate
    console
    pdf
  hooks
    list
    info
    check
    enable
    disable
    install
    update
  webhooks
    gmail setup|run
  pairing
    list
    approve
  docs
  dns
    setup
  tui

Note: plugins can add additional top-level commands (for example coderclaw voicecall).

Security

Plugins

Manage extensions and their config:

Most plugin changes require a gateway restart. See /plugin.

Memory

Vector search over MEMORY.md + memory/*.md:

Chat slash commands

Chat messages support /... commands (text and native). See /tools/slash-commands.

Highlights:

Setup + onboarding

setup

Initialize config + workspace.

Options:

Wizard auto-runs when any wizard flags are present (--non-interactive, --mode, --remote-url, --remote-token).

onboard

Interactive wizard to set up gateway, workspace, and skills.

Options:

configure

Interactive configuration wizard (models, channels, skills, gateway).

config

Non-interactive config helpers (get/set/unset). Running coderclaw config with no subcommand launches the wizard.

Subcommands:

doctor

Health checks + quick fixes (config + gateway + legacy services).

Options:

Channel helpers

channels

Manage chat channel accounts (WhatsApp/Telegram/Discord/Google Chat/Slack/Mattermost (plugin)/Signal/iMessage/MS Teams).

Subcommands:

Common options:

channels login options:

channels logout options:

channels list options:

channels logs options:

More detail: /concepts/oauth

Examples:

coderclaw channels add --channel telegram --account alerts --name "Alerts Bot" --token $TELEGRAM_BOT_TOKEN
coderclaw channels add --channel discord --account work --name "Work Bot" --token $DISCORD_BOT_TOKEN
coderclaw channels remove --channel discord --account work --delete
coderclaw channels status --probe
coderclaw status --deep

skills

List and inspect available skills plus readiness info.

Subcommands:

Options:

Tip: use npx clawhub to search, install, and sync skills (CLI command can be changed with skills.registry.cli if you run a different registry).

pairing

Approve DM pairing requests across channels.

Subcommands:

webhooks gmail

Gmail Pub/Sub hook setup + runner. See /automation/gmail-pubsub.

Subcommands:

dns setup

Wide-area discovery DNS helper (CoreDNS + Tailscale). See /gateway/discovery.

Options:

Messaging + agent

message

Unified outbound messaging + channel actions.

See: /cli/message

Subcommands:

Examples:

agent

Run one agent turn via the Gateway (or --local embedded).

Required:

Options:

agents

Manage isolated agents (workspaces + auth + routing).

agents list

List configured agents.

Options:

agents add [name]

Add a new isolated agent. Runs the guided wizard unless flags (or --non-interactive) are passed; --workspace is required in non-interactive mode.

Options:

Binding specs use channel[:accountId]. When accountId is omitted for WhatsApp, the default account id is used.

agents delete <id>

Delete an agent and prune its workspace + state.

Options:

acp

Run the ACP bridge that connects IDEs to the Gateway.

See acp for full options and examples.

status

Show linked session health and recent recipients.

Options:

Notes:

Usage tracking

CoderClaw can surface provider usage/quota when OAuth/API creds are available.

Surfaces:

Notes:

health

Fetch health from the running Gateway.

Options:

sessions

List stored conversation sessions.

Options:

Reset / Uninstall

reset

Reset local config/state (keeps the CLI installed).

Options:

Notes:

uninstall

Uninstall the gateway service + local data (CLI remains).

Options:

Notes:

Gateway

gateway

Run the WebSocket Gateway.

Options:

gateway service

Manage the Gateway service (launchd/systemd/schtasks).

Subcommands:

Notes:

logs

Tail Gateway file logs via RPC.

Notes:

Examples:

coderclaw logs --follow
coderclaw logs --limit 200
coderclaw logs --plain
coderclaw logs --json
coderclaw logs --no-color

gateway <subcommand>

Gateway CLI helpers (use --url, --token, --password, --timeout, --expect-final for RPC subcommands). When you pass --url, the CLI does not auto-apply config or environment credentials. Include --token or --password explicitly. Missing explicit credentials is an error.

Subcommands:

Common RPCs:

Tip: when calling config.set/config.apply/config.patch directly, pass baseHash from config.get if a config already exists.

Models

See /concepts/models for fallback behavior and scanning strategy.

Preferred Anthropic auth (setup-token):

claude setup-token
coderclaw models auth setup-token --provider anthropic
coderclaw models status

models (root)

coderclaw models is an alias for models status.

Root options:

models list

Options:

models status

Options:

Always includes the auth overview and OAuth expiry status for profiles in the auth store. --probe runs live requests (may consume tokens and trigger rate limits).

models set <model>

Set agents.defaults.model.primary.

models set-image <model>

Set agents.defaults.imageModel.primary.

models aliases list|add|remove

Options:

models fallbacks list|add|remove|clear

Options:

models image-fallbacks list|add|remove|clear

Options:

models scan

Options:

models auth add|setup-token|paste-token

Options:

models auth order get|set|clear

Options:

System

system event

Enqueue a system event and optionally trigger a heartbeat (Gateway RPC).

Required:

Options:

system heartbeat last|enable|disable

Heartbeat controls (Gateway RPC).

Options:

system presence

List system presence entries (Gateway RPC).

Options:

Cron

Manage scheduled jobs (Gateway RPC). See /automation/cron-jobs.

Subcommands:

All cron commands accept --url, --token, --timeout, --expect-final.

Node host

node runs a headless node host or manages it as a background service. See coderclaw node.

Subcommands:

Nodes

nodes talks to the Gateway and targets paired nodes. See /nodes.

Common options:

Subcommands:

Camera:

Canvas + screen:

Location:

Browser

Browser control CLI (dedicated Chrome/Brave/Edge/Chromium). See coderclaw browser and the Browser tool.

Common options:

Manage:

Inspect:

Actions:

docs [query...]

Search the live docs index.

TUI

tui

Open the terminal UI connected to the Gateway.

Options: