mirror of
https://github.com/backnotprop/plannotator.git
synced 2026-09-14 14:17:26 +08:00
Michael Ramos
3f51dbf72a
* docs: add Codex support documentation Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs(codex): note plan mode not yet supported Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs(codex): move plan mode notice to top Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: note plan mode not yet supported in Codex sections Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: remove redundant Codex description line Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs(codex): lead with supported features Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs(codex): use ! prefix for shell commands Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1.4 KiB
1.4 KiB
Plannotator for Codex
Code review and markdown annotation are supported today. Plan mode is not yet supported — it requires hooks to intercept the agent's plan submission, which Codex does not currently expose.
Install
macOS / Linux / WSL:
curl -fsSL https://plannotator.ai/install.sh | bash
Windows PowerShell:
irm https://plannotator.ai/install.ps1 | iex
Usage
Code Review
Run !plannotator review to open the code review UI for your current changes:
!plannotator review
This captures your git diff, opens a browser with the review UI, and waits for your feedback. When you submit annotations, the feedback is printed to stdout.
Annotate Markdown
Run !plannotator annotate to annotate any markdown file:
!plannotator annotate path/to/file.md
Environment Variables
| Variable | Description |
|---|---|
PLANNOTATOR_REMOTE |
Set to 1 for remote mode (devcontainer, SSH). Uses fixed port and skips browser open. |
PLANNOTATOR_PORT |
Fixed port to use. Default: random locally, 19432 for remote sessions. |
PLANNOTATOR_BROWSER |
Custom browser to open. macOS: app name or path. Linux/Windows: executable path. |