ChatCode-cli使用手册

ChatCode-cli 是 ChatCode官方推出的命令行工具，让你可以在终端中直接与 ChatCode 进行交互，完成代码编写、调试、重构等任务。

安装教程

1. 一键安装

如果本机缺少 Node.js，安装脚本会从国内 Node.js 镜像安装 Node.js，然后在安装 ChatCode CLI 与 OpenSpec 时为对应 npm 命令临时指定国内 registry。

如果本机已有 Node.js >= 20，脚本会直接复用，不会更新。检测到低于 20 的 Node.js 时，脚本会先询问是否升级；拒绝升级将退出安装。

安装 ChatCode CLI 前，脚本会通过 --registry=https://registry.npmmirror.com 检查 @chatcode/chatcode-cli 是否为最新版本。如果已安装版本不是最新版本，会提示当前版本和最新版本，并询问是否更新；拒绝更新时会继续保留当前已安装版本。

Windows 会检查 Git for Windows 和 Git Bash。建议使用 Git >= 2.21.0；检测到更低版本时会显示 warning，但不会阻断安装。

如果本机已安装 nvm，脚本会优先通过 nvm 安装和切换 Node.js。脚本不会持久写入 npm prefix，也不会设置与 nvm 冲突的 NPM_CONFIG_PREFIX。

安装完成后，脚本会同步安装 @fission-ai/openspec@latest，在 ~/.chatcode-cli/openspec-workspace 中执行 OpenSpec 初始化，并把当前 OpenSpec 版本生成的 /opsx:* 命令和 skills 同步到 ~/.chatcode-cli，安装后可直接使用 chatcode-cli 和 openspec。

macOS/Linux：

curl -fsSL "http://gitlab.tianti.tg.unicom.local/kubernetesAMP/visualDesignPlatform/chatcode-cli/-/raw/dev_v1alpha/scripts/install/install.sh" | sh

Windows PowerShell：

irm "http://gitlab.tianti.tg.unicom.local/kubernetesAMP/visualDesignPlatform/chatcode-cli/-/raw/dev_v1alpha/scripts/install/install-windows.ps1" | iex

安装前可以审阅 scripts/install/install.sh、scripts/install/install-macos.sh、scripts/install/install-linux.sh 和 scripts/install/install-windows.ps1。

验证安装成功：

node --version
chatcode-cli --version
openspec --version

Windows 安装后如果新打开标签页仍提示 node 或 chatcode-cli 不存在，请关闭所有 Windows Terminal 窗口后重新打开 PowerShell。

2. 已有 Node.js 时手动安装

方式1：外部安装

npm install -g @chatcode/chatcode-cli@latest

方式2：内部仓库安装

npm install -g @chatcode/chatcode-cli@latest --registry http://ccp.tianti.tg.unicom.local/artifactory/api/npm/ckp-npm-virtual/

3. 配置ChatCode CLI设置

创建或编辑 ~/.chatcode-cli/settings.json，添加以下配置，注意需要配置您自己的 OPENAI 地址 URL、密钥 APIKEY 和使用的模型名。

{
  "env": {
    "OPENAI_API_KEY": "[您的OPENAI密钥APIKEY]",
    "OPENAI_BASE_URL": "[您的OPENAI地址URL]",
    "CHATCODE_CLI_MAX_OUTPUT_TOKENS": "[按照您模型的最大token数]",
    "CHATCODE_CLI_DISABLE_NONESSENTIAL_TRAFFIC": "1",
    "OPENAI_MODEL": "[您的模型名]"
  },
  "permissions": {
    "allow": [],
    "deny": []
  },
  "model": "[您的模型名]"
}

DeepSeek V4 users can configure external OpenAI-compatible models with "model": "deepseek-v4-pro" or "model": "deepseek-v4-flash". These model names now use the same generic OpenAI-compatible path as other external models; the DeepSeek V4-specific adapter code is retained in the source tree but disabled at the entry point. The built-in ChatCode default remains DeepSeek-V3.

4. 启动ChatCode CLI

chatcode-cli

5. 首次启动配置

首次启动需要配置信任当前文件夹，直接回车即可。

卸载和重新安装

如果遇到问题需要重新安装 ChatCode CLI:

# 卸载
npm uninstall -g @chatcode/chatcode-cli

# 重新安装
# 方式1：外部安装
npm install -g @chatcode/chatcode-cli@latest 
# 方式2：内部仓库安装
npm install -g @chatcode/chatcode-cli@latest --registry http://ccp.tianti.tg.unicom.local/artifactory/api/npm/ckp-npm-virtual/

