grok-plugin-codex

Русский | English

Плагин для использования Grok прямо в Codex.
Вы по-прежнему общаетесь с Codex. Ревью, исправление сложных багов, предложение решений, проектирование, наблюдение за PR, подготовка документов / изображений / видео — всё это передаётся локальному Grok Build.

Не является официальным продуктом xAI / OpenAI. Текущая версия 0.6.0. Apache-2.0. Производный от stdevMac/grok-in-codex.

Что это такое

Codex остаётся прорабом: вы говорите с ним, он разбивает задачи и следит за прогрессом.
Этот репозиторий — лишь тонкий MCP-плагин. Он не заменяет Codex и не встраивает модель Grok в Codex. Он вызывает уже установленный у вас локально CLI grok.

Подходит для: когда нужно добавить в Codex второго рабочего агента; структурированное ревью перед merge; рабочий процесс «предложение → проектирование → реализация»; или использование возможностей Grok по генерации изображений / видео / документов (в Codex их нет).
Не нужно: для исправлений в одну строку, переименований или болтовни, не касающейся репозитория.

Related MCP server: Grok-in-Codex

Что умеет

Более крупные продуктовые задачи не стоит засовывать в один гигантский rescue:

Артефакты попадают в каталог проекта (рекомендуется добавить в gitignore): .grok-plans/ .grok-designs/ .grok-reviews/ .grok-docs/ .grok-media/ .grok-workflows/.

Окружение

• Node.js 18.18+

• Grok Build CLI (grok) в PATH, обычный путь — ~/.grok/bin/grok

• grok login

• Рекомендуется Grok Build ≥ 1.0.5 (0.2.118 тоже запускается; конкретные флаги определяются по зонду возможностей)

• gh нужен только для публикации комментариев в PR

Этот плагин не содержит модель и не выполняет вход в Grok за вас.

Установка

codex plugin marketplace add /path/to/grok-plugin-codex/.agents/plugins
codex plugin add grok@grok-plugin-codex

Откройте новую сессию Codex, чтобы MCP-инструменты загрузились. Затем:

node plugins/grok/scripts/grok-companion.mjs setup

Или попросите Codex вызвать grok_setup.

Codex может запускать плагин из кэша установки. Передавайте реальный путь к проекту в cwd при каждом вызове инструмента, чтобы задачи и артефакты попадали в нужный репозиторий:

grok_review cwd="/path/to/project" base=main
grok_status cwd="/path/to/project" json=true

Начало работы

Просто скажите в Codex:

让 Grok 对照 main 评审这个分支。
用 Grok 规划一次鉴权重写。
让 Grok 出一份设计文档，然后 dry-run 执行最新方案。
给重试重构开一个后台 Grok rescue。
用 Grok 生成一张 16:9 发布 banner。
看看 Grok 任务状态。

Пример MCP:

grok_plan prompt="plan the auth rewrite" background=true
grok_design prompt="design multi-tenant billing" background=true
grok_execute_plan latest=true dryRun=true
grok_workflow action=list
grok_review base=main focus="auth, data loss, and race conditions"
grok_rescue prompt="investigate why npm test is failing" background=true
grok_babysit action=list
grok_document type=pdf prompt="one-pager for the launch"
grok_image aspect="16:9" prompt="Dark developer-tool launch banner"
grok_video image="./.grok-media/image/hero.png" duration="6" prompt="gentle camera push-in"
grok_status
grok_result jobId="plan-abc123"

Обзор инструментов

Параметры управления для длинных задач: sandbox (workspace, read-only, strict, devbox, off; старый алиас workspace-write нормализуется в workspace), planMode / permissionMode, agent, noSubagents, memory / noMemory, allow / deny, disableWebSearch, forkSession, maxTurns.

Выравнивание по Grok CLI 1.0.x: если в CLI нет --check / --best-of-n, они не передаются принудительно. check=true записывается в prompt. Задачи на запись, которые много раундов только читают и не пишут файлы, останавливаются по отклонению исполнения.

Ключевые моменты использования

Rescue — по умолчанию с записью. readOnly=true — только диагностика. worktree=true — более безопасные изменения.

Plan / design / execute — артефакты попадают в .grok-plans/ и .grok-designs/. latest=true выбирает последний дизайн. dryRun=true — только чтение.

Review — никогда не применяет патчи. При postPending=true после добавления PR, если есть находки, публикуется PENDING-комментарий в GitHub.

Media — файлы копируются в .grok-media/, чтобы сохранялся контракт пути проекта.

Jobs — background=true возвращает id задачи. Несколько задач Grok могут выполняться одновременно. Отслеживайте через grok_status / grok_result / grok_cancel.

Позиция CLI — используется denylist (--disallowed-tools), а не allowlist. Медиа, dry-run / validate-only, babysit list — только чтение (без yolo). Ревью по умолчанию --sandbox read-only, shell-инструменты не снимаются (Grok 1.0.x нуждается в них для выдачи результатов задач).

Переменные окружения

Каталог состояния по умолчанию: ~/.grok/codex-plugin/state/. Не используется совместно с состоянием плагина Claude.

Управление задачами

• Нет глобальной блокировки на одну задачу. Для длинных задач предпочтителен background=true.

• Состояние сопровождает текстовый и thought-потоки; при только пробельных токенах всё равно отображается running. Состояние также записывает последний инструмент и факт запуска пишущего инструмента.

• Для plan-результатов приоритетно собирается plan.md. Завершённые задачи хранят config, usage, artifacts (v3).

• Reaper: pid мёртв и result.json полный → completed; pid мёртв, но результат обрезан → failed (не зависает навсегда в running).

• Фоновый result.json записывается атомарно (tmp + rename).

• PR post-pending также выполняется при завершении фоновой задачи; пустой / слишком большой diff приводит к fail closed, находки записываются в .grok-reviews/.

Разработка

npm test
node plugins/grok/scripts/grok-companion.mjs setup --json
node plugins/grok/mcp/server.mjs   # stdio NDJSON MCP server

Номера версий в package.json, plugins/grok/.codex-plugin/plugin.json, .agents/plugins/marketplace.json должны совпадать.

Лицензия

Apache-2.0. См. LICENSE и NOTICE.

Этот проект является производным от stdevMac/grok-in-codex от stdevMac.