> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bigmodel.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# CodeBuddy

> 在 CodeBuddy 中使用 GLM Coding Plan 的方法

CodeBuddy 是一款基于 AI 的全流程智能编程工具，致力于构建产品、设计、研发、部署无缝协作的共生环境。

<Note>
  使用最新 GLM 模型，需要选择对应的模型编码
</Note>

## 一、安装 CodeBuddy

访问 [CodeBuddy](https://www.codebuddy.cn/home/) 官网下载并安装适合您的操作系统的版本。

## 二、登陆 CodeBuddy

下载安装后根据提示登录CodeBuddy

## 三、配置 GLM Coding Plan

<Steps>
  <Step title="配置文件位置">
    <Tip>
      `models.json` 是一个配置文件，用于自定义模型列表和控制模型下拉列表的显示。

      建议在用户级配置该文件：`~/.codebuddy/models.json` - 全局配置，适用于所有项目。
    </Tip>
  </Step>

  <Step title="配置结构">
    ```
    {
        "models": [
    {
        "id": "glm-5.2",
        "name": "MyModel",
        "vendor": "zhipu",
        "apiKey": "Your-API-Key",
        "url": "https://open.bigmodel.cn/api/coding/paas/v4",
        "supportsToolCall": true,
        "supportsReasoning": true
    }
        ]
    }
    ```

    <Warning>
      请妥善保管您的 API Key，不要泄露给他人，也不要直接硬编码在代码中。
    </Warning>
  </Step>

  <Step title="配置字段说明">
    **Models：**

    类型： `Array<LanguageModel>`

    定义自定义模型列表。可以添加新模型或覆盖内置模型配置。

    **LanguageModel：**

    | 字段                | 类型      | 必填 | 说明                      |
    | ----------------- | ------- | -- | ----------------------- |
    | id                | string  | ✓  | 模型唯一标识符                 |
    | name              | string  | -  | 模型显示名称                  |
    | vendor            | string  | -  | 模型供应商（如 OpenAI, Google） |
    | apiKey            | string  | -  | API 密钥（实际密钥值，非环境变量名）    |
    | maxInputTokens    | number  | -  | 最大输入 token 数            |
    | maxOutputTokens   | number  | -  | 最大输出 token 数            |
    | url               | string  | -  | API 端点 URL（必须是接口完整路径）   |
    | supportsToolCall  | boolean | -  | 是否支持工具调用                |
    | supportsImages    | boolean | -  | 是否支持图片输入                |
    | supportsReasoning | boolean | -  | 是否支持推理模式                |

    **availableModels：**

    类型：`Array<string>`

    控制模型下拉列表中显示哪些模型。只有在此数组中列出的模型 ID 才会在 UI 中显示。

    * 如果未配置或为空数组，则显示所有模型
    * 配置后，只显示列出的模型 ID
    * 可以同时包含内置模型和自定义模型的 ID
  </Step>

  <Step title="回到 CodeBuddy 进行对话">
    在对话框选择配置好的模型进行对话即可
  </Step>
</Steps>