grok-plugin-codex

中文 | English

Ein Plugin, um Grok direkt in Codex zu nutzen.
Du sprichst weiterhin mit Codex. Reviews, harte Bugs beheben, Pläne erstellen, Designs schreiben, PRs überwachen, Dokumente / Bilder / Videos erstellen – das übernimmt dein lokales Grok Build.

Kein offizielles Produkt von xAI / OpenAI. Aktuelle Version 0.6.0. Apache-2.0. Abgeleitet von stdevMac/grok-in-codex.

Was ist das?

Codex bleibt der Vorarbeiter: Du sprichst mit ihm, er zerlegt Aufgaben und überwacht den Fortschritt.
Dieses Repository ist nur eine sehr dünne MCP-Plugin-Schicht – es ersetzt Codex nicht und bettet auch kein Grok-Modell in Codex ein. Es ruft die bereits lokal installierte grok-CLI auf.

Geeignet für: Du möchtest in Codex eine zweite, arbeitsfähige KI-Instanz hinzufügen; vor dem Merge eine strukturierte Review; den Weg „Plan → Design → Umsetzung" gehen; oder die Bild- / Video- / Dokument-Fähigkeiten von Grok nutzen (die Codex selbst nicht hat).
Nicht nötig für: Fixes, die in einer Zeile erledigt sind, Umbenennungen oder Smalltalk, der das Repository gar nicht berührt.

Related MCP server: Grok-in-Codex

Was es kann

Größere Produktarbeit nicht in ein einziges riesiges Rescue packen:

Die Artefakte landen im Projektverzeichnis (gitignore empfohlen): .grok-plans/ .grok-designs/ .grok-reviews/ .grok-docs/ .grok-media/ .grok-workflows/.

Umgebung

• Node.js 18.18+

• Grok Build CLI (grok) im PATH, üblicher Pfad ist ~/.grok/bin/grok

• grok login

• Grok Build ≥ 1.0.5 empfohlen (0.2.118 startet noch; konkrete Flags werden über Capability-Detection geschaltet)

• gh wird nur benötigt, wenn Kommentare auf PRs gepostet werden sollen

Dieses Plugin bringt kein eigenes Modell mit und loggt dich auch nicht bei Grok ein.

Installation

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

Öffne eine neue Codex-Sitzung, damit die MCP-Tools geladen werden. Dann:

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

Oder lass Codex grok_setup aufrufen.

Codex startet das Plugin möglicherweise aus dem Installations-Cache. Übergib bei jedem Tool-Aufruf den echten Projektpfad an cwd, damit Aufgaben und Artefakte in diesem Repository landen:

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

Erste Schritte

Sag direkt in Codex:

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

MCP-Beispiel:

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"

Werkzeugübersicht

Steuerparameter für lange Aufgaben: sandbox (workspace, read-only, strict, devbox, off; der alte Alias workspace-write wird zu workspace normalisiert), planMode / permissionMode, agent, noSubagents, memory / noMemory, allow / deny, disableWebSearch, forkSession, maxTurns.

Ausgerichtet auf Grok CLI 1.0.x: Wenn die CLI kein --check / --best-of-n hat, wird es nicht hart übergeben. check=true wird in den Prompt geschrieben. Schreibaufgaben, die viele Runden nur denken / lesen, ohne Dateien zu schreiben, werden wegen Ausführungsdrift gestoppt.

Wichtige Hinweise zur Nutzung

Rescue — standardmäßig schreibbar. readOnly=true untersucht nur. worktree=true macht Änderungen sicherer.

Plan / Design / Execute — Artefakte landen in .grok-plans/ und .grok-designs/. latest=true wählt das neueste Design. dryRun=true ist nur lesend.

Review — erstellt nie Patches. Mit postPending=true und PR werden nur bei Befunden PENDING-GitHub-Kommentare gepostet.

Media — Dateien werden in .grok-media/ kopiert, damit der Projektpfad-Vertrag eingehalten wird.

Jobs — background=true gibt eine Job-ID zurück. Mehrere Grok-Aufgaben können parallel laufen. Verfolge sie mit grok_status / grok_result / grok_cancel.

CLI-Haltung — Denylist (--disallowed-tools) statt Allowlist. Medien, dry-run / validate-only, babysit list sind alle nur lesend (ohne yolo). Reviews verwenden standardmäßig --sandbox read-only und entfernen keine Shell-Tools (Grok 1.0.x benötigt sie, um Aufgabenergebnisse zu erzeugen).

Umgebungsvariablen

Standard-Statusverzeichnis: ~/.grok/codex-plugin/state/. Wird nicht mit dem Claude-Plugin-Status geteilt.

Aufgabensteuerung

• Kein globales Single-Task-Lock. Lange Aufgaben bevorzugen background=true.

• Der Status folgt dem Text- und Thought-Stream; bei nur leeren Tokens wird weiterhin running angezeigt. Der Status protokolliert auch das zuletzt verwendete Tool und ob ein Schreib-Tool ausgeführt wurde.

• Plan-Ergebnisse ernten bevorzugt plan.md. Abgeschlossene Aufgaben speichern config, usage, artifacts (v3).

• Reaper: pid tot und result.json vollständig → completed; pid tot, aber Ergebnis abgeschnitten → failed (bleibt nicht ewig in running hängen).

• Hintergrund-result.json wird atomar geschrieben (tmp + rename).

• PR-Post-Pending läuft auch bei Hintergrundabschluss; leerer / zu großer Diff schlägt fail-closed fehl, Befunde werden in .grok-reviews/ geschrieben.

Entwicklung

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

Die Versionsnummern in package.json, plugins/grok/.codex-plugin/plugin.json und .agents/plugins/marketplace.json müssen übereinstimmen.

Lizenz

Apache-2.0. Siehe LICENSE und NOTICE.

Dieses Projekt ist abgeleitet von stdevMac/grok-in-codex von stdevMac.