Skip to main content
This quickstart shows two flows: annotate one Markdown plan, then open a folder and move between files in Plannotator’s file browser. The first file checks your installation without depending on an agent hook.
1

Create a plan

Save this file as plan.md:
2

Open Plannotator

Run:
Plannotator starts a temporary local server and opens the document in your browser. --gate adds an Approve action.
3

Comment on exact text

Select Add tests for successful requests and add this comment:
Include a failed request so the test covers the error status and request ID.
The comment remains attached to the selected text.
4

Send the feedback

Select Send Feedback. A direct terminal run writes the feedback to standard output.Run the command again and select Approve to check the approval path.
5

Open a whole folder

Point Plannotator at a folder that contains your documents:
Plannotator opens a file browser for supported Markdown, MDX, text, and HTML files. Open a file, annotate it, then choose another file without starting a new session. Try this with a documentation folder or a local knowledge base that contains plans, specifications, ADRs, and notes. See Annotate a Folder for the full workflow.

​
Try it inside your agent

After completing the setup for your host, use its manual review command:
  • Most command-based agents use /plannotator-annotate plan.md.
  • Codex can run !plannotator annotate plan.md or use $plannotator-annotate.
  • Amp exposes Plannotator: Annotate file in its command palette.
Agent plan review is host-specific. Claude Code, Copilot CLI, Gemini CLI, OpenCode, Pi, and Codex provide automatic or plan-mode review flows. Amp, Droid, and Kiro CLI use manual commands. See Agents for the exact behavior.

​
Try the other entry points

Use review inside a version-controlled project. annotate-last reads the most recent assistant message for supported agent sessions. See Open Plannotator for the complete user-facing command list. Last verified against Plannotator OSS v0.23.1 on July 18, 2026. Maintained by the Plannotator project.
Last modified on July 19, 2026