README
Plannotator for Copilot CLI
Interactive plan review, code review, and markdown annotation for GitHub Copilot CLI.
Install
Install the plannotator command:
macOS / Linux / WSL:
curl -fsSL https://plannotator.ai/install.sh | bash
Windows PowerShell:
irm https://plannotator.ai/install.ps1 | iex
Then in Copilot CLI:
/plugin marketplace add backnotprop/plannotator
/plugin install plannotator-copilot@plannotator
Restart Copilot CLI after plugin install. Plan review activates automatically when you use plan mode (Shift+Tab to enter plan mode).
How It Works
Plan Mode Integration
When you use plan mode in Copilot CLI:
- The agent writes
plan.mdto the session state directory - The agent calls
exit_plan_modeto present the plan - The
preToolUsehook intercepts this and opens the Plannotator review UI in your browser - You review the plan, optionally add annotations
- Approve → the plan is accepted and the agent proceeds
- Deny → the agent receives your feedback and revises the plan
Available Commands
| Command | Description |
|---|---|
/plannotator-review | Open interactive code review for current changes or a PR URL |
/plannotator-annotate <file> | Open interactive annotation UI for a markdown file |
/plannotator-last | Annotate the last rendered assistant message |
Environment Variables
| Variable | Description |
|---|---|
PLANNOTATOR_REMOTE | Set to 1 / true for remote mode, 0 / false for local mode, or leave unset for SSH auto-detection. Uses a fixed port in remote mode; browser-opening behavior depends on the environment. |
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. |
PLANNOTATOR_SHARE | Set to disabled to turn off URL sharing. |
Limitations
- Plan mode requires the
plannotatorCLI to be installed and on PATH /plannotator-lastparsesevents.jsonlfrom the Copilot CLI session state directory — format may change between Copilot CLI versions