Grok CLI 命令行工具

精选 Grok CLI 常用指令与核心速查备忘单,涵盖高频用法、配置参数与实用技巧。 Grok CLI 是一款由 xAI Grok 模型驱动的对话式 AI 终端工具,具备文件读写操作、代码分析、规划分析模式 (Plan Mode) 和 MCP 协议支持。

#🚀 入门指引

#快速入门

# 免安装直接运行
$ GROK_API_KEY=your_key npx -y grok-cli-hurry-mode@latest

# 全局安装
$ npm install -g grok-cli-hurry-mode@latest

# 启动交互式会话
$ grok

# 启动并发送初始消息
$ grok "Help me understand this project"

# Headless / 非交互模式
$ grok -p "explain the auth module"

# 使用指定大模型版本
$ grok -m grok-4-latest "refactor this file"

# 设置工作区基准目录
$ grok -d /path/to/project

# 设置最大工具调用轮数
$ grok --max-tool-rounds 100 "rewrite the API"

#身份认证 (Authentication)

认证方式 操作步骤与说明
环境变量配置 export GROK_API_KEY=your_key
内联传参 (npx) GROK_API_KEY=key npx grok-cli-hurry-mode@latest
命令行 Flag grok --api-key your_key
配置文件设置 ~/.grok/user-settings.json 中配置 apiKey

前往 console.x.ai 获取您的 API Key。

在 Shell 配置文件中持久化:

echo 'export GROK_API_KEY=your_key' >> ~/.zshrc
source ~/.zshrc

#安装方式 (Installation Methods)

安装途径 命令行指令
npm (推荐) npm install -g grok-cli-hurry-mode@latest
npx (免安装) npx grok-cli-hurry-mode@latest
yarn yarn global add grok-cli-hurry-mode@latest
pnpm pnpm add -g grok-cli-hurry-mode@latest
bun bun add -g grok-cli-hurry-mode@latest
自动化安装脚本 curl -fsSL https://raw.githubusercontent.com/hinetapora/grok-cli-hurry-mode/main/install.sh \| bash

系统要求: Node.js (最新 LTS 版本)、npm/yarn/pnpm、网络连接。

#AI 模型版本 (AI Models)

模型标识符 模型特点与适用场景
grok-code-fast-1 默认模型 — 针对代码理解与编写深度优化
grok-4-latest 最新顶尖模型,具备增强的代码与逻辑推理能力
grok-3-fast 快速通用的通用大语言模型

可通过 -m 标志、GROK_MODEL 环境变量或 ~/.grok/user-settings.json 覆盖指定。

自定义 API Endpoint 基地址:-u https://api.x.ai/v1GROK_BASE_URL

#命令行参数 (CLI Options)

#参数全集 (All Options)

参数选项 缩写 详细含义与功能说明
--api-key <key> -k 指定 Grok API Key
--base-url <url> -u 指定 API 服务基地址 (Base URL)
--model <model> -m 指定使用的 Grok 模型
--prompt <text> -p 指定非交互式 Headless 模式的 Prompt 文本
--directory <dir> -d 指定工作区根目录
--max-tool-rounds <n> 最大工具调用轮数 (默认: 400)
--version -V 显示当前版本号
--help -h 显示帮助信息

核心环境变量:

环境变量名称 详细用途与说明
GROK_API_KEY API 密钥 (必填)
GROK_MODEL 默认模型覆盖
GROK_BASE_URL 自定义 API Endpoint 端点

#子命令 (Subcommands)

# AI 自动生成提交信息并 Push 代码
$ grok git commit-and-push
$ grok git commit-and-push -d /path/to/repo
$ grok git commit-and-push -m grok-4-latest

# MCP 服务器管理
$ grok mcp add <name>
$ grok mcp add-json <name> <json>
$ grok mcp remove <name>
$ grok mcp list
$ grok mcp test <name>

git commit-and-push 子命令支持与主命令相同的 -d, -k, -u, -m, --max-tool-rounds 标志。

#交互模式 (Interactive Mode)

#键盘快捷键

快捷键 执行操作
Shift+Tab (连按两次) 进入规划分析模式 (Plan Mode)
Shift+Tab 切换开启/关闭自动编辑模式 (Auto-edit)
Ctrl+I 查看上下文工具提示面板 (工作区状态)
Ctrl+C 清空当前输入框
Esc 中断当前进行中的 AI 操作
/ 浏览历史输入记录

自动编辑模式 (Auto-edit mode): 无感代码编辑——AI 无需弹出确认提示框即可直接修改文件。

