文档
推荐给好友,福利领不停!好友同步开通最高 1000 万词元额度 · 后续消费分佣最高 30%。
+50万 Token生成链接

CLI 参考

命令行参数、子命令、TUI 内 slash 命令完整速查表。

是什么

crabcode 是顶层命令,有两类入口:

  • 子命令:在 shell 里直接跑,如 crabcode doctorcrabcode cron list
  • Slash 命令:在 TUI 内输入,如 /help/init/model

何时会看到这个文档

  • 找不到某个参数 / slash 命令时
  • 想了解可用的子命令时

启动

不带子命令就是默认启动 TUI:

bash
crabcode                  # 启动交互式 TUI(默认)
crabcode "解释这段代码"      # 带 prompt 直接进入会话
crabcode -p "总结一下"      # 单次 print 模式:跑完输出后退出
crabcode                  # 启动交互式 TUI(默认)
crabcode "解释这段代码"      # 带 prompt 直接进入会话
crabcode -p "总结一下"      # 单次 print 模式:跑完输出后退出

子命令

bash
crabcode doctor           # 环境诊断(版本 / 平台 / git / gh / bootstrap 配置)
crabcode version          # 仅打印版本(同 --version)
crabcode browser ...      # 浏览器自动化 CLI 模式(详见 [chrome](/zh/docs/crabcode/chrome))
crabcode cron ...         # cron 任务管理(见下方矩阵)
crabcode auth ...         # 登录 / 状态 / 退出
crabcode mcp ...          # MCP server 管理
crabcode plugin ...       # 插件、marketplace、安装和启停
crabcode server           # 启动 App Server(供桌面端 / IDE / 本地集成连接)
crabcode serve            # 启动底层服务入口(原生 launcher 暴露)
crabcode open <cc-url>    # 打开 cc://connect?... 深链
crabcode ssh <host> [dir] # 通过 SSH 进入远端工作目录
crabcode agents           # 管理 agent 配置
crabcode auto-mode ...    # 自动模式 defaults / config / critique
crabcode update           # 检查并安装最新版本(也可用 upgrade)
crabcode install          # 安装 / 重新安装原生构建
crabcode --help           # 完整子命令与 flag 列表
crabcode doctor           # 环境诊断(版本 / 平台 / git / gh / bootstrap 配置)
crabcode version          # 仅打印版本(同 --version)
crabcode browser ...      # 浏览器自动化 CLI 模式(详见 [chrome](/zh/docs/crabcode/chrome))
crabcode cron ...         # cron 任务管理(见下方矩阵)
crabcode auth ...         # 登录 / 状态 / 退出
crabcode mcp ...          # MCP server 管理
crabcode plugin ...       # 插件、marketplace、安装和启停
crabcode server           # 启动 App Server(供桌面端 / IDE / 本地集成连接)
crabcode serve            # 启动底层服务入口(原生 launcher 暴露)
crabcode open <cc-url>    # 打开 cc://connect?... 深链
crabcode ssh <host> [dir] # 通过 SSH 进入远端工作目录
crabcode agents           # 管理 agent 配置
crabcode auto-mode ...    # 自动模式 defaults / config / critique
crabcode update           # 检查并安装最新版本(也可用 upgrade)
crabcode install          # 安装 / 重新安装原生构建
crabcode --help           # 完整子命令与 flag 列表

当前版本同时保留安装脚本和 CLI 内 update / upgrade / install 入口。若某个平台的原生 launcher 尚未支持某个子命令,以 crabcode --help 输出为准。

账号:crabcode auth

子命令用途
crabcode auth login启动登录流程
crabcode auth status查看当前账号状态
crabcode auth logout退出当前账号

TUI 内对应 /login/logout/status

MCP:crabcode mcp

子命令用途
crabcode mcp serve以 MCP server 形式启动 CrabCode
crabcode mcp list列出已配置 MCP server
crabcode mcp add <name> <command> [args...]添加 stdio MCP server
crabcode mcp add-json <name> '<json>'用 JSON 配置添加 MCP server
crabcode mcp add-from-crabcode-desktop从桌面端配置导入 MCP server
crabcode mcp get <name>查看某个 MCP server 配置
crabcode mcp remove <name>移除 MCP server
crabcode mcp reset-project-choices重置项目级 MCP 选择

详见 MCP

插件:crabcode plugin / crabcode plugins

子命令用途
crabcode plugin list列出插件
crabcode plugin validate <dir>校验本地插件 manifest 与结构
crabcode plugin install <source>安装插件
crabcode plugin uninstall <id>卸载插件
crabcode plugin enable <id> / disable <id>启用或禁用插件
crabcode plugin update <id>更新插件
crabcode plugin marketplace add <url>添加 marketplace
crabcode plugin marketplace list列出 marketplace
crabcode plugin marketplace remove <id>移除 marketplace
crabcode plugin marketplace update <id>更新 marketplace

详见 插件与技能

App Server、深链与远端

