跳转至

Grok Build 接入 JarlessAPI 指南

本文档介绍如何安装 Grok Build(Grok CLI / TUI),并将其配置为通过 JarlessAPI 提供对话服务。

第一次使用命令行时,先完成 准备工作。本页的 Grok 指终端中的 Grok Build。

聊天走 Grok 分组即可。生图、生视频不要用 TUI 自带的 /imagine,请改走 Grok 生图 API 和 Grok 生视频 API。

前置条件

  • 已在 JarlessAPI 控制台获取 Grok 分组对应的 API Key(参见 获取 API Key)
  • Windows 用户可在 PowerShell 中安装,也可在 WSL 中安装;两套环境的配置文件互相独立

第一步:安装 Grok Build

按当前使用的终端选择。WSL 使用 Linux 的安装方式,在 WSL 终端中执行即可。

打开 PowerShell,执行:

irm https://x.ai/cli/install.ps1 | iex

安装完成后,关闭并重新打开一个新的 PowerShell 窗口,再执行:

grok --version

打开终端,执行:

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

安装完成后,重新打开当前系统的终端,再验证:

grok --version

已安装 Node.js 20 或更高版本时,可以通过国内 npm 镜像安装官方包。Windows PowerShell、macOS、Linux 和 WSL 都使用下面这条命令:

npm install -g @xai-official/grok@1.0.30 --registry=https://registry.npmmirror.com

这里固定使用 1.0.30,避免镜像的默认版本标签指向旧版。WSL 用户在 WSL 终端内执行。

安装完成后,重新打开终端并验证:

grok --version

若终端输出版本号,则安装成功。


第二步:写入配置文件

用文本编辑器打开当前环境的配置文件:

配置文件在 Windows 用户目录:

%USERPROFILE%\.grok\config.toml

例如 C:\Users\你的用户名\.grok\config.toml,可用记事本或 VS Code 编辑。

配置文件在当前系统的用户目录:

~/.grok/config.toml

WSL 用户编辑 Linux 家目录里的这份文件。

保留文件中已有的 [cli] 安装信息,添加或更新下面的配置。把 api_key 改成你自己的 Grok 分组 API Key:

[models]
default = "grok-4.6"

[model."grok-4.6"]
model = "grok-4.6"
base_url = "https://jarlessapi.com/v1"
api_key = "改成你自己的api key"
api_backend = "responses"
name = "Grok via JarlessAPI"

[marketplace]
default_skills_installs_purged = true

[ui]
max_thoughts_width = 120
fork_secondary_model = "grok-4.6"
yolo = false
compact_mode = false
permission_mode = "auto"

保存后,重新打开当前环境的终端。

使用正确分组的密钥

api_key 必须填写 Grok 分组的 API Key。不要填 Claude / Codex / Gemini 分组的密钥。

Base URL 必须带 /v1

Grok Build 的 base_url 是 https://jarlessapi.com/v1,末尾要有 /v1。这和 Claude Code、Gemini CLI 使用的 https://jarlessapi.com 不同。


第三步:启动并验证

在项目目录下执行:

grok

也可先检查配置再发一条测试:

grok inspect
grok -p "Reply with sub2api-ok" -m grok-4.6

和生图、生视频的区别

能力 怎么用
对话 / 写代码 本页的 Grok Build + ~/.grok/config.toml
生图 Grok 生图 API,POST /v1/images/generations
生视频 Grok 生视频 API,POST /v1/videos/generations

TUI 里的 /imagine、/imagine-video 走 xAI Imagine,不走 JarlessAPI。配置了 JarlessAPI 的 sk- 后,这两条命令会报 Incorrect API key,这是预期行为。

更多排错见 常见错误排查。

接通以后,继续练习

先在对话中确认当前文件夹和可用的文件操作能力,再按 个人作品集 练习描述需求。没有文件导出能力时可以先完成需求和文案;生成插画与知识图卡的路径见 图卡实战。