# Grok

> 全部文档的索引见 [llms.txt](https://ark.volcengine.com/llms.txt)；在任一文档页面地址后追加 `.md` 可获取该页的 Markdown 版本。

本文介绍如何在 Grok CLI 中配置并使用方舟 Agent Plan 企业版。

<span id="prerequisites"></span>
# 前提条件

* 需由管理员账号完成以下操作后，子账号方可配置并使用 Grok CLI：

  1. 购买方舟 Agent Plan 企业版套餐：[一、购买 Agent Plan 企业版](/docs/agent-plan-enterprise-get-started#purchase-plan)。
  2. 为子账号分配席位：[二、分配席位](/docs/agent-plan-enterprise-get-started#assign-seats)。

* 安装 [Node.js 18 或更新版本](https://nodejs.org/en/download/)。

<span id="install-grok"></span>
# 安装 Grok CLI

**选项：macOS/Linux**

在命令行界面，执行以下命令安装 Grok CLI。

```Bash
curl -fsSL https://x.ai/cli/install.sh | bash
```

安装结束后，执行以下命令查看安装结果，若显示帮助信息则安装成功。

```Bash
grok --help
```

**选项：Windows**

安装 [Git for Windows](https://gitforwindows.org/)，打开 Git Bash 执行以下命令。也可在 MSYS2 Bash 中运行。

```Bash
curl -fsSL https://x.ai/cli/install.sh | bash
```

官方脚本安装原生 Windows 可执行文件 `grok.exe`。如需从 PowerShell 或 CMD 启动，将 `%USERPROFILE%\.grok\bin` 加入用户 PATH，重新打开终端后运行 `grok`。在 WSL 中执行安装脚本时，使用 Linux 版本。

安装结束后，执行以下命令查看安装结果，若显示帮助信息则安装成功。

```Bash
grok --help
```

<span id="configure-grok"></span>
# 配置 Grok CLI

<span id="method-1-auto-helper"></span>
## 方式 1：一键配置（推荐）

Ark CLI 是火山方舟平台官方命令行工具，支持在本地终端快速完成认证与资源管理，并可将能力安装到常用 AI Agent 中，降低手动配置的时间成本和出错风险。

1. 安装 Ark CLI

    环境要求：Node.js 18 或更新版本。支持 macOS、Linux、Windows。

```Bash
npm install -g @volcengine/ark-cli@latest
arkcli --version
```

2. 登录 Ark CLI

    根据界面提示选择登录方式，推荐选择 **火山 SSO (浏览器登录)**，在浏览器中完成授权即可。

```Bash
arkcli auth login
```

3. 一键配置 Grok CLI

```Bash
arkcli helper
```
运行 ArkCLI Helper，根据界面提示完成配置。
* **选择 Profile**：`agent-plan-team_cn-beijing_team`。
* **选择默认 model**：按需选择。
* **选择 AI Agent**：`Grok`。

配置完成后，Grok CLI 会自动识别配置的模型。启动 Grok CLI 即可使用。

> **说明**
>
> * 如果 ArkCLI 提示不支持 `grok`，升级 ArkCLI 后重新配置。更多检查命令参见 [ArkCLI Helper 命令参考](/docs/tools-and-platform#helper-command)。
> * 如果返回鉴权错误，核对 profile、API Key 和 Base URL 是否属于同一接入方式。

<span id="method-2-manual"></span>
## 方式 2：手动配置

创建并编辑 `~/.grok/config.toml` 文件，Windows 系统为 `%USERPROFILE%\.grok\config.toml`。关注的配置信息如下：

* `<ARK_API_KEY>`：替换为您自己的 [专属 API Key](https://ark.volcengine.com/region:cn-beijing/subscription/agent-plan-enterprise/mine)。
* `model`：配置文本生成模型。可配置 `ark-code-latest` 或 Model Name，模型信息参见[支持模型及 Harness](/docs/agent-plan-enterprise-plan-overview#supported-models-harness)。

```toml
[model.ark-code-latest]
model = "ark-code-latest"
base_url = "https://ark.cn-beijing.volces.com/api/plan/v3"
api_backend = "chat_completions"
api_key = "<ARK_API_KEY>"
name = "ark-code-latest"

[models]
default = "ark-code-latest"
```

> **说明**
>
> * 如需将配置写入其他目录，设置 `GROK_HOME` 环境变量，配置文件路径为 `$GROK_HOME/config.toml`。
> * 如果配置后仍使用旧模型，退出 Grok CLI，确认启动终端中的 `GROK_HOME` 与配置时一致，再重新启动。

<span id="use-grok"></span>
# 使用 Grok CLI

1. 在终端进入需要使用的项目目录，启动 Grok CLI。

    ```Bash
    grok
    ```

2. 输入以下需求，验证模型能够回复并读取工作区。如果返回当前项目的文件结构，说明 Grok CLI 已完成方舟接入。

    ```text
    简单介绍一下当前目录的文件结构。
    ```