FlexAPI Docs

主题

Grok Build 使用教程 ​

Grok Build 是一款面向代码项目的终端 AI 编程工具，支持交互式 TUI、无头模式和自定义模型配置。本页整理通过 FlexAPI 接入 Grok Build 的基础流程。

Step 1：安装 Grok Build ​

Windows PowerShell 用户可以执行：

powershell
npm install -g @xai-official/grok

安装完成后，重新打开终端并确认命令可用：

powershell
grok --help

macOS、Linux 或 WSL 用户也可以使用官方安装脚本：

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

也可以参考 Grok Build 官方安装文档 使用其他安装方式。

Step 2：准备 FlexAPI API Key ​

  1. 登录 FlexAPI。
  2. 选择要使用的分组。
  3. 创建或复制 FlexAPI API Key。
  4. 确认当前分组已开通目标模型，并记录模型 ID。

参考：FlexAPI API 获取教程

Step 3：配置 FlexAPI ​

Grok Build 的用户配置文件位于：

text
Windows：%USERPROFILE%\.grok\config.toml
macOS / Linux：~/.grok/config.toml

先在 PowerShell 中设置 API Key：

powershell
$env:FLEXAPI_API_KEY = "替换为你的 FlexAPI API Key"

然后创建或编辑 config.toml，填入以下内容：

toml
[models]
default = "flexapi"

[model.flexapi]
model = "替换为 FlexAPI 模型 ID"
base_url = "https://flexapi.me/v1"
name = "FlexAPI"
env_key = "FLEXAPI_API_KEY"
api_backend = "chat_completions"

其中：

  • model 替换为 FlexAPI 当前分组支持的模型 ID。
  • base_url 使用 OpenAI 兼容端点 https://flexapi.me/v1。
  • env_key 会读取当前终端中的 FLEXAPI_API_KEY 环境变量。

API Key 安全

推荐使用环境变量保存 API Key，不要把真实密钥直接写入公开仓库或截图。使用新的终端窗口时，需要重新设置该环境变量，或按系统方式配置持久环境变量。

Step 4：检查配置并启动 ​

进入项目目录，先检查 Grok Build 读取到的配置：

powershell
cd 你的项目目录
grok inspect

如果配置显示正常，启动交互式会话：

powershell
grok

也可以直接使用无头模式执行一次测试：

powershell
grok -p "请先阅读当前项目结构，并告诉我项目的启动命令，不要修改文件。"

常见问题 ​

找不到 grok 命令 ​

重新打开 PowerShell，使安装程序写入的用户 PATH 生效；仍然无效时，检查 %USERPROFILE%\.grok\bin 是否已加入用户 PATH。

模型不可用 ​

检查 model 是否与 FlexAPI 控制台中的模型 ID 完全一致，并确认当前分组已开通该模型。

API Key 无效 ​

确认当前终端已经设置 FLEXAPI_API_KEY，且 config.toml 中的 env_key 拼写为 FLEXAPI_API_KEY。

参考资料 ​

FlexAPI Docs

Copyright © 2026 FlexAPI