Docs
Refer friends. Keep the rewards coming!Your friend can unlock up to 10M tokens · earn up to 30% revenue share.
+500K TokensGenerate link

CLI Reference

Complete quick reference for CLI flags, subcommands, and in-TUI slash commands.

What it is

crabcode is the top-level command. Two entry points:

  • Subcommands — run from your shell, e.g. crabcode doctor, crabcode cron list
  • Slash commands — typed inside the TUI, e.g. /help, /init, /model

When you see this doc

  • Looking up a specific flag or slash command
  • Browsing available subcommands

Launching

With no subcommand, crabcode opens the TUI:

bash
crabcode                  # Launch interactive TUI (default)
crabcode "explain this"   # Enter a session with a prompt
crabcode -p "summarize"   # One-shot print mode: print and exit
crabcode                  # Launch interactive TUI (default)
crabcode "explain this"   # Enter a session with a prompt
crabcode -p "summarize"   # One-shot print mode: print and exit

Subcommands

bash
crabcode doctor           # Diagnose environment (version / platform / git / gh / bootstrap)
crabcode version          # Print version only (same as --version)
crabcode browser ...      # Browser automation CLI mode (see [chrome](/en/docs/crabcode/chrome))
crabcode cron ...         # Cron job management (see matrix below)
crabcode auth ...         # Login / status / logout
crabcode mcp ...          # MCP server management
crabcode plugin ...       # Plugins, marketplace, install, enable/disable
crabcode server           # Start the App Server for desktop / IDE / local integrations
crabcode serve            # Native launcher service entry
crabcode open <cc-url>    # Open a cc://connect?... deep link
crabcode ssh <host> [dir] # Enter a remote working directory over SSH
crabcode agents           # Manage agent configuration
crabcode auto-mode ...    # Auto-mode defaults / config / critique
crabcode update           # Check and install the latest version (upgrade also works)
crabcode install          # Install / reinstall the native build
crabcode --help           # Full subcommand + flag listing
crabcode doctor           # Diagnose environment (version / platform / git / gh / bootstrap)
crabcode version          # Print version only (same as --version)
crabcode browser ...      # Browser automation CLI mode (see [chrome](/en/docs/crabcode/chrome))
crabcode cron ...         # Cron job management (see matrix below)
crabcode auth ...         # Login / status / logout
crabcode mcp ...          # MCP server management
crabcode plugin ...       # Plugins, marketplace, install, enable/disable
crabcode server           # Start the App Server for desktop / IDE / local integrations
crabcode serve            # Native launcher service entry
crabcode open <cc-url>    # Open a cc://connect?... deep link
crabcode ssh <host> [dir] # Enter a remote working directory over SSH
crabcode agents           # Manage agent configuration
crabcode auto-mode ...    # Auto-mode defaults / config / critique
crabcode update           # Check and install the latest version (upgrade also works)
crabcode install          # Install / reinstall the native build
crabcode --help           # Full subcommand + flag listing

Current builds support both installer-script upgrades and CLI update / upgrade / install flows. If a platform-specific launcher differs, trust crabcode --help.

Account: crabcode auth

SubcommandPurpose
crabcode auth loginStart login
crabcode auth statusPrint account state
crabcode auth logoutSign out

MCP: crabcode mcp

SubcommandPurpose
crabcode mcp serveRun CrabCode as an MCP server
crabcode mcp listList configured MCP servers
crabcode mcp add <name> <command> [args...]Add a stdio MCP server
crabcode mcp add-json <name> '<json>'Add from JSON config
crabcode mcp add-from-crabcode-desktopImport from desktop config
crabcode mcp get <name>Show one server config
crabcode mcp remove <name>Remove a server
crabcode mcp reset-project-choicesReset project-level MCP choices

Plugins: crabcode plugin / crabcode plugins

SubcommandPurpose
crabcode plugin listList plugins
crabcode plugin validate <dir>Validate a local plugin
crabcode plugin install <source>Install a plugin
crabcode plugin uninstall <id>Uninstall a plugin
crabcode plugin enable <id> / disable <id>Enable or disable
crabcode plugin update <id>Update
crabcode plugin marketplace add <url>Add a marketplace
crabcode plugin marketplace listList marketplaces
crabcode plugin marketplace remove <id>Remove a marketplace
crabcode plugin marketplace update <id>Update a marketplace
CommandPurpose
crabcode serverStart the local App Server and print a cc://connect?... URL
crabcode open <cc-url>Open a cc://connect?transport=tcp-ws... deep link
crabcode ssh <host> [dir]Run CrabCode in a remote working directory over SSH
crabcode remote-control / crabcode rcRemote-control bridge
crabcode daemon ...Daemon management entry

