|
| 1 | +# CC Plugin Codex |
| 2 | + |
| 3 | +Use Claude from inside Codex for code reviews or to delegate tasks to Claude Code. |
| 4 | + |
| 5 | +This repository is the source for the Codex-native Claude Companion plugin bundle. It is meant to be a reverse port of [`openai/codex-plugin-cc`](https://github.com/openai/codex-plugin-cc): the original brings Codex into Claude Code, while this project brings Claude-backed review and delegation workflows into Codex. |
| 6 | + |
| 7 | +The installable plugin bundle lives under [`claude/README.md`](./claude/README.md). |
| 8 | + |
| 9 | +## What You Get |
| 10 | + |
| 11 | +- `$claude-review` for a normal read-only Claude review from Codex |
| 12 | +- `$claude-adversarial-review` for a steerable challenge review |
| 13 | +- `$claude-rescue`, `$claude-status`, `$claude-result`, and `$claude-cancel` to delegate and manage longer-running Claude tasks |
| 14 | +- `$claude-setup` to verify Claude Code readiness and report the current review-gate limitation honestly |
| 15 | + |
| 16 | +## Requirements |
| 17 | + |
| 18 | +- Codex with plugin support |
| 19 | +- Claude Code installed and available as `claude` |
| 20 | +- Node.js 18.18 or later for development and tests |
| 21 | + |
| 22 | +## Install |
| 23 | + |
| 24 | +```bash |
| 25 | +git clone https://github.com/pejmanjohn/cc-plugin-codex.git |
| 26 | +cd cc-plugin-codex |
| 27 | +./scripts/install.sh |
| 28 | +``` |
| 29 | + |
| 30 | +The installer uses Codex's official `plugin/install` backend against this repo's local marketplace file, so you do not need to edit any Codex marketplace configuration by hand. |
| 31 | + |
| 32 | +## Verify |
| 33 | + |
| 34 | +Open Codex: |
| 35 | + |
| 36 | +```bash |
| 37 | +codex |
| 38 | +``` |
| 39 | + |
| 40 | +If you normally use the Codex Mac app and it is already open, restart it instead. |
| 41 | + |
| 42 | +Then start a new thread and run: |
| 43 | + |
| 44 | +```text |
| 45 | +$claude-setup |
| 46 | +``` |
| 47 | + |
| 48 | +After install, you should see the bundled Claude Companion skills in Codex. The full bundle-level usage guide lives in [`claude/README.md`](./claude/README.md). |
| 49 | + |
| 50 | +## Update |
| 51 | + |
| 52 | +```bash |
| 53 | +git pull |
| 54 | +./scripts/install.sh |
| 55 | +``` |
| 56 | + |
| 57 | +## Uninstall |
| 58 | + |
| 59 | +```bash |
| 60 | +./scripts/uninstall.sh |
| 61 | +``` |
| 62 | + |
| 63 | +## Usage |
| 64 | + |
| 65 | +### `$claude-review` |
| 66 | + |
| 67 | +Runs a normal read-only Claude review on your current work or against a base ref. |
| 68 | + |
| 69 | +### `$claude-adversarial-review` |
| 70 | + |
| 71 | +Runs a more skeptical review that questions implementation choices, tradeoffs, and failure modes. |
| 72 | + |
| 73 | +### `$claude-rescue` |
| 74 | + |
| 75 | +Delegates a foreground or background task to Claude and stores durable job state for follow-up. |
| 76 | + |
| 77 | +### `$claude-status`, `$claude-result`, `$claude-cancel` |
| 78 | + |
| 79 | +Shows running and recent jobs, returns the stored final output, or cancels an active background task. |
| 80 | + |
| 81 | +### `$claude-setup` |
| 82 | + |
| 83 | +Checks whether Claude Code is installed and usable, and reports the current stop-time review-gate limitation. |
| 84 | + |
| 85 | +## Current Limitation |
| 86 | + |
| 87 | +The plugin is usable today, but it is not fully functionally equivalent to `openai/codex-plugin-cc`. |
| 88 | + |
| 89 | +The missing piece is the automatic stop-time review gate. Codex supports repo-level and user-level hooks, but validated installed-plugin runs still did not execute bundled plugin hooks after official install, so this plugin reports that limitation honestly instead of pretending the gate works. |
| 90 | + |
| 91 | +## Releases |
| 92 | + |
| 93 | +This repo uses simple tag-based releases. |
| 94 | + |
| 95 | +- Keep [`package.json`](./package.json) and [`claude/.codex-plugin/plugin.json`](./claude/.codex-plugin/plugin.json) on the same semantic version. |
| 96 | +- Create a tag like `v0.1.0`. |
| 97 | +- Push the tag to GitHub. |
| 98 | + |
| 99 | +The release workflow will verify the tag matches both version files, run the Claude plugin test suite, and publish a GitHub release with generated notes. |
| 100 | + |
| 101 | +## Development |
| 102 | + |
| 103 | +```bash |
| 104 | +npm ci |
| 105 | +npm run test:claude |
| 106 | +``` |
| 107 | + |
| 108 | +Helpful files: |
| 109 | + |
| 110 | +- [`claude/README.md`](./claude/README.md) |
| 111 | +- [`claude/.codex-plugin/plugin.json`](./claude/.codex-plugin/plugin.json) |
0 commit comments