Skip to content

接入 CodeBuddy

功能概述

CodeBuddy Code(@tencent-ai/codebuddy-code)是腾讯云推出的终端 AI 编程助手,支持通过 models.json 配置文件接入任意 OpenAI 兼容接口。无量AI开放平台提供完全兼容 OpenAI 协议的接口,可作为 CodeBuddy 的自定义模型后端。

前提条件

  • 已安装 Node.js(建议 v18 及以上)
  • 已在无量AI开放平台创建 API Key(前往创建

配置步骤

1. 安装 CodeBuddy Code

bash
npm install -g @tencent-ai/codebuddy-code
codebuddy --version   # 验证安装成功

2. 获取 API Key

登录无量AI开放平台控制台,进入 应用管理 → API Key 管理,复制您的 API Key。

3. 编辑 models.json

根据您的操作系统,找到并编辑以下配置文件(如文件不存在则新建,包括父目录):

操作系统文件路径
macOS / Linux~/.codebuddy/models.json
WindowsC:\Users\<用户名>\.codebuddy\models.json

写入以下内容,将 your-api-key 替换为您的 API Key,并将模型 ID 替换为平台提供的模型代码:

json
{
  "models": [
    {
      "id": "gpt-5.5",
      "name": "GPT-5.5",
      "vendor": "无量AI开放平台",
      "apiKey": "your-api-key",
      "url": "https://open.dieyuyun.com/v1"
    }
  ],
  "availableModels": ["gpt-5.5"]
}
字段说明
id模型代码,需与 availableModels 中的值一致
name显示名称,自定义即可
vendor服务商名称,自定义即可
apiKey您的无量AI开放平台 API Key
urlOpenAI 兼容接口基础地址
availableModels启用的模型列表,需包含 models[].id 中的值

4. 启动并切换模型

bash
codebuddy

完成浏览器授权后,在会话中输入 /model 切换到您配置的自定义模型。

CodeBuddy 启动成功

通过上述 models.json 配置文件设置好模型后,CodeBuddy 桌面端会自动同步显示已配置的模型,直接选择即可使用:

CodeBuddy 桌面端

平台接口说明

无量AI开放平台的 OpenAI 协议接入信息如下:

配置项
Base URLhttps://open.dieyuyun.com/v1
认证请求头Authorization: Bearer your-api-key
数据格式JSON

完整请求示例:

bash
curl --request POST 'https://open.dieyuyun.com/v1/chat/completions' \
  --header 'Authorization: Bearer your-api-key' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "gpt-5.5",
    "messages": [
      {"role": "system", "content": "你是一个有用的助手"},
      {"role": "user", "content": "你好,请介绍一下你自己"}
    ],
    "temperature": 0.7,
    "max_tokens": 1024
  }'

注意事项

  • JSON 格式models.json 必须是合法的 JSON 格式,否则 CodeBuddy 将无法加载配置。
  • 多模型支持:可在 models 数组中添加多个对象,并在 availableModels 数组中列出所有可用模型 ID。
  • API Key 安全:不要将包含 API Key 的 models.json 文件提交到版本控制系统。

相关文档