命令用途
crabcode server启动本地 App Server,并输出 cc://connect?... 连接地址
crabcode open <cc-url>打开 cc://connect?transport=tcp-ws... 深链并连接
crabcode ssh <host> [dir]通过 SSH 进入远端工作目录运行 CrabCode
crabcode remote-control / crabcode rc远程控制桥接入口
crabcode daemon ...后台 daemon 管理入口

桌面端主要通过 App Server 与本地 CrabCode 通信;远程控制详见 远程控制

后台会话

命令用途
crabcode --bg "..."以后台会话运行一条任务
crabcode ps查看后台会话
crabcode logs <id>查看后台会话日志
crabcode attach <id>接回后台会话
crabcode kill <id>终止后台会话

后台会话适合长任务、远程控制或需要稍后接回的任务;仍然受权限和沙盒约束。

其它管理入口

命令用途
crabcode wizard交互式初始化或诊断向导
crabcode setup-token设置或刷新本地 token
crabcode agents管理自定义 agent
crabcode auto-mode defaults查看自动模式默认值
crabcode auto-mode config查看或修改自动模式配置
crabcode auto-mode critique对自动模式行为做检查/反馈
crabcode new / list / reply模板或快速回复相关入口
crabcode environment-runner环境 runner 入口
crabcode self-hosted-runner自托管 runner 入口

crabcode cron 子命令矩阵

cron 任务由独立的 crabcode-cron daemon 处理;首次调用时按需自启动。可用 CRABCODE_DISABLE_CRON=1 关闭。

