@plannotator/pi-extension
v0.9.2
Published
Plannotator extension for Pi coding agent - interactive plan review with visual annotation
Downloads
503
Maintainers
Readme
Plannotator for Pi
Plannotator integration for the Pi coding agent. Adds file-based plan mode with a visual browser UI for reviewing, annotating, and approving agent plans.
Install
From npm (recommended):
pi install npm:@plannotator/pi-extensionFrom source:
git clone https://github.com/backnotprop/plannotator.git
pi install ./plannotator/apps/pi-extensionTry without installing:
pi -e npm:@plannotator/pi-extensionBuild from source
If installing from a local clone, build the HTML assets first:
cd plannotator
bun install
bun run build:piThis builds the plan review and code review UIs and copies them into apps/pi-extension/.
Usage
Plan mode
Start Pi in plan mode:
pi --planOr toggle it during a session with /plannotator or Ctrl+Alt+P.
In plan mode the agent is restricted to read-only tools. It explores your codebase, then writes a plan to PLAN.md using markdown checklists:
- [ ] Add validation to the login form
- [ ] Write tests for the new validation logic
- [ ] Update error messages in the UIWhen the agent calls exit_plan_mode, the Plannotator UI opens in your browser. You can:
- Approve the plan to begin execution
- Deny with annotations to send structured feedback back to the agent
- Approve with notes to proceed but include implementation guidance
The agent iterates on the plan until you approve, then executes with full tool access. On resubmission, Plan Diff highlights what changed since the previous version.
Code review
Run /plannotator-review to open your current git changes in the code review UI. Annotate specific lines, switch between diff views (uncommitted, staged, last commit, branch), and submit feedback that gets sent to the agent.
Markdown annotation
Run /plannotator-annotate <file.md> to open any markdown file in the annotation UI. Useful for reviewing documentation or design specs with the agent.
Progress tracking
During execution, the agent marks completed steps with [DONE:n] markers. Progress is shown in the status line and as a checklist widget in the terminal.
Commands
| Command | Description |
|---------|-------------|
| /plannotator | Toggle plan mode on/off |
| /plannotator-status | Show current phase, plan file, and progress |
| /plannotator-review | Open code review UI for current changes |
| /plannotator-annotate <file> | Open markdown file in annotation UI |
Flags
| Flag | Description |
|------|-------------|
| --plan | Start in plan mode |
| --plan-file <path> | Custom plan file path (default: PLAN.md) |
Keyboard shortcuts
| Shortcut | Description |
|----------|-------------|
| Ctrl+Alt+P | Toggle plan mode |
How it works
The extension manages a state machine: idle → planning → executing → idle.
During planning:
- Tools restricted to:
read,bash(read-only commands only),grep,find,ls,write(plan file only),exit_plan_mode editis disabled, bash is gated to a read-only allowlist, writes only allowed to the plan file
During executing:
- Full tool access:
read,bash,edit,write - Progress tracked via
[DONE:n]markers in agent responses - Plan re-read from disk each turn to stay current
State persists across session restarts via Pi's appendEntry API.
Requirements
- Pi >= 0.53.0
