面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/ai-tools-grok.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

Grok

本文介绍如何通过 ArkCLI Helper 为 Grok CLI 配置方舟 按量计费模型服务,并在项目目录中启动工具完成首次对话。

本文使用 Platform profile 和推理接入点(Endpoint)。如需使用套餐额度,参见 Coding Plan 接入说明。

前提条件#

  • 本文通过 npm 安装 ArkCLI,需提前安装 Node.js LTS。
  • 已创建并启动支持文本输出和工具调用的 Endpoint,记录其 Endpoint ID。创建方法参见 推理与训练。
  • 已获取有权调用该 Endpoint 的 API Key。

第 1 步 · 安装工具#

  1. 按操作系统执行 Grok 官方安装脚本。

在终端执行以下命令。

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

安装 Git for Windows,打开 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 版本。

  1. 安装最新版 ArkCLI。

    Bash
    npm install -g @volcengine/ark-cli@latest
    
  2. 打开新的终端会话,检查安装结果。以下命令应分别显示 Grok CLI 帮助和 ArkCLI 版本。

    Bash
    grok --help
    arkcli --version
    

第 2 步 · 配置接入#

  1. 登录 ArkCLI,并查看可用 profile。

    Bash
    arkcli auth login
    arkcli profile list
    
  2. 选择 platform 类型的 profile。将 <PLATFORM_PROFILE> 替换为列表中的 profile 名称,将 <ENDPOINT_ID> 替换为已启动的 Endpoint ID。

    Bash
    arkcli helper configure grok --profile <PLATFORM_PROFILE> --endpoint <ENDPOINT_ID>
    

    Helper 使用 OpenAI Chat Completions 协议,Base URL 为 https://ark.cn-beijing.volces.com/api/v3,实际请求的 model 为 Endpoint ID。Helper 只接受已验证为文本输出的 Endpoint;支持图片输入、文本输出的模型也可使用。

  3. 确认 Helper 输出的模型和 Base URL 与所选资源一致。

    Helper 默认写入 ~/.grok/config.toml:model_providers 保存 provider,model 保存模型清单,models.default 指向选定模型。api_backend 为 chat_completions。设置 GROK_HOME 后,配置写入该环境变量指定的目录。

第 3 步 · 启动并验证#

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

    Bash
    grok
    
  2. 输入以下需求,验证模型能够回复并读取工作区。

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

    如果返回当前项目的文件结构,说明 Grok CLI 已完成方舟接入。

  3. 如果配置后仍使用旧模型,退出 Grok CLI,确认启动终端中的 GROK_HOME 与配置时一致,再重新启动。

    如果 ArkCLI 提示不支持 grok,升级 ArkCLI 后重新配置;如果返回鉴权错误,核对 profile、API Key 和 Base URL 是否属于同一接入方式。更多检查命令参见 ArkCLI Helper 命令参考。

ArkCLI 认证与配置。

ArkCLI Helper 命令参考。