xAI · 工具文档
Grok Build
本文说明 Grok Build 的安装、清理配置文件、填写配置文件。若你曾使用过 Grok Build,请先完成下方清理,再继续安装配置。
1 清理旧配置
2 安装 CLI / TUI
3 手写 config.toml
安装前必读
如果你使用过 Grok Build(CLI / TUI),请先到用户目录下的
Grok Build 的配置文件路径为:
如果你未使用过 Grok Build,可跳过清理步骤,直接前往 安装。
.grok 文件夹中,清空配置文件
config.toml
的内容(或删除后由程序重建)。旧配置容易导致冲突或连到错误环境。
Grok Build 的配置文件路径为:
.grok/config.toml(Windows 一般为
C:\Users\你的用户名\.grok\config.toml)。
如果你未使用过 Grok Build,可跳过清理步骤,直接前往 安装。
清理旧配置
重要
清空前请务必备份相关文件(复制到其他目录或改名保存),以免需要时无法恢复。
Grok Build 的配置文件为用户主目录下的
.grok/config.toml。不同系统完整路径如下:
| 系统 | 配置文件路径 |
|---|---|
| Windows | C:\Users\你的用户名\.grok\config.toml |
| macOS / Linux | ~/.grok/config.toml |
需要处理的文件
config.toml— Grok Build 主配置文件(位于.grok目录下)
请将 config.toml 内容清空(保留空文件亦可),或直接删除它;后续重启使用时会重新生成。
提示
若
.grok 目录中还有其他缓存文件,一般不必动;本次配置重点是清掉
config.toml,避免旧配置干扰。
安装
完成上方清理后,安装 Grok Build CLI。Grok Build 以终端交互界面(TUI)为主, 无需安装桌面端。
注意
使用官方安装脚本前,请确认本机可以正常访问外网(含下载安装脚本与拉取安装包)。网络受限、需代理或无法访问官方域名时,请先配置好代理后再执行。
Windows(PowerShell)
在 PowerShell 中执行:
irm https://x.ai/cli/install.ps1 | iex
macOS / Linux / Git Bash
curl -fsSL https://x.ai/cli/install.sh | bash
验证安装
安装完成后,在终端执行:
grok --version
能输出版本号即表示安装成功。之后可在项目目录中执行 grok 启动。
提示
如需更新到最新版本,可在已安装的环境下执行:
grok update。
填写配置文件
开始配置前
必须先按上文
清理旧配置
清空配置文件,同时请
关闭正在运行的 Grok Build(grok),再进行后续配置。Grok Build
请直接编辑
.grok/config.toml,无需使用 cc-switch。
配置文件位置
| 系统 | 路径 |
|---|---|
| Windows | C:\Users\你的用户名\.grok\config.toml |
| macOS / Linux | ~/.grok/config.toml |
创建 API 密钥
提示
请尽量使用 Edge 或 谷歌浏览器(Chrome) 打开官网进行后续操作。
- 打开官网 https://aiapi.317ak.com/ ,登录你的账号。
- 登录成功后,点击 控制台。
- 在页面左侧选择 API 密钥。
- 在页面右侧点击 创建 API 密钥。
-
在创建 API 密钥页面:
- 名称:随意填写即可。
- 分组:必须选择 grok 分组(务必选对,否则无法正常使用)。
- 其他配置不要改动,保持默认。
- 确认无误后,点击 保存更改,并妥善保存生成的密钥(后续填入
config.toml的api_key)。
注意
分组必须选择 grok。API 密钥请自行备份,勿泄露、勿提交到 Git 仓库。
编写 config.toml
用文本编辑器打开(或新建)config.toml,写入以下内容,并将
api_key 替换为上一步创建的密钥;按需修改
model:
[model.my-grok]
model = "grok-4.5"
base_url = "https://aiapi.317ak.com/v1"
name = "My Grok"
api_key = "你的 API 密钥"
[models]
default = "my-grok"
字段说明
-
model:你想使用的 Grok 模型。例如使用grok-4.5,则填写model = "grok-4.5"。 -
base_url:固定为https://aiapi.317ak.com/v1。 name:显示名称,可按需修改(示例为My Grok)。-
api_key:填写上文 创建 API 密钥 得到的密钥。 -
[models]中的default = "my-grok":表示默认使用上方[model.my-grok]这段配置(名称需与段落名一致)。
提示
保存
config.toml 后,在项目目录执行 grok 即可使用。若改完不生效,请确认已关闭旧的 grok 进程后重新启动。
注意
请勿将含有
api_key 的配置文件提交到代码仓库或发给无关人员。