Background sessions

CommandPurpose
crabcode --bg "..."Run a task in the background
crabcode psList background sessions
crabcode logs <id>Show background logs
crabcode attach <id>Attach to a background session
crabcode kill <id>Stop a background session

Other management entries

CommandPurpose
crabcode wizardInteractive setup or diagnosis wizard
crabcode setup-tokenSet or refresh a local token
crabcode agentsManage custom agents
crabcode auto-mode defaultsPrint auto-mode defaults
crabcode auto-mode configInspect or edit auto-mode config
crabcode auto-mode critiqueCritique auto-mode behavior
crabcode environment-runnerEnvironment runner entry
crabcode self-hosted-runnerSelf-hosted runner entry

crabcode cron subcommand matrix

Cron jobs run via a standalone crabcode-cron daemon that is auto-spawned on first use. Disable with CRABCODE_DISABLE_CRON=1.

SubcommandPurpose
crabcode cron list [--json]List all cron jobs
crabcode cron add --name <n> --schedule "<cron>" [--once] [--agent-id <id>] [--message <s>]Create a recurring job from a 5-field cron expression
crabcode cron add --name <n> --at &lt;ISO-8601&gt;Fire once at an absolute time (implies --once)
crabcode cron add --name <n> --every-ms <ms>Fire every N milliseconds
crabcode cron edit <id> [--name ...] [--schedule ...] [--agent-id ...] [--message ...]Edit selected fields on an existing job
crabcode cron rm <id>Remove a job
crabcode cron enable <id>Enable a job
crabcode cron disable <id>Disable a job
crabcode cron status [--json]Daemon status (total / enabled jobs / version)
crabcode cron run <id>Fire once immediately
crabcode cron runs <id> [--limit N] [--json]View run history

--schedule / --at / --every-ms are mutually exclusive. --at implies --once.

Common flags

FlagDescription
-p, --printOne-shot: prompt → output → exit
-c, --continueContinue the most recent session in this directory
-r, --resume [<id>]Pick a past session (interactive if no id given)
--fork-sessionWhen resuming, allocate a fresh session id
--model <name>Pick model (semantic alias like best / planmode, or full model id)
--effort <level>Thinking effort: low / medium / high / max
--permission-mode <mode>Startup mode: default / acceptEdits / plan / bypassPermissions / dontAsk
--add-dir <path...>Grant CrabCode extra working directories (repeatable)
--mcp-config <file...>Load one or more MCP server configs
--plugin-dir <path>Load plugins from a directory for this session (repeatable)
--settings <file-or-json>Load additional settings (file path or JSON string)
--agents <json>Inline JSON defining custom agents
--agent <name>Start with the given agent active
--session-id <uuid>Use a specific session id (must be a valid UUID)
-n, --name <name>Display name for the session
--output-format <fmt>--print output format: text / json / stream-json
--input-format <fmt>--print input format: text / stream-json
--json-schema <schema>Require JSON output to follow a schema in --print mode
--include-hook-eventsInclude hook events in stream-json output
--include-partial-messagesInclude partial messages in stream-json output
--max-turns <n>Maximum agentic turns in non-interactive mode (with --print)
--max-budget-usd <n>Hard cap on API spend (with --print)
--allowedTools <tools...>Tool allowlist (comma- or space-separated, e.g. "Bash(git:*) Edit")
--disallowedTools <tools...>Tool denylist
--tools <tools...>Explicit tool set ("" disables all, default keeps all)
--system-prompt <text> / --system-prompt-file <path>Override the system prompt
--append-system-prompt <text> / --append-system-prompt-file <path>Append to the default system prompt
--fallback-model <name>Auto-fall back when the primary model is overloaded (with --print)
--dangerously-skip-permissionsBypass all permission checks (sandboxed envs only)
--ideAuto-connect to IDE on startup if exactly one is available
--bareMinimal mode: skip hooks / LSP / plugin sync / auto-memory
--chrome / --no-chromeEnable / disable Chrome integration
-d, --debug [filter]Enable debug logs (with optional category filter)
--debug-file <path>Write debug logs to a file
--verboseOverride verbose mode from config
--setting-sources <sources>Restrict setting sources
--profile <name>Use a named config profile
--session <value>Select a session entry or alias
--file <path>Attach a file to the prompt/session
-w, --worktreeRun in worktree mode
--tmuxUse tmux/worktree helper flow
--versionPrint version

Full list: crabcode --help. Low-frequency flags can be passed verbatim after --:

bash
crabcode -- --max-turns 5 --allowedTools Bash
crabcode -- --max-turns 5 --allowedTools Bash

Slash command index

