Skip to content

Grok CLI 接入

先说结论

Grok CLI 走的是 OpenAI 兼容接口,当前服务可直接作为其自定义 API 地址接入。

1. 安装前准备

Grok CLI 官方安装命令通过 npm 全局安装,因此需要先准备好:

  • Node.js 18+
  • npm(安装 Node.js 后通常会一起提供)

安装方式建议直接走 Node.js 官方下载页:https://nodejs.org/en/download

  • macOS / Windows:下载并安装 LTS 版本
  • Linux:按该页面提供的发行版方式安装

如果你在 macOS 上已经安装了 Homebrew,也可以直接执行:

bash
brew install node

安装完成后确认命令可用:

bash
node -v
npm -v

2. 安装

bash
npm install -g @vibe-kit/grok-cli

安装完成后确认:

bash
grok --version

3. 配置

Grok CLI 提供三种方式指定自定义 API 地址,优先级为 命令行参数 > 环境变量 > 配置文件。任选其一即可。

方式一:环境变量(推荐)

环境变量说明
GROK_BASE_URLAPI 根地址,替换 xAI 默认端点(默认 https://api.x.ai/v1
GROK_API_KEY你的 API Key

配置示例:

export GROK_BASE_URL="https://codex.openai.com/v1"
export GROK_API_KEY="codex_your_api_key"

如果只需要在当前 shell 会话中临时测试,直接 export 以上变量后执行 grok 即可。

如果希望永久生效,可以将上述 export 语句加入你的 shell 配置文件,例如 ~/.zshrc~/.bashrc,然后执行 source ~/.zshrc(或 source ~/.bashrc)使其生效。

方式二:配置文件

编辑用户全局设置文件 ~/.grok/user-settings.json

{
  "apiKey": "codex_your_api_key",
  "baseURL": "https://codex.openai.com/v1",
  "defaultModel": "grok-code-fast-1"
}

baseURL 填写服务的 https://codex.openai.com/v1 地址(带 /v1)。defaultModel 可按需替换为服务支持的模型。

方式三:命令行参数

启动时通过 --base-url 临时覆盖 API 地址:

bash
grok --base-url <ApiBaseUrl />

4. 启动

bash
grok

5. 验证

启动后在 Grok CLI 中发起一次对话,如果能正常收到回复,说明接入成功。

如果遇到鉴权错误,请确认 GROK_API_KEY 是否正确,以及 GROK_BASE_URL / baseURL 是否指向正确的服务地址(带 /v1)。

OpenAI-compatible gateway integration docs