常用内置命令

ChatCode CLI 中可用的内置命令的参考。

在 ChatCode CLI 中输入 / 可以查看所有可用命令，或输入 / 后跟任何字母来筛选。ChatCode CLI 还包括捆绑的 skills，如 /simplify、/batch、/debug 和 /loop，当您输入 / 时会与内置命令一起显示。

部分常用命令如下表，在下表中，<arg> 表示必需的参数，[arg] 表示可选参数。

| 命令 | 用途 | | :----------------------------------- | :----------------------------------------------------------- | | /add-dir <path> | 向当前会话添加新的工作目录 | | /agents | 管理 agent 配置 | | /btw <question> | 提出快速[附加问题]，无需添加到对话中 | | /clear | 清除对话历史记录并释放上下文。别名：/reset、/new | | /color [color|default] | 为当前会话设置提示栏颜色。可用颜色：red、blue、green、yellow、purple、orange、pink、cyan。使用 default 重置 | | /compact [instructions] | 压缩对话，可选择性地提供焦点说明 | | /config | 打开[设置]界面以调整主题、模型、[输出样式]和其他偏好设置。别名：/settings | | /context | 将当前上下文使用情况可视化为彩色网格。显示上下文密集型工具、内存膨胀和容量警告的优化建议 | | /copy [N] | 将最后一个助手响应复制到剪贴板。传递数字 N 以复制第 N 个最新响应：/copy 2 复制倒数第二个。当存在代码块时，显示交互式选择器以选择单个块或完整响应。在选择器中按 w 将选择内容写入文件而不是剪贴板，这在 SSH 上很有用 | | /cost | 显示令牌使用统计信息。 | | /diff | 打开交互式差异查看器，显示未提交的更改和每轮差异。使用左/右箭头在当前 git 差异和单个轮次之间切换，使用上/下浏览文件 | | /doctor | 诊断并验证您的安装和设置 | | /effort [low|medium|high|max|auto] | 设置模型工作量级别。low、medium 和 high 在会话间保持。max 仅适用于当前会话，需要 Opus 4.6。auto 重置为模型默认值。不带参数时，显示当前级别。立即生效，无需等待当前响应完成 | | /exit | 退出 CLI。别名：/quit | | /export [filename] | 将当前对话导出为纯文本。使用文件名时，直接写入该文件。不使用文件名时，打开对话框以复制到剪贴板或保存到文件 | | /fast [on|off] | 切换快速模式开启或关闭 | | /branch [name] | 在此点创建当前对话的分支。别名：/fork | | /help | 显示帮助和可用命令 | | /hooks | 查看工具事件的 hook 配置 | | /init | 使用 AGENTS.md 指南初始化项目。 | | /insights | 生成报告，分析您的 ChatCode 会话，包括项目领域、交互模式和摩擦点 | | /keybindings | 打开或创建您的快捷键配置文件 | | /login | 登录到您的 账户（暂未支持） | | /logout | 从您的 账户登出（暂未支持） | | /model [model] | 选择或更改 AI 模型。对于支持的模型，使用左/右箭头[调整工作量级别]。更改立即生效，无需等待当前响应完成 | | /plan [description] | 直接从提示进入计划模式。传递可选描述以进入计划模式并立即开始该任务，例如 /plan fix the auth bug | | /plugin | 管理 ChatCode Plugins | | /rename [name] | 重命名当前会话并在提示栏上显示名称。不使用名称时，从对话历史记录自动生成一个 | | /resume [session] | 按 ID 或名称恢复对话，或打开会话选择器。别名：/continue | | /rewind | 将对话和/或代码倒回到上一个点，或从选定的消息进行总结。别名：/checkpoint | | /security-review | 分析当前分支上的待处理更改以查找安全漏洞。审查 git 差异并识别注入、身份验证问题和数据泄露等风险 | | /skills | 列出可用的 skills | | /stats | 可视化每日使用情况、会话历史记录、连续记录和模型偏好 | | /status | 打开设置界面（状态选项卡），显示版本、模型、账户和连接性。在 ChatCode响应时工作，无需等待当前响应完成 | | /tasks | 列出并管理后台任务 | | /theme | 更改颜色主题。包括浅色和深色变体、色盲友好（道尔顿化）主题和使用您终端颜色调色板的 ANSI 主题 | | /vim | 在 Vim 和普通编辑模式之间切换 |