Type / in the TUI for autocomplete. Below is a grouped index of the available commands; each one has a live one-liner inside the TUI when you hover it.

Start / help

CommandPurpose
/helpShow help and available commands
/initInitialize CRABCODE.md from your codebase (with optional skills/hooks)
/clearReset current session, free up context
/doctorDiagnose and validate the CrabCode install / config
/versionPrint the version this session is running
/release-notesShow release notes
/statusShow CrabCode status: version, model, account, API, tools

Model & thinking

CommandPurpose
/modelSwitch or inspect the current model
/effortCycle thinking tier (off / standard / deep — see thinking-mode)
/fastToggle fast mode
/smallmodelPick the small/fast model used for internal sub-agent / summary work
/local-modelsCheck status, install or remove curated local models
/advisorConfigure the advisor model

Tools & permissions

CommandPurpose
/permissionsManage tool allow / deny rules
/sandboxToggle sandbox mode (see sandboxing)
/privacy-settingsView and update privacy settings
/hooksInspect hook configuration for tool events
/add-dirGrant the session another working directory

Git workflow

CommandPurpose
/diffView uncommitted changes and per-turn diffs
/filesList every file in the current context
/branchBranch off from the current session position
/commitCreate a git commit
/commit-push-prCommit, push, and open a PR
/pr-commentsFetch GitHub Pull Request comments

See git-workflow.

Code review

CommandPurpose
/reviewReview a Pull Request
/ultrareviewWeb CrabCode finds & verifies bugs on the current branch, ~10–20 min (see crabcode-on-the-web)
/security-reviewSecurity review of pending changes on the current branch

See code-review.

Session management

CommandPurpose
/sessionShow remote session URL + QR
/resumeResume a past session
/rewindRewind code or session to an earlier point
/renameRename the current session
/exportExport the current session to a file or clipboard
/tagToggle searchable tags on the current session
/compactCompact session history but keep a summary (optional summary hint)

See sessions.

Agents & tasks

CommandPurpose
/agentsManage agent configurations
/tasksManage background tasks
/planEnable plan mode or view the current plan
/briefToggle brief mode
/proactiveToggle proactive (autonomous) mode

See agents.

Integrations

CommandPurpose
/mcpManage MCP servers
/pluginManage CrabCode plugins
/skillsList available skills
/reload-pluginsActivate pending plugin changes in the current session
/install-github-appConfigure CrabCode GitHub Actions on a repo
/install-slack-appInstall the CrabCode Slack app
/ideManage IDE integrations and show status
/terminal-setupInstall newline-key support for your terminal (platform variants)
/web-setupSet up CrabCode on the web (requires connecting GitHub)

Remote tasks

CommandPurpose
/ultraplanWeb CrabCode drafts an editable high-level plan (~10–30 min)
/ultrareviewWeb CrabCode bug-finding session (see above)
/remote-controlAttach this terminal to a remote control session (alias /rc)
/remote-envConfigure the default runtime for remote sessions

See crabcode-on-the-web and remote-control.

Input modalities

CommandPurpose
/chromeBrowser automation and Chrome extension-mode settings (see chrome; extension setup in the browser extension install guide)
/voiceToggle voice mode
/desktopContinue the current session on the desktop app
/mobileShow a QR code to download the mobile app

See input-modalities.

Personalization

CommandPurpose
/themeSwitch theme
/colorSet the prompt-bar color for the current session
/vimToggle Vim editing mode
/keybindingsOpen or create the key-binding config file
/statuslineConfigure the status-bar UI

Debug & meta

CommandPurpose
/costShow total cost and duration of the current session
/usageShow plan usage limits
/extra-usageConfigure overflow usage when the quota runs out
/statsShow CrabCode usage statistics and activity
/insightsGenerate an analytical report on your sessions
/feedbackSend feedback
/loginSign in / switch Acosmi account
/logoutSign out of Acosmi
/upgradeUpgrade to the Max plan
/updateCheck for updates and reinstall the latest (alias of /install latest)
/installInstall a native CrabCode build

Misc

CommandPurpose
/btwAsk a side question without interrupting the main thread
/contextVisualize current context usage as a colored grid
/copyCopy CrabCode's last reply (/copy N copies the N-th most recent)
/passesShare a free week of CrabCode with friends
/memoryEdit CrabCode memory files (cross-session)
/init-verifiersCreate verifier skills that auto-validate code changes
/exit or Ctrl+DQuit

This index covers every publicly shipped slash command. Hidden / debug commands (e.g. /heapdump, /output-style) are intentionally omitted; use /help inside the TUI to discover them.

Exit codes

CodeMeaning
0Normal exit
1Generic error
2CLI argument parse error (unknown flag, etc.)
130User Ctrl+C