CodeBuddy

通过 OpenAI Chat Completions 兼容的 models.json 配置，将 CodeBuddy Code 接入 CoffeeRouter。

接入前准备

  • 安装 Node.js 18.20 或更高版本。
  • 在 CoffeeRouter「令牌管理」中创建可用令牌。
  • 确认令牌拥有目标聊天模型的权限，并记下准确的模型 ID。
  • 准备 CoffeeRouter Chat Completions 端点：https://www.coffeerouter.ai/v1/chat/completions。

配置步骤

1. 安装 CodeBuddy Code

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

2. 创建模型配置文件

用户级配置文件为 ~/.codebuddy/models.json；Windows 对应 %USERPROFILE%\.codebuddy\models.json。也可以在项目根目录创建 .codebuddy/models.json，项目级配置优先。

{
    "models": [
        {
            "id": "your-model-id",
            "name": "CoffeeRouter Model",
            "vendor": "CoffeeRouter",
            "url": "https://www.coffeerouter.ai/v1/chat/completions",
            "apiKey": "${COFFEEROUTER_API_KEY}",
            "supportsToolCall": true
        }
    ],
    "availableModels": ["your-model-id"]
}

将 your-model-id 替换为 CoffeeRouter 中显示的模型 ID。只有模型本身确实支持工具调用时，才将 supportsToolCall 设为 true。

3. 设置 API Key

Linux / macOS：

export COFFEEROUTER_API_KEY="sk-your-api-key"

Windows PowerShell：

$env:COFFEEROUTER_API_KEY="sk-your-api-key"

环境变量会在 CodeBuddy 启动时解析。需要长期使用时，请使用系统密钥管理工具或安全的 shell 配置，避免把真实密钥提交到 Git。

4. 选择模型

启动 CodeBuddy，并指定刚添加的模型：

codebuddy --model your-model-id

也可以在交互界面的模型选择器中选择 CoffeeRouter 模型。配置文件支持热重载；保存后若列表没有更新，可重新打开模型选择器。

验证接入

在项目目录启动 CodeBuddy，发送一个需要读取代码或调用工具的测试任务。模型能够正常回答并识别当前项目，即表示接入成功。

常见问题

模型没有出现在列表中

检查 availableModels 是否包含完全一致的模型 ID，并确认 JSON 格式和配置文件路径正确。

返回 401 或 API Key 无效

重新复制完整令牌，确认环境变量已在启动 CodeBuddy 的同一个 shell 中设置，并检查令牌状态、额度和访问限制。

返回 URL 必须以 chat/completions 结尾

url 必须填写完整地址 https://www.coffeerouter.ai/v1/chat/completions，不能只写到 /v1。

可以直接在图形界面中添加吗

可以。当前 CodeBuddy IDE / WorkBuddy 支持在设置的模型页面添加自定义 API；models.json 更适合 CLI、批量配置或项目级配置。

安全提示

  • API Key 等同于调用凭证，请勿分享配置文件、终端记录或包含密钥的截图。
  • 建议为 CodeBuddy 创建独立令牌，便于单独限制模型、额度和撤销访问。
  • 不要将含真实密钥的 models.json 提交到版本控制；建议限制文件仅当前用户可读写。
  • CodeBuddy 会把任务内容和必要的代码上下文发送到所配置的 CoffeeRouter 服务。

官方资料