内容
# Grok 在 Codex 中
在 Codex 中使用 Grok 进行代码审查、委托编码任务、后台调查、图像生成和视频生成。
Codex 保持为编排者。该插件公开一个小型 MCP 服务器，通过共享的伴侣运行时调用本地 Grok CLI。
如果使用 Claude Code，请使用配套插件：[grok-in-claude](https://github.com/stdevMac/grok-in-claude)。
## 您将获得
| Codex 工具 | 用途 |
| --- | --- |
| `grok_setup` | 检查 Grok CLI 和身份验证 |
| `grok_rescue` | 委托调查或修复；默认可写入 |
| `grok_review` | 结构化只读审查树、分支或 PR |
| `grok_adversarial_review` | 挑战设计、权衡和假设 |
| `grok_image` | 生成或编辑图像到 `.grok-media/image/` |
| `grok_video` | 生成短视频到 `.grok-media/video/` |
| `grok_status` | 显示活动和最近的 Grok 作业 |
| `grok_result` | 读取作业的最终存储输出 |
| `grok_cancel` | 取消后台作业 |
| `grok_transfer` | 为 Grok 构建上下文转移指南 |
包含的技能：
- `grok-routing` 用于决定何时委托
- `grok-cli-runtime` 用于伴侣运行时规则
- `grok-prompting` 用于强大的救援提示
- `grok-brand-media` 用于图像/视频配方
## 要求
- Node.js 18.18 或更高版本
- Grok CLI 在您的 `PATH` 中
- 通过 `grok login` 进行 Grok 身份验证
- GitHub CLI (`gh`) 仅适用于带有拉取请求的 `grok_review`
典型的 Grok CLI 位置：
```bash
~/.grok/bin/grok
~/.local/bin/grok
```
## 安装
从 GitHub：
```bash
codex plugin marketplace add stdevMac/grok-in-codex
codex plugin add grok@grok-in-codex
```
然后启动新的 Codex 线程以加载插件技能和 MCP 工具。
## 本地安装
从此仓库：
```bash
codex plugin marketplace add /path/to/grok-in-codex/.agents/plugins
codex plugin add grok@grok-in-codex
```
然后启动新的 Codex 线程以加载插件技能和 MCP 工具。
运行设置：
```bash
node plugins/grok/scripts/grok-companion.mjs setup
```
或要求 Codex 调用 `grok_setup`。
## 快速开始
自然地询问 Codex：
```text
要求 Grok 审查此分支与 main 的差异。
使用 Grok 调查身份验证测试为何不稳定。
为重试 redesign 启动后台 Grok 救援作业。
使用 Grok 生成 16:9 启动横幅。
显示 Grok 作业状态。
```
直接 MCP 工具示例：
```text
grok_review base=main focus="auth, data loss, and race conditions"
grok_rescue prompt="investigate why npm test is failing" background=true
grok_status
grok_result jobId="task-abc123"
grok_image aspect="16:9" prompt="Dark developer-tool launch banner for Grok in Codex"
grok_video image="./.grok-media/image/hero.png" duration="6" prompt="gentle camera push-in"
```
## 使用说明
### 救援
`grok_rescue` 默认可写入。使用 `readOnly: true` 仅用于诊断，使用 `worktree: true` 用于风险编辑。
有用的选项：
- `background: true` 用于长时间运行的工作
- `model: "fast"` 用于快速通过
- `model: "deep", effort: "high"` 用于更难的问题
- `worktree: true` 用于隔离编辑
- `check: true` 用于要求 Grok 验证后返回
- `bestOfN: 3` 用于运行并行尝试并选择最佳结果
- `resume: true`, `resumeSession`, 或 `fresh` 用于会话控制
### 审查
`grok_review` 是只读的，并在解析成功时返回结构化结果。
示例：
```text
grok_review
grok_review base=main
grok_review pr=123 focus="security and data-loss risks"
grok_adversarial_review focus="challenge this caching design"
```
### 媒体
图像和视频被复制到项目本地输出文件夹：
```text
.grok-media/image/
.grok-media/video/
```
示例：
```text
grok_image aspect="1:1" prompt="Simple geometric app icon, no text"
grok_image edit="./assets/logo.png" prompt="Make it monochrome with tighter padding"
grok_video refs=["shot1.png","shot2.png"] aspect="16:9" duration="6" prompt="product launch cutdown"
```
视频分辨率受 Grok 模型层级的限制，通常为 480p。
### 作业控制
后台作业可以并发运行。在有多个作业活动时使用显式作业 ID。
```text
grok_status
grok_status jobId="task-abc123"
grok_result jobId="task-abc123"
grok_cancel jobId="task-abc123"
```
## 工作原理
```text
Codex
-> Grok MCP 工具
-> node plugins/grok/mcp/server.mjs
-> node plugins/grok/scripts/grok-companion.mjs <command>
-> grok -p ... --output-format json|streaming-json
```
作业元数据存储在：
```text
~/.grok/codex-plugin/state/<repo-slug-hash>/
```
设置 `CODEX_PLUGIN_DATA` 以覆盖自定义环境中的插件数据目录。
## 安全
- `grok_rescue` 默认允许通过 Grok CLI 写入模式进行完全工具自动批准。
- 使用 `readOnly: true` 时仅需分析。
- 使用 `worktree: true` 进行更高风险的更改。
- 审查仅为只读。
- 媒体命令写入 `.grok-media/` 和 Grok 会话文件夹。
## 开发
```bash
npm test
node plugins/grok/scripts/grok-companion.mjs setup
node plugins/grok/scripts/grok-companion.mjs review --base main
node plugins/grok/scripts/grok-companion.mjs task --worktree --check "fix the failing test"
node plugins/grok/mcp/server.mjs
```
MCP 市场