> ## 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.

# Crush

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

Crush 既是一款在终端中运行的 CLI + TUI AI 编程工具，也支持多种模型接入，能够在命令行环境下完成代码生成、调试、对话、文件操作与多任务处理等工作。

<Tip>
  使用最新 GLM 模型，需要在 crush 中执行 `/models` 选择模型编码为对应的模型编码
</Tip>

## 一、安装 Crush

根据您的系统选择对应的安装方式：

<Tabs>
  <Tab title="Homebrew（macOS 推荐）">
    ```
    brew install charmbracelet/tap/crush
    ```
  </Tab>

  <Tab title="NPM（跨平台）">
    ```
    npm install -g @charmland/crush
    ```
  </Tab>

  <Tab title="Arch Linux">
    ```
    yay -S crush-bin
    ```
  </Tab>

  <Tab title="Nix">
    ```
    nix run github:numtide/nix-ai-tools#crush
    ```
  </Tab>
</Tabs>

## 二、配置 GLM 模型

<Tabs>
  <Tab title="方式一：自动化助手">
    Coding Tool Helper 是一个编码工具助手，快速将您的**GLM编码套餐**加载到您喜爱的**编码工具**中。安装并运行它，按照界面提示操作即可自动完成工具安装，套餐配置，MCP服务器管理等。

    ### 1. 获取 API 密钥

    * 个人版套餐的用户，通过 [个人编程套餐 > 套餐概览](https://bigmodel.cn/coding-plan/personal/overview)，新建  API Key
    * 团队版套餐的成员，通过 [团队编程套餐 > 我的套餐](http://bigmodel.cn/coding-plan?z_plan=team)，获取  API Key（团队套餐 Key 与平台其他 API Key 不通用，使用团队额度请务必使用团队套餐 Key）

    ### 2. 运行 Coding Tool Helper

    ```bash theme={null}
    # 进入命令行界面，执行如下运行 Coding Tool Helper
    npx @z_ai/coding-helper
    ```

    详细说明请参考 [Coding Tool Helper 文档](/cn/coding-plan/extension/coding-tool-helper)。

    ### 3. 启动 Crush

    配置完成后，您可以运行以下命令启动 Crush：

    ```
    crush
    ```

    通过输入模型名称，选择对应模型进行操作：

    ```
    /models
    ```
  </Tab>

  <Tab title="方式二：手动配置">
    ### 1. 获取 API 密钥

    * 个人版套餐的用户，通过 [个人编程套餐 > 套餐概览](https://bigmodel.cn/coding-plan/personal/overview)，新建  API Key
    * 团队版套餐的成员，通过 [团队编程套餐 > 我的套餐](http://bigmodel.cn/coding-plan?z_plan=team)，获取  API Key（团队套餐 Key 与平台其他 API Key 不通用，使用团队额度请务必使用团队套餐 Key）

    ### 2. 启动 Crush 并选择模型

    运行 crush 命令启动应用：

    ```
    crush
    ```

    在模型选择界面中，选择您想使用的模型

    ### 3. 输入 API 密钥

    在提示界面中输入您从智谱 AI 获取的 API Key。

    ### 4. 修改 Crush 配置

    #### 4.1 找到配置文件

    配置文件位置因操作系统而异：

    <Tabs>
      <Tab title="macOS/Linux">
        ```
        ~/.config/crush/crush.json
        ```
      </Tab>

      <Tab title="Windows">
        ```
        %USERPROFILE%\.config\crush\crush.json
        ```
      </Tab>
    </Tabs>

    #### 4.2 修改 API 端点

    打开 crush.json 文件，配置如下，注意替换您的 API KEY：

    ```
    {
      "providers": {
        "zai": {
          "id": "zai",
          "name": "ZAI Provider",
          "base_url": "https://open.bigmodel.cn/api/coding/paas/v4",
          "api_key": "your_api_key"
        }
      }
    }
    ```

    ### 5. 完成配置并启动 Crush

    配置完成后，您可以运行以下命令启动 Crush：

    ```
    crush
    ```

    通过输入模型名称，选择指定模型进行操作：

    ```
    /models
    ```
  </Tab>
</Tabs>

配置完成后，重启 Crush 应用即可开始使用。

## 三、套餐专属 MCP 服务器

GLM Coding Plan 提供了专属的 MCP 服务器，支持视觉识别、搜索、网页读取和开源仓库访问等功能：

* [视觉 MCP 服务器](/cn/coding-plan/mcp/vision-mcp-server) - 支持图像识别和分析
* [搜索 MCP 服务器](/cn/coding-plan/mcp/search-mcp-server) - 支持网络搜索功能
* [网页读取 MCP 服务器](/cn/coding-plan/mcp/reader-mcp-server) - 支持网页内容提取
* [开源仓库 MCP 服务器](../mcp/zread-mcp-server) - 支持开源仓库文档搜索、结构分析和代码读取

<Tip>
  **推荐方式**：使用 Coding Tool Helper 可以一键安装和管理所有套餐 MCP 服务器，无需手动配置。

  ```bash theme={null}
  npx @z_ai/coding-helper
  ```

  Coding Tool Helper 会自动检测您的工具环境并安装相应的 MCP 服务器。
</Tip>