English
Integration docs

BitCloud API Documentation

Browse Base URL, API key, model, and client setup guides for connecting tools to the unified gateway.

Current documentCodeBuddy
Markdown rendered as page contentCodeBuddy

CodeBuddy 配置

BitCloud API 兼容 OpenAI 协议,支持 CodeBuddy IDE、IDE 插件和 CLI,可参考本文进行配置与使用。


前置工作

获取凭证

项目
BASE_URL(OpenAI 兼容协议)https://web.bitcloud.com.cn/v1
API Key格式:sk-xxxxx
获取方式前往 控制台 → 令牌管理 页面创建

使用 CodeBuddy IDE

安装 CodeBuddy

CodeBuddy 官网 下载并安装。支持 Windows 和 macOS。

配置模型

Step 1:设置自定义模型

创建或编辑 models.json 配置文件来添加自定义模型:

  • macOS: ~/.codebuddy/models.json
  • Windows: UserDirectory\.codebuddy\models.json

按需替换 BASE_URLAPI_KEY

json{
  "models": [
    {
      "id": "gpt-4o",
      "name": "GPT-4o",
      "vendor": "BitCloud",
      "apiKey": "API_KEY",
      "url": "BASE_URL/chat/completions",
      "supportsToolCall": true,
      "supportsImages": true
    },
    {
      "id": "claude-sonnet-4-20250514",
      "name": "Claude Sonnet 4",
      "vendor": "BitCloud",
      "apiKey": "API_KEY",
      "url": "BASE_URL/chat/completions",
      "supportsToolCall": true,
      "supportsImages": true
    }
  ]
}

Step 2:查看和切换模型

配置完成后,关闭 Auto mode,打开模型列表即可看到已配置的模型。

使用模型

选择已配置的模型,即可开始对话、编码等操作。


使用 CodeBuddy IDE 插件

安装插件

在 VS Code 扩展市场搜索 Tencent Cloud CodeBuddy 并安装。

配置模型

按照上方 CodeBuddy IDE 部分所述的 models.json 配置步骤进行配置。如已有配置,插件会自动读取。


使用 CodeBuddy CLI

安装 CodeBuddy CLI

通过 npm 安装(需要 Node.js 18.20 或更新版本):

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

验证安装(如有版本号输出,则表示安装成功):

bashcodebuddy --version

配置模型

配置方法与 IDE 部分的 models.json 方式相同。之前的配置会被自动读取。

使用 CodeBuddy CLI

配置完成后,进入项目目录并运行:

bashcodebuddy

启动后:

  • 使用 /model 查看或切换模型
  • 使用 /status 查看当前激活的模型

常见问题

配置的模型在下拉列表中看不到?

  • 检查 JSON 语法是否正确
  • 如果配置了 availableModels 字段,确认模型 id 已包含在其中