> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plannotator.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Open Plannotator

> Start Plannotator from a supported coding agent or run it directly from the command line.

Start Plannotator from your coding agent when you want feedback returned to that agent. Run the `plannotator` command directly for terminal workflows and automation.

## Start from your coding agent

Choose your agent for its exact setup and commands:

| Agent | Open a plan | Open code changes |
| - | - | - |
| [Claude Code](/open-source/agents/claude-code) | Opens at `ExitPlanMode` | `/plannotator-review` |
| [Codex](/open-source/agents/codex) | Experimental `Stop` hook | `!plannotator review` or `$plannotator-review` |
| [OpenCode](/open-source/agents/opencode) | Planning agents call `submit_plan` | `/plannotator-review` |
| [Copilot CLI](/open-source/agents/copilot-cli) | Opens at `exit_plan_mode` | `/plannotator-review` |
| [Gemini CLI](/open-source/agents/gemini-cli) | Opens before `exit_plan_mode` | `/plannotator-review` |
| [Pi](/open-source/agents/pi) | `/plannotator-plan-mode`, `Ctrl+Alt+P`, or `pi --plan` | `/plannotator-review` |
| [Amp](/open-source/agents/amp) | Manual command | Command palette |
| [Droid](/open-source/agents/droid) | Manual command | `/plannotator-review` |
| [Kiro CLI](/open-source/agents/kiro-cli) | Installed skill or example agent | Installed skill |

Most command-based agents also provide `/plannotator-annotate` for a file or URL and `/plannotator-last` for the latest assistant message. See [Agents](/open-source/agents) to choose an agent, editor, or note app.

## Run it directly

| Command | Current behavior |
| - | - |
| `plannotator review` | Opens local changes from the detected Git, GitButler, Jujutsu, or Perforce project. |
| `plannotator review <URL>` | Opens a GitHub pull request or GitLab merge request. |
| `plannotator annotate <input>` | Opens a supported document, plain-text config or data file, HTML file, web URL, or folder. |
| `plannotator annotate-last` | Opens the latest assistant message from the current supported agent session. |
| `plannotator last` | Short alias for `annotate-last`. |
| `plannotator archive` | Opens saved plan decisions in a read-only browser. |
| `plannotator sessions` | Lists active Plannotator server sessions. |
| `plannotator sessions --open N` | Reopens active session number `N`. |
| `plannotator --help` | Prints the command list. |
| `plannotator --version` | Prints the installed version. |

Local files opened for annotation must be 2 MiB or smaller. Eligible text files selected from a folder receive per-file version history just like supported files opened directly.

Run command-specific help before scripting a workflow:

```bash theme={null}
plannotator review --help
plannotator annotate --help
plannotator annotate-last --help
plannotator sessions --help
```

## Common options

`plannotator review` accepts `--git` or `--gitbutler` to force the provider. Pull request review uses a local checkout by default. Use `--no-local` when you only want the provider diff.

`plannotator annotate` accepts:

* `--markdown` to convert HTML input to Markdown instead of rendering it as HTML
* `--no-jina` to fetch a URL without Jina Reader
* `--gate` to add an approval action
* `--json` to emit a structured decision
* `--hook` to emit hook-native block or pass JSON
* `--require-approval` to make annotations and dismissal exit `1` in a strict `--gate --json` workflow
* `--result-file <path>` to atomically publish the structured result without overwriting an existing file

`--require-approval` and `--result-file` work only with direct `annotate --gate --json` calls. `plannotator annotate-last` accepts `--stdin`, `--gate`, `--json`, and `--hook`.

Running `plannotator` with no arguments is reserved for hook input. It expects JSON on standard input and is not the interactive entry point.

Last verified against Plannotator OSS v0.25.0 on July 27, 2026. Maintained by the Plannotator project.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.