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 服務。

官方資料