上下文提示面板 (Ctrl+I): 展示项目统计、Git 分支、内存占用及会话详细信息。

#斜杠指令

命令指令 含义说明
/help 显示可用斜杠指令列表
/clear 清空终端屏幕
/models 列出可用的 Grok 模型列表
/exit 退出应用
/compact 压缩清理对话上下文
/commit-and-push 触发 AI 生成 Commit Message 并 Push
/init-agent 初始化 Agent 规范文档
/docs 打开官方文档
/readme 自动生成项目 README 文档
/api-docs 自动生成 API 文档
/changelog 自动生成变更日志 Changelog
/comments 自动为代码补充注释
/update-agent-docs 更新 Agent 规范文档
/heal 运行自我修复自检系统
/guardrails 显示安全护栏状态

#配置文件 (Config Files)

配置文件路径 用途说明
~/.grok/user-settings.json 全局用户个人设置
.grok/settings.json 项目级专属设置
.grok/GROK.md 供 AI 读取的项目上下文文档

user-settings.json 示例:

{
  "apiKey": "your_api_key",
  "model": "grok-code-fast-1",
  "baseURL": "https://api.x.ai/v1"
}

创建项目上下文文档:

# 为 Plan Mode 添置项目规范
$ mkdir -p .grok
$ echo "# Project Rules" > .grok/GROK.md

#工具矩阵 (Tools)

#核心工具 (Core Tools)

工具名称 详细功能介绍
Read 读取文本、图像、PDF、Jupyter Notebook 文件
Write 创建新文件或全量覆盖现有文件
Edit 精准字符串查找与替换
Bash 在 Shell 中执行终端命令
Grep 基于 ripgrep 的正则表达式搜索
Glob 文件路径通配符匹配
LS 列出目录下的文件与子目录

Read 工具 支持大文件的行偏移量/行数限制,并可以可视化展示图像。

Edit 工具 支持:

  • 精准文本字符串替换
  • 正则表达式模式匹配
  • 单次或全量替换所有匹配项

Bash 工具 支持:

  • 捕获 stdout 标准输出与 stderr 标准错误
  • 后台守护进程运行
  • 超时控制管理
  • 环境变量继承与覆盖

#高级扩展工具 (Advanced Tools)

工具名称 详细功能介绍
MultiEdit 原子化跨多文件批量编辑与事务回滚
WebFetch 抓取并解析网页内容为 Markdown
WebSearch 实时搜索引擎联网检索
Task 派发分发任务至专业 Sub-Agent 子代理
TodoWrite 待办事项追踪与进度管理

MultiEdit 组合操作:在单次事务中同时创建、修改、删除、重命名和移动多个文件。

Task(子代理派发):

  • Token 占用优化处理
  • 复杂调研与深度分析
  • 独立自主运行并生成汇报

WebFetch: 智能将 HTML 转换为 Markdown,并包含 AI 提取与缓存机制。

#IDE 专属工具 (IDE Tools)

工具名称 详细功能介绍
NotebookEdit 编辑 Jupyter Notebook 单元格代码
BashOutput 流式查看后台运行进程的输出日志
KillBash 终止指定后台运行的进程

AI 自动选择最适合您当前请求的工具组合——无需手动显式调用。

#规划分析模式 (Plan Mode)

#激活规划模式 (Activating Plan Mode)

快速连按 Shift+Tab 两次

🎯 Plan Mode: Analysis
📊 Exploring codebase and gathering insights...

或使用 Headless 非交互命令:

$ grok -p "analyze changes in this PR and create plan"
$ grok -p "check if changes follow architecture guidelines"

规划模式下禁用的操作:

  • 所有的文件写入/修改编辑工具
  • 具有破坏性的 Bash 命令行
  • 任何会修改系统状态的操作

允许的操作:

  • 文件读取与检索 (ls, cat, grep)
  • 联网搜索与网页抓取
  • 项目结构与依赖分析
  • 方案生成(仅允许写入 Plan 方案文档)

退出规划模式:

  • Enter 键——确认并开启执行该方案
  • Esc 键——退出且不执行方案

#规划模式阶段划分 (Plan Mode Phases)

阶段步骤 预计耗时 详细执行动作
🔍 深度分析 1–5 秒 分析项目类型、目录结构与依赖
🧠 制定策略 5–15 秒 AI 自动生成详细的实现步骤方案
📋 呈现方案 1–2 秒 格式化方案文档供审查
✅ 审批确认 用户掌控 审查、确认批准或提出修改

