Skip to content

Commit 3f51dbf

Browse files
backnotpropclaude
andauthored
docs: add Codex support (#261)
* 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 parent bd8268d commit 3f51dbf

File tree

3 files changed

+90
-2
lines changed

3 files changed

+90
-2
lines changed

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# Plannotator
66

7-
Interactive Plan Review for AI Coding Agents. Mark up and refine your plans using a visual UI, share for team collaboration, and seamlessly integrate with **Claude Code**, **OpenCode**, and **Pi**.
7+
Interactive Plan Review for AI Coding Agents. Mark up and refine your plans using a visual UI, share for team collaboration, and seamlessly integrate with **Claude Code**, **OpenCode**, **Pi**, and **Codex**.
88

99
<table>
1010
<tr>
@@ -55,6 +55,7 @@ Plannotator lets you privately share plans, annotations, and feedback with colle
5555
- [Claude Code](#install-for-claude-code)
5656
- [OpenCode](#install-for-opencode)
5757
- [Pi](#install-for-pi)
58+
- [Codex](#install-for-codex)
5859

5960
## Install for Claude Code
6061

@@ -122,6 +123,35 @@ See [apps/pi-extension/README.md](apps/pi-extension/README.md) for full usage de
122123

123124
---
124125

126+
## Install for Codex
127+
128+
**Install the `plannotator` command:**
129+
130+
**macOS / Linux / WSL:**
131+
132+
```bash
133+
curl -fsSL https://plannotator.ai/install.sh | bash
134+
```
135+
136+
**Windows PowerShell:**
137+
138+
```powershell
139+
irm https://plannotator.ai/install.ps1 | iex
140+
```
141+
142+
**Then in Codex, run directly:**
143+
144+
```
145+
!plannotator review # Code review for current changes
146+
!plannotator annotate file.md # Annotate a markdown file
147+
```
148+
149+
Plan mode is not yet supported.
150+
151+
See [apps/codex/README.md](apps/codex/README.md) for details.
152+
153+
---
154+
125155
## How It Works
126156

127157
When your AI agent finishes planning, Plannotator:

apps/codex/README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Plannotator for Codex
2+
3+
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.
4+
5+
## Install
6+
7+
**macOS / Linux / WSL:**
8+
9+
```bash
10+
curl -fsSL https://plannotator.ai/install.sh | bash
11+
```
12+
13+
**Windows PowerShell:**
14+
15+
```powershell
16+
irm https://plannotator.ai/install.ps1 | iex
17+
```
18+
19+
## Usage
20+
21+
### Code Review
22+
23+
Run `!plannotator review` to open the code review UI for your current changes:
24+
25+
```
26+
!plannotator review
27+
```
28+
29+
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.
30+
31+
### Annotate Markdown
32+
33+
Run `!plannotator annotate` to annotate any markdown file:
34+
35+
```
36+
!plannotator annotate path/to/file.md
37+
```
38+
39+
## Environment Variables
40+
41+
| Variable | Description |
42+
|----------|-------------|
43+
| `PLANNOTATOR_REMOTE` | Set to `1` for remote mode (devcontainer, SSH). Uses fixed port and skips browser open. |
44+
| `PLANNOTATOR_PORT` | Fixed port to use. Default: random locally, `19432` for remote sessions. |
45+
| `PLANNOTATOR_BROWSER` | Custom browser to open. macOS: app name or path. Linux/Windows: executable path. |
46+
47+
## Links
48+
49+
- [Website](https://plannotator.ai)
50+
- [GitHub](https://github.com/backnotprop/plannotator)
51+
- [Docs](https://plannotator.ai/docs/getting-started/installation/)

apps/marketing/src/content/docs/getting-started/installation.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,4 +101,11 @@ Coming soon.
101101

102102
## Codex
103103

104-
Coming soon.
104+
Plan mode is not yet supported.
105+
106+
Install the binary, then use it directly:
107+
108+
```
109+
!plannotator review # Code review for current changes
110+
!plannotator annotate file.md # Annotate a markdown file
111+
```

0 commit comments

Comments
 (0)