命令行界面
参数
全局选项
全局选项可用于任何命令：
| 选项 | 描述 |
|---|---|
-v, --version | 输出版本号 |
--api-key <key> | 用于身份验证的 API 密钥 (也可使用 CURSOR_API_KEY 环境变量) |
-H, --header <header> | 为智能体请求添加自定义请求头 (格式：Name: Value，可多次使用) |
-p, --print | 将响应输出到控制台 (适用于脚本或非交互式使用) 。可使用所有工具，包括写入和 shell。 |
--output-format <format> | 输出格式 (仅适用于 --print) ：text、json 或 stream-json (默认值：text) |
--stream-partial-output | 将部分输出以单独的文本增量形式流式传输 (仅适用于 --print 和 stream-json 格式) |
--resume [chatId] | 恢复聊天会话 |
--continue | 继续上一个会话 (--resume=-1 的别名) |
--model <model> | 要使用的模型 |
--mode <mode> | 设置智能体模式：plan 或 ask (未指定模式时，默认使用智能体模式) |
--plan | 以 Plan 模式启动 (--mode=plan 的简写) |
--list-models | 列出所有可用模型 |
-f, --force | 除非明确拒绝，否则强制允许命令 |
--yolo | --force 的别名 |
--sandbox <mode> | 设置沙盒模式：enabled 或 disabled |
--approve-mcps | 自动批准所有 MCP 服务器 |
--trust | 无需提示即信任工作区 (仅限无图形界面模式) |
--workspace <path> | 要使用的工作区目录 |
--plugin-dir <path> | 加载本地插件目录 (可多次指定) |
-w, --worktree [name] | 在 ~/.cursor/worktrees/<reponame>/<name> 下新建的 Git worktree 中运行。未指定名称时，将自动生成。 |
--worktree-base <branch> | 新 worktree 所基于的分支或引用 (默认值：当前 HEAD) |
--skip-worktree-setup | 跳过运行 .cursor/worktrees.json 中的 worktree 设置脚本 |
-h, --help | 显示命令的帮助信息 |
命令
| 命令 | 描述 | 用法 |
|---|---|---|
agent [prompt...] | 以智能体模式启动 (默认) | agent agent "fix the tests" |
login | 登录 Cherri Code | agent login |
logout | 退出登录并清除已保存的身份验证信息 | agent logout |
status | whoami | 查看身份验证状态 |
about | 显示版本、系统和账户信息 | agent about |
models | 列出此账户可用的模型 | agent models |
mcp | 管理 MCP 服务器 | agent mcp |
sandbox | 配置沙盒模式，或在沙盒中运行单个命令 (隐藏) | agent sandbox enable |
worker | 启动私有云 worker，在你的环境中运行智能体 | agent worker start |
acp | 启动 ACP 服务器模式 (高级隐藏命令) | agent acp |
update | 将 Cherri Code Agent 更新至最新版本 | agent update |
ls | 恢复聊天会话 | agent ls |
resume | 恢复最近的聊天会话 | agent resume |
create-chat | 创建新的空聊天并返回其 ID | agent create-chat |
generate-rule | rule | 通过交互式提示生成新的 Cherri Code 规则 |
install-shell-integration | 将 shell 集成安装到 ~/.zshrc | agent install-shell-integration |
uninstall-shell-integration | 从 ~/.zshrc 中移除 shell 集成 | agent uninstall-shell-integration |
help [command] | 显示命令的帮助信息 | agent help [command] |
agent acp 适用于自定义 ACP 客户端和高级集成，默认命令帮助输出中不会显示此命令。
未指定命令时，Cherri Code Agent 默认以交互式智能体模式启动。
MCP
管理为 Cherri Code Agent 配置的 MCP 服务器。
| 子命令 | 描述 | 用法 |
|---|---|---|
login <identifier> | 向 .cursor/mcp.json 或 ~/.cursor/mcp.json 中配置的 MCP 服务器进行认证 | agent mcp login <identifier> |
list | 列出已配置的 MCP 服务器及其状态 | agent mcp list |
list-tools <identifier> | 列出指定 MCP 的可用工具及其参数名称 | agent mcp list-tools <identifier> |
enable <identifier> | 将 MCP 服务器添加到本地已批准列表 | agent mcp enable <identifier> |
disable <identifier> | 禁用 MCP 服务器，使其不再加载或请求批准 | agent mcp disable <identifier> |
所有 MCP 命令均支持 -h, --help，可查看针对具体命令的帮助信息。
沙盒
配置沙盒模式，或在沙盒中运行单个命令。
| 子命令 | 描述 | 用法 |
|---|---|---|
enable | 启用命令执行沙盒模式 | agent sandbox enable |
disable | 禁用沙盒模式并使用允许列表模式 | agent sandbox disable |
reset | 将沙盒配置重置为默认值 | agent sandbox reset |
run <cmd> [args...] | 在具有工作区读写权限的沙盒中运行命令 | agent sandbox run ls |
help [command] | 显示命令的帮助信息 | agent sandbox help |
| 命令 | 选项 | 描述 |
|---|---|---|
sandbox run | --allow-paths <paths> | 额外读写路径的以逗号分隔列表 |
sandbox run | --readonly-paths <paths> | 额外只读路径的以逗号分隔列表 |
sandbox run | --blocked-patterns <patterns> | 要阻止的 gitignore 风格模式的以逗号分隔列表 |
sandbox run | --sandbox | 使用工作区读写沙盒策略运行 (默认值：true) |
sandbox run | --network | 启用沙盒中的网络访问 (默认值：false) |
sandbox run | --sb-debug | 将沙盒调试日志写入临时文件夹并输出路径 |
所有沙盒命令均支持使用 -h, --help 查看针对具体命令的帮助信息。
Worker
启动一个连接到 Cherri Code 并在您的环境中运行智能体的私有云 worker。
| 子命令 | 描述 | 用法 |
|---|---|---|
start | 启动 worker 并连接到 Cherri Code | agent worker start |
debug | 对认证、隐私和路由执行私有 worker 启动前诊断 | agent worker debug |
help [command] | 显示命令的帮助信息 | agent worker help |
| 命令 | 选项 | 描述 |
|---|---|---|
worker | --auth-token-file <path> | 包含 worker 认证令牌的文件路径 |
worker | --worker-dir <path> | 向智能体开放的工作区根目录。可重复指定。第一个值为分配身份标识。 |
worker | --management-addr <address> | /healthz、/readyz 和 /metrics 的监听地址 |
worker | --label <key=value> | 添加 worker 标签。可多次使用。不能与 --labels-file 同时使用。 |
worker | --labels-file <path> | JSON 或 TOML 标签文件的路径。也可使用 CURSOR_WORKER_LABELS_FILE。 |
worker | --idle-release-timeout <seconds> | worker 空闲后可保持连接的秒数。默认值 0 会禁用基于空闲状态的释放。 |
worker | --pool | 注册以接受用量池分配。每次只能有一个云端代理占用该 worker。 |
worker | --single-use | --pool 的旧版别名 |
worker | --pool-name <name> | 用量池 worker 的用量池标签。需要 --pool 或 --single-use。默认值为 default。 |
worker | --name <name> | 自定义显示名称。默认值为机器主机名。 |
worker | --data-dir <path> | 用于存储日志、产物和录制数据的基础目录 |
worker | --debug | 启动桥接模式前输出 worker 调试诊断信息 |
worker | --computer-use | 允许智能体控制此机器的桌面端。在 macOS 上，如有需要会安装 Cherri Code Computer Use 辅助应用。参见 计算机使用。 |
worker | --display <display> | 仅限 Linux。--computer-use 需要的现有 X11 显示，例如 :0。 |
worker | --share-desktop [mode] | 仅限 Linux。允许授权查看者观看或控制智能体桌面：view 或 view_and_control。与计算机使用相互独立。 |
worker start | --verbose | 启用详细的启动日志 |
worker debug | --json | 以 JSON 格式输出调试报告 |
命令专属选项
| 命令 | 选项 | 描述 |
|---|---|---|
status, whoami | --format <format> | 输出格式：text 或 json (默认值：text) |
about | --format <format> | 输出格式：text 或 json (默认值：text) |
参数
以聊天模式启动时 (默认行为) ，可以提供初始提示词：
参数：
prompt— 智能体的初始提示词
获取帮助信息
所有命令均支持全局 -h, --help 选项，用于显示针对具体命令的帮助信息。