Plan Mode 会全面分析:项目类型 (Node/Python/React 等)、目录树结构、核心组件、依赖关联、入口文件、模块划分及架构模式。

#规划模式实用技巧 (Plan Mode Tips)

推荐在以下场景下开启 Plan Mode:

  • 涉及多个文件改动的复杂新功能
  • 大规模代码重构与架构迁移
  • 熟悉与阅读陌生的代码库
  • 改动前进行风险评估与影响分析

使用建议:

  • 对期望达成的目标描述尽可能具体
  • 批准执行前认真审查 Plan 方案
  • 出现问题时可调用 /heal 自检修复
  • 创建 .grok/GROK.md 提供专属背景规则

#MCP 服务器

#管理 MCP 服务器 (Managing MCP Servers)

# Add stdio server
$ grok mcp add myserver \
  -t stdio \
  -c npx \
  -a -y my-mcp-package

# Add HTTP/SSE server
$ grok mcp add myserver \
  -t http \
  -u https://api.example.com/mcp

# Add with env vars and headers
$ grok mcp add myserver \
  -t http \
  -u https://api.example.com/mcp \
  -e API_KEY=secret \
  -h Authorization="Bearer token"

# Add from raw JSON
$ grok mcp add-json myserver \
  '{"transport":{"type":"stdio","command":"npx","args":["-y","pkg"]}}'

# List all servers
$ grok mcp list

# Test connection
$ grok mcp test myserver

# Remove a server
$ grok mcp remove myserver

#MCP 配置架构规范 (Config Schema)

.grok/settings.json 中配置:

{
  "mcpServers": [
    {
      "name": "my-server",
      "transport": {
        "type": "stdio",
        "command": "npx",
        "args": ["-y", "my-mcp-package"],
        "env": { "KEY": "value" }
      }
    },
    {
      "name": "remote-server",
      "transport": {
        "type": "http",
        "url": "https://api.example.com/mcp",
        "headers": { "Authorization": "Bearer $TOKEN" }
      }
    }
  ]
}

传输模式类型 (Transport types):

传输类型 适用场景说明
stdio 本地子进程通信 (默认)
http 远程 HTTP 端点
sse Server-Sent Events 流式事件
streamable_http 流式 HTTP 传输

#添加服务器命令行选项 (Add Options)

参数选项 缩写 详细含义与功能说明
--transport <type> -t 指定传输模式:stdio / http / sse / streamable_http
--command <cmd> -c 可执行文件命令 (仅 stdio)
--args [args...] -a 命令参数数组 (仅 stdio)
--url <url> -u 服务器 URL 地址 (http/sse)
--headers [kv...] -h HTTP 请求头 (key=value)
--env [kv...] -e 环境变量 (key=value)

#🔧 常见问题与排错 (Troubleshooting)

#常见错误解决 (Common Issues)

未找到 API key (API key not found):

# 检查环境变量是否正确设置
$ echo $GROK_API_KEY

# 或在命令行中直接指定
$ GROK_API_KEY=key grok "hello"

安装后提示找不到命令 (Command not found):

# 将 npm 全局 bin 目录添加至 PATH 环境变量
$ echo 'export PATH="$(npm config get prefix)/bin:$PATH"' >> ~/.zshrc
$ source ~/.zshrc
$ which grok

全局安装时报权限错误 (Permission errors):

# 强行安装或使用 Node 版本管理器
$ npm install -g grok-cli-hurry-mode --强制执行

# 推荐使用 nvm 免 sudo 安装
$ nvm use --lts
$ npm install -g grok-cli-hurry-mode

安装卡死或存在旧缓存:

$ pkill -f grok
$ npm uninstall -g grok-cli-hurry-mode
$ npm cache clean --强制执行
$ npm install -g grok-cli-hurry-mode@latest

#核心环境变量速查 (Useful Env Vars)

环境变量名称 详细功能说明
GROK_API_KEY API 密钥 (必填)
GROK_MODEL 覆盖默认模型
GROK_BASE_URL 自定义 API 服务 Endpoint

默认 API Endpoint 端点: https://api.x.ai/v1

#Git 智能 Push (Smart Push)

自动发布系统会自动创建版本提升 Commit,请务必使用 smart push 避免代码冲突:

# 正确方式 — 自动处理版本号提升冲突
$ npm run smart-push
$ git pushup

# 错误方式 — 会导致 "fetch first" 报错
$ git push origin main

#🔗 参考资源