子命令用途
crabcode cron list [--json]列出所有 cron 任务
crabcode cron add --name <n> --schedule "<cron>" [--once] [--agent-id <id>] [--message <s>]用 5-field cron 表达式新建周期任务
crabcode cron add --name <n> --at &lt;ISO-8601&gt;一次性绝对时间触发(隐含 --once
crabcode cron add --name <n> --every-ms <ms>每 N 毫秒触发一次
crabcode cron edit <id> [--name ...] [--schedule ...] [--agent-id ...] [--message ...]编辑现有任务的部分字段
crabcode cron rm <id>删除任务
crabcode cron enable <id>启用任务
crabcode cron disable <id>禁用任务
crabcode cron status [--json]查看 daemon 状态(任务总数 / 启用数 / 版本)
crabcode cron run <id>立即触发一次
crabcode cron runs <id> [--limit N] [--json]查看任务运行历史

--schedule / --at / --every-ms 三选一互斥。--at 自动隐含 --once

常用 CLI 参数

参数说明
-p, --print单次模式:跑一次问题后输出退出
-c, --continue继续当前目录最近的一次会话
-r, --resume [<id>]选择历史会话(无 id 则交互选择)
--fork-session从恢复的会话上 fork 出新 session id
--model <name>指定模型(语义别名如 best / planmode,或完整模型 id)
--effort <level>思考强度:low / medium / high / max
--permission-mode <mode>启动权限模式:default / acceptEdits / plan / bypassPermissions / dontAsk
--add-dir <path...>给 CrabCode 额外的工作目录权限(可多个)
--mcp-config <file...>加载一个或多个 MCP server 配置
--plugin-dir <path>仅本次会话从指定目录加载插件(可重复)
--settings <file-or-json>加载额外设置(文件路径或 JSON 字符串)
--agents <json>用 JSON 字面定义自定义 agent
--agent <name>启动时切到指定 agent
--session-id <uuid>用指定的 session id(必须合法 UUID)
-n, --name <name>给会话起一个显示名
--output-format <fmt>--print 模式输出格式:text / json / stream-json
--input-format <fmt>--print 模式输入格式:text / stream-json
--json-schema <schema>--print JSON 输出时要求模型按 schema 结构输出
--include-hook-eventsstream-json 输出中包含 hook 事件
--include-partial-messagesstream-json 输出中包含 partial message
--max-turns <n>非交互模式下最多 agentic 轮数(仅 --print
--max-budget-usd <n>API 花费上限(仅 --print
--allowedTools <tools...>工具白名单(逗号或空格分隔,如 "Bash(git:*) Edit"
--disallowedTools <tools...>工具黑名单
--tools <tools...>显式指定可用工具集(用 "" 禁全部、default 用全部)
--system-prompt <text> / --system-prompt-file <path>覆盖系统提示词
--append-system-prompt <text> / --append-system-prompt-file <path>在默认系统提示词后追加内容
--fallback-model <name>默认模型超载时自动回退(仅 --print
--dangerously-skip-permissions跳过所有权限检查(仅推荐离线沙盒)
--ide启动时自动连接 IDE(如恰有一个可用 IDE)
--bare极简模式:跳过 hooks / LSP / plugin sync / 自动 memory 等
--chrome / --no-chrome启用 / 禁用 Chrome 集成
-d, --debug [filter]开启调试日志(可带分类过滤)
--debug-file <path>把调试日志写到指定文件
--verbose覆盖配置里的 verbose 模式
--setting-sources <sources>限制配置来源
--profile <name>使用指定配置 profile
--session <value>指定会话入口或会话别名
--file <path>把文件作为输入附加到会话
-w, --worktree在 worktree 模式下运行
--tmux使用 tmux/worktree 辅助流程
--version打印版本

完整列表:crabcode --help。低频参数可以放到 -- 之后整段透传:

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

Slash 命令完整索引

TUI 里输入 / 会出补全。下面按高频度分组列出可用命令;每条点进 TUI 内 /<命令> 都能看到当下的实时说明。

起步 / 帮助

命令用途
/help查看帮助和可用命令
/init用代码库文档初始化 CRABCODE.md(可附带 skills/hooks)
/clear清空对话历史,释放上下文
/doctor诊断并验证 CrabCode 安装与配置
/version打印当前会话运行的版本
/release-notes查看版本说明
/status查看 CrabCode 状态:版本、模型、账号、API 连接、工具状态

模型与思考

命令用途
/model切换或查看当前模型
/effort切换思考档位(关闭 / 标准 / 深度,见 thinking-mode
/fast切换快速模式
/smallmodel设置内部任务(子 agent / 概要)用的小型模型
/local-models查看 / 安装 / 移除本地模型
/advisor配置顾问模型

工具与权限

命令用途
/permissions管理工具权限的允许 / 拒绝规则
/sandbox切换沙盒模式(见 sandboxing
/privacy-settings查看与更新隐私设置
/hooks查看工具事件的 hook 配置
/add-dir给当前会话添加新的工作目录

Git 工作流

命令用途
/diff查看未提交变更与每轮 diff
/files列出当前上下文中的所有文件
/branch在当前位置基于会话创建一个分支
/commit创建一次 git commit
/commit-push-prcommit、push 并发起 PR
/pr-comments获取 GitHub Pull Request 评论

详见 git-workflow

代码审查

命令用途
/review审查一个 Pull Request
/ultrareview网页版 CrabCode 远程查 Bug,约 10–20 分钟(见 crabcode-on-the-web
/security-review对当前分支的待提交变更执行安全审查

详见 code-review

会话管理

命令用途
/session显示远程会话 URL 与二维码
/resume恢复历史会话
/rewind把代码或会话回滚到此前某一点
/rename重命名当前会话
/export导出当前会话到文件或剪贴板
/tag为当前会话切换可搜索标签
/compact压缩当前会话历史但保留摘要(可附摘要指令)

详见 sessions

智能体与任务

命令用途
/agents管理 Agent 配置
/tasks管理后台任务
/plan启用计划模式或查看当前会话的计划
/brief切换简洁模式
/proactive切换主动(proactive)模式

详见 agents

集成

命令用途
/mcp管理 MCP 服务器
/plugin管理 CrabCode 插件
/skills列出可用的技能
/reload-plugins在当前会话激活待生效的插件变更
/install-github-app为代码仓库配置 CrabCode GitHub Actions
/install-slack-app安装 CrabCode Slack 应用
/ide管理 IDE 集成并显示状态
/terminal-setup安装终端的换行键支持(按平台变体)
/web-setup配置网页版 CrabCode(需要连接 GitHub)

远程任务

命令用途
/ultraplan网页版 CrabCode 起草高级计划,可编辑并审批(约 10–30 分钟)
/ultrareview网页版远程 Bug 查找(同上)
/remote-control把本终端连接到远程控制会话(别名 /rc
/remote-env配置远程会话默认运行环境

详见 crabcode-on-the-webremote-control

输入形态

命令用途
/chrome浏览器自动化与 Chrome 扩展模式设置(见 chrome,扩展安装见 浏览器扩展安装向导
/voice切换语音模式
/desktop在桌面端继续当前会话
/mobile显示二维码以下载移动端

详见 input-modalities

个性化

命令用途
/theme切换主题
/color设置当前会话提示栏颜色
/vimVim 与普通编辑模式之间切换
/keybindings打开或创建快捷键配置文件
/statusline配置状态栏 UI

调试 / 元信息

命令用途
/cost查看当前会话的总费用与时长
/usage查看套餐用量上限
/extra-usage配置额度耗尽后的额外用量
/stats查看 CrabCode 使用统计与活动数据
/insights生成会话分析报告
/feedback提交反馈
/login登录 / 切换 Acosmi 账号
/logout退出 Acosmi 账号
/upgrade升级到 Max 套餐
/update检查更新并重装到最新版(/install latest 别名)
/install安装 CrabCode 原生构建

其它

命令用途
/btw不打断主对话,快速问一个旁问
/context以彩色网格可视化当前上下文使用情况
/copy复制 CrabCode 上一次回复到剪贴板(/copy N 复制倒数第 N 条)
/passes与好友分享一周免费 CrabCode
/memory编辑 CrabCode 记忆文件(跨会话)
/init-verifiers为代码变更创建自动验证用的 verifier 技能
/exit 或 Ctrl+D退出

该索引覆盖了当前发布的所有公开 slash 命令。隐藏 / 调试用命令(如 /heapdump / /output-style 等)不在此处列出,可用 /help 在 TUI 内查询。

退出码

退出码含义
0正常退出
1通用错误
2命令行参数解析错误(未识别的 flag 等)
130用户 Ctrl+C 终止

相关