Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# Plannotator

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**.
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**.

<table>
<tr>
Expand Down Expand Up @@ -55,6 +55,7 @@ Plannotator lets you privately share plans, annotations, and feedback with colle
- [Claude Code](#install-for-claude-code)
- [OpenCode](#install-for-opencode)
- [Pi](#install-for-pi)
- [Codex](#install-for-codex)

## Install for Claude Code

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

---

## Install for Codex

**Install the `plannotator` command:**

**macOS / Linux / WSL:**

```bash
curl -fsSL https://plannotator.ai/install.sh | bash
```

**Windows PowerShell:**

```powershell
irm https://plannotator.ai/install.ps1 | iex
```

**Then in Codex, run directly:**

```
!plannotator review # Code review for current changes
!plannotator annotate file.md # Annotate a markdown file
```

Plan mode is not yet supported.

See [apps/codex/README.md](apps/codex/README.md) for details.

---

## How It Works

When your AI agent finishes planning, Plannotator:
Expand Down
51 changes: 51 additions & 0 deletions apps/codex/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# 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:**

```bash
curl -fsSL https://plannotator.ai/install.sh | bash
```

**Windows PowerShell:**

```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. |

## Links

- [Website](https://plannotator.ai)
- [GitHub](https://github.com/backnotprop/plannotator)
- [Docs](https://plannotator.ai/docs/getting-started/installation/)
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,11 @@ Coming soon.

## Codex

Coming soon.
Plan mode is not yet supported.

Install the binary, then use it directly:

```
!plannotator review # Code review for current changes
!plannotator annotate file.md # Annotate a markdown file
```