CodeBuddy

• 官方主页：codebuddy.ai
• 安装文档：codebuddy.ai/docs/zh/cli/installation
• 配置参考：models.json 配置指南 / 环境变量参考
• 协议类型：OpenAI 兼容

安装

CodeBuddy Code 是腾讯云推出的命令行编码助手，支持 macOS、Linux 与 Windows。其余写法以官方安装文档为准。

包管理器安装（需 Node.js 18.20+）

npm install -g @tencent-ai/codebuddy-code

也可用 pnpm / yarn / bun：

pnpm add -g @tencent-ai/codebuddy-code

Homebrew（macOS / Linux）

brew install Tencent-CodeBuddy/tap/codebuddy-code

原生二进制安装脚本（Beta，无需 Node.js）

macOS / Linux：

curl -fsSL https://www.codebuddy.cn/cli/install.sh | bash

Windows（PowerShell）：

irm https://www.codebuddy.cn/cli/install.ps1 | iex

安装完成后用 codebuddy --version 确认。配置文件默认存放在 ~/.codebuddy/ 目录。

对接 TokenBay

对接机制

CodeBuddy Code 默认连接腾讯云官方服务。要改走 TokenBay，官方提供两条路径：

• models.json 自定义模型（推荐）：在 ~/.codebuddy/models.json 注册自定义模型，每个模型单独指定 url、apiKey 与能力开关。灵活度最高，可同时挂多个模型。
• 环境变量覆盖：用 CODEBUDDY_BASE_URL 与 CODEBUDDY_API_KEY 全局覆盖默认端点，适合只接一个上游的简单场景。

仅支持 OpenAI 接口格式：CodeBuddy 的自定义模型目前仅支持 OpenAI 协议，因此接 TokenBay 必须使用 OpenAI 兼容端点（带 /v1），而不是 Anthropic 裸地址。

models.json 的 url 必须是完整路径：该字段要写接口的完整路径，一般以 /chat/completions 结尾，例如 https://api.tokenbay.com/v1/chat/completions。这与环境变量 CODEBUDDY_BASE_URL 不同——后者填端点根地址即可。

1. 获取 API Key

登录 TokenBay 控制台 → API 密钥 → 创建密钥。复制以 sk- 开头的完整字符串。明文仅显示一次，离开页面后无法再查看。

2. 配置环境变量

为避免把密钥明文写进配置文件，先把 API Key 放进环境变量，下面统一用 TOKENBAY_API_KEY：

macOS / Linux（zsh 或 bash）

把下面这行追加到 ~/.zshrc 或 ~/.bashrc，然后执行 source ~/.zshrc 让其生效：

export TOKENBAY_API_KEY="sk-XXXXXXX"

Windows（PowerShell，写入用户级环境）

[Environment]::SetEnvironmentVariable('TOKENBAY_API_KEY','sk-XXXXXXX','User')

Windows（CMD）

setx TOKENBAY_API_KEY "sk-XXXXXXX"

PowerShell 与 CMD 的写法都是永久化用户环境变量，需要新开一个终端窗口才会读到。

3. 配置 models.json（推荐）

编辑用户级配置 ~/.codebuddy/models.json（不存在则新建），注册自定义模型。apiKey 与 url 支持 ${变量名} 形式引用上一步的环境变量：

{
  "models": [
    {
      "id": "gpt-5.3-codex",
      "name": "GPT-5.3 Codex (TokenBay)",
      "vendor": "TokenBay",
      "apiKey": "${TOKENBAY_API_KEY}",
      "url": "https://api.tokenbay.com/v1/chat/completions",
      "maxInputTokens": 200000,
      "maxOutputTokens": 8192,
      "supportsToolCall": true
    }
  ],
  "availableModels": ["gpt-5.3-codex"]
}

字段说明：

models.json 支持热重载，保存后约 1 秒自动生效，无需重启。建议把文件权限设为 600，且不要把含明文密钥的配置提交到版本控制。

4. 备选：环境变量全局覆盖

只接一个上游时，也可以直接用环境变量覆盖默认端点，无需写 models.json：

export CODEBUDDY_BASE_URL="https://api.tokenbay.com/v1"
export CODEBUDDY_API_KEY="sk-XXXXXXX"
export CODEBUDDY_MODEL="gpt-5.3-codex"

这些变量也可以写进 ~/.codebuddy/settings.json 的 env 字段，自动应用到每个会话。

5. 推荐模型

模型名格式：模型名称中版本号仅接受小数点形式（如 gpt-5.4），不要写成连字符形式（gpt-5-4）。

CodeBuddy 自定义模型仅支持 OpenAI 接口格式，请选择 TokenBay 中 OpenAI 协议分组下的模型。上表为示例，准确的 Model ID 与端点以 模型清单 为准；接入前请核对并确认所属分组已授权该模型。

6. 验证接入

启动 codebuddy，在模型选择器中选中你配置的模型（models.json 注册的模型会带 custom 标签），发送一条消息确认能正常返回。若鉴权失败或报模型错误，先检查：

• url 是否写成了以 /chat/completions 结尾的完整路径；
• ${TOKENBAY_API_KEY} 引用的环境变量是否已设置并重开终端；
• 模型 id 是否与 TokenBay 上游 Model ID 完全一致。