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

# Annotate Your First Plan

> Annotate a Markdown plan, then open a folder to browse and annotate plans, specs, ADRs, and notes in one Plannotator session.

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.

<Steps>
  <Step title="Create a plan">
    Save this file as `plan.md`:

    ```md theme={null}
    # Add request logging

    1. Add a request ID to the HTTP middleware.
    2. Log the method, path, status, and duration.
    3. Add tests for successful requests.
    ```
  </Step>

  <Step title="Open Plannotator">
    Run:

    ```bash theme={null}
    plannotator annotate plan.md --gate
    ```

    Plannotator starts a temporary local server and opens the document in your browser. `--gate` adds an **Approve** action.
  </Step>

  <Step title="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.
  </Step>

  <Step title="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.
  </Step>

  <Step title="Open a whole folder">
    Point Plannotator at a folder that contains your documents:

    ```bash theme={null}
    plannotator annotate docs/
    ```

    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](/open-source/workflows/folders) for the full workflow.
  </Step>
</Steps>

## 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](/open-source/agents) for the exact behavior.

## Try the other entry points

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

Use `review` inside a version-controlled project. `annotate-last` reads the most recent assistant message for supported agent sessions.

See [Open Plannotator](/open-source/start/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.
