一、安装 CodeBuddy
CodeBuddy IDECodeBuddy Code访问 CodeBuddy IDE 页面，下载并安装与本机操作系统和处理器匹配的版本。CodeBuddy IDE 支持 Windows 和 macOS。根据本地环境安装 CodeBuddy Code。操作详情请参见 CodeBuddy Code 安装。如果已安装 CodeBuddy Code，可以跳过此步骤。
二、获取 API Key
登录 模型路由 控制台，创建模型路由 API Key。操作详情请参见 创建模型路由访问密钥。
注意：创建完成后，请你务必复制并妥善保管 API Key，关闭创建成功弹窗后，将无法再次查看完整的 API Key。
三、配置 CodeBuddy IDE
CodeBuddy IDE 支持通过图形界面添加 OpenAI 兼容模型，无需手动编辑配置文件。
1. 启动 CodeBuddy IDE。在对话面板下方单击模型选择框，然后单击配置自定义模型。
2. 在添加模型页面，将供应商设置为 Custom。
3. 填写以下配置，并单击保存。
| 配置项 | 配置值 |
| Base URL | https://<用户域名>/v1/chat/completions |
| API Key | 模型路由 API Key |
| 模型名称 | 填写当前 API Key 可调用的模型名称或意图路由名称，默认 ModelRouter/auto |
| 高级设置 | 按需勾选 |
4. 返回对话面板，打开模型选择框，在 Custom Models 中选择已添加的模型，即可开始使用。
四、配置 CodeBuddy Code
1. CodeBuddy Code 通过 models.json 配置自定义模型。配置文件路径如下，配置文件不存在时新建即可。
·Windows：C:\\Users\\<用户名>\\.codebuddy\\models.json
·macOS/Linux：~/.codebuddy/models.json
2. 将以下配置复制到 models.json，并将<USER_API_KEY>和<用户域名>替换为当前模型路由实例的实际配置信息。
{ "models": [ { "id": "ModelRouter/auto", "name": "Tencent Cloud CMR", "vendor": "Tencent Cloud", "apiKey": "<USER_API_KEY>", "url": "https://<用户域名>/v1/chat/completions" } ]}
注意：说明：
五、开始使用
1. 执行以下命令，启动 CodeBuddy Code。
codebuddy
六、Running Environment
Operating System: Ubuntu 24.04.3 LTS / x86_64Runtime Version: GNU bash, version 5.2.21(1)-release (x86_64-pc-linux-gnu)
2. 首次使用 CodeBuddy Code 时，根据页面提示确认是否信任当前工作目录。仅当你信任目录中的所有文件时，才选择信任并继续。
3. 根据实际场景选择登录方式，并按 Enter 键完成认证。
登录方式说明如下：
| 登录方式 | 适用场景 | 说明 |
| Chinese Site | 中国站用户 | 通过腾讯云中国站 (copilot.tencent.com) 进行认证，支持境内主流模型。 |
| International Site | 国际站用户 | 通过腾讯云国际站 (codebuddy.ai) 进行认证，支持境外主流模型。 |
| Enterprise Domain | 专享版/私有化部署 | 连接企业专享版或自建的 CodeBuddy 服务，需要输入企业提供的服务地址。 |
| iOA | 腾讯内部员工 | 通过腾讯 iOA 零信任系统进行认证，仅限腾讯内部员工使用。 |
4. 返回 CodeBuddy Code 命令行交互界面，输入 /model 并按 Enter 键。
5. 在模型列表中选择 Tencent Cloud CMR，即可开始使用。
注意：警告：
注意：请勿泄露 API Key，或将包含实际 API Key 的配置文件和 Shell 配置提交到代码仓库。