Structure Docs

Appearance

CodeBuddy Code 使用教程 ​

目录 ​

简介 ​

CodeBuddy 是腾讯推出的 AI 编程助手，与 IDE、插件构成"三位一体"开发工具矩阵。CodeBuddy Code 是其命令行编程工具，通过自然语言驱动开发全流程，支持代码生成、项目重构、测试部署、代码审查、Git 提交等场景。

环境要求 ​

  • Node.js：18.0 / 18.20 或更高版本
  • npm：8.0 或更高（Node.js 自带）
  • 操作系统：Windows / macOS / Linux
bash
node --version
npm --version

安装 ​

方式一：npm 全局安装（推荐） ​

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

方式二：原生安装器（Beta，无需 Node.js） ​

bash
# macOS / Linux
curl -fsSL https://copilot.tencent.com/cli/install.sh | bash

# Windows (PowerShell)
irm https://copilot.tencent.com/cli/install.ps1 | iex

验证安装：

bash
codebuddy --version

登录认证 ​

首次启动 codebuddy 后选择登录方式：

登录方式适用场景
Chinese Site国内用户，腾讯云国内站（copilot.tencent.com）认证
International Site海外用户，腾讯云国际站（codebuddy.ai）认证
Enterprise Domain专享版/私有化部署，需企业服务地址
iOA仅腾讯内部员工

使用 ↑↓ 键选择，回车后自动打开浏览器完成认证（微信扫码 / GitHub / Google 登录）。

Windows 注意：若 PowerShell 提示脚本禁止运行：

powershell
Set-ExecutionPolicy -Scope CurrentUser RemoteSigned

配置模型 ​

如需配置腾讯云 Coding Plan 模型，编辑配置文件：

  • Windows：C:\Users\<用户名>\.codebuddy\models.json
  • macOS / Linux：~/.codebuddy/models.json
json
{
  "models": [
    {
      "id": "tc-code-latest",
      "name": "Auto",
      "vendor": "Tencent Cloud Coding Plan",
      "apiKey": "YOUR_CODING_PLAN_API_KEY",
      "url": "https://api.lkeap.cloud.tencent.com/coding/v3"
    }
  ]
}

支持的模型：

模型id 取值
Auto（推荐）tc-code-latest
Kimi-K2.5kimi-k2.5 / kimi-k-2-5
GLM-5glm-5 / glm-5-0

注意：旧版文档中的 https://api.lkeap.cloud.tencent.com/plan/v3 已更新为 /coding/v3，请使用新版地址。Coding Plan API Key 格式为 sk-sp-xxxx，与按量付费 Key（sk-xxxx）不互通。

配置后启动，输入 /model 选择配置的模型。套餐档位与额度详见 腾讯云 TokenHub Coding Plan。

基本使用 ​

进入项目并启动 ​

bash
cd /path/to/project
codebuddy

初始化项目上下文（强烈推荐） ​

bash
# 交互界面输入
/init

预先构建项目知识图谱，可提升理解准确度、加快响应、减少 30-50% 的 Token 开销。

使用模式 ​

bash
# 交互式对话
codebuddy

# 单次命令模式
codebuddy -p "优化这个 SQL 查询的性能"

常用命令 ​

命令用途
/help查看可用命令
/config设置语言等选项（如简体中文）
/init初始化项目上下文
/clear开启全新对话
/model选择模型

常见问题 ​

  • PowerShell 权限错误：Set-ExecutionPolicy -Scope CurrentUser RemoteSigned
  • 无法直接改写代码：部分版本限制，可将建议复制到 CodeBuddy 桌面客户端优化
  • 项目结构重大变化：/clear 后重新 /init

参考资源 ​