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

# Plannotator OSS Documentation

> Install Plannotator, annotate plans and documents, review code changes, and return feedback to your coding agent.

Plannotator is an open-source, local feedback tool for coding agents. It opens plans, Markdown, HTML, local code changes, pull requests, and merge requests in a visual interface, then returns your annotations and feedback to the agent.

The `plannotator` binary runs a temporary server on your computer and opens the session in your browser. Plannotator supports Claude Code, Codex, OpenCode, Copilot CLI, Gemini CLI, Pi, Amp, Droid, and Kiro CLI through host-specific hooks, plugins, commands, or skills.

<CardGroup cols={2}>
  <Card title="Install Plannotator" icon="download" href="/open-source/start/installation" arrow="true">
    Install, update, or remove the binary and connect your coding agent.
  </Card>

  <Card title="Self-host share services" icon="server" href="/open-source/self-hosting" arrow="true">
    Deploy the deprecated OSS share portal and paste service when compatibility requires them.
  </Card>

  <Card title="Install agent skills" icon="sparkles" href="/open-source/start/skills" arrow="true">
    Compare core and extra skills, choose specific skills and hosts, and manage updates.
  </Card>

  <Card title="Annotate a plan or document" icon="play" href="/open-source/start/quickstart" arrow="true">
    Open Markdown, mark what should change, and send feedback to your coding agent.
  </Card>

  <Card title="Review code" icon="code-branch" href="/open-source/workflows/local-changes" arrow="true">
    Review local code changes and return line-specific feedback to your coding agent.
  </Card>

  <Card title="Share a plan or PRD" icon="share-nodes" href="/open-source/workflows/sharing" arrow="true">
    Use the deprecated OSS sharing flow, retained for compatibility, and import returned annotations.
  </Card>

  <Card title="Choose your agent" icon="robot" href="/open-source/agents" arrow="true">
    Set up Claude Code, Codex, OpenCode, Copilot CLI, or another supported agent.
  </Card>

  <Card title="Open Plannotator" icon="terminal" href="/open-source/start/open-plannotator" arrow="true">
    Start it from your coding agent or run it directly.
  </Card>
</CardGroup>

## Plans and documents

Use Plannotator to select text, request deletions, attach comments or images, edit Markdown, and send structured feedback. Plan reviews can also show what changed after the agent revises the plan.

<CardGroup cols={3}>
  <Card title="Plan review" icon="clipboard-check" href="/open-source/workflows/plan-review" arrow="true">
    Review a plan before the agent starts implementation.
  </Card>

  <Card title="Annotate a document" icon="file-lines" href="/open-source/workflows/documents" arrow="true">
    Annotate documents, plain-text config and data files, URLs, and folders.
  </Card>

  <Card title="Open HTML" icon="code" href="/open-source/workflows/html" arrow="true">
    Annotate rendered local HTML and understand its security boundary.
  </Card>
</CardGroup>

## Review code

`plannotator review` opens local Git, Jujutsu, GitButler, or Perforce changes. You can also pass a GitHub pull request or GitLab merge request URL. Plannotator shows the diff, accepts line comments and suggestions, and returns your feedback to the agent session.

<CardGroup cols={2}>
  <Card title="Review local changes" icon="code-branch" href="/open-source/workflows/local-changes" arrow="true">
    Review committed branch work, working-tree changes, and untracked files where the current VCS supports them.
  </Card>

  <Card title="Review a pull request or merge request" icon="git-pull-request" href="/open-source/workflows/pull-requests" arrow="true">
    Open GitHub and GitLab reviews from their URLs and choose local or API-only review.
  </Card>
</CardGroup>

## Where data goes

Normal local sessions bind to `127.0.0.1`. Plannotator stores plans, history, drafts, configuration, and session records under its data directory. This directory is `~/.plannotator` by default. Plannotator uses an absolute `XDG_DATA_HOME` only when `~/.plannotator` does not exist.

<Warning>
  Remote mode binds to `0.0.0.0`. The review UI and local APIs do not add user authentication. Use SSH port forwarding or a trusted private network.
</Warning>

Plannotator OSS does not send usage telemetry or analytics. Its app surfaces check GitHub automatically for the latest release, and a local Git review can contact its configured `origin`. Optional features can contact URL, provider, AI, sharing, or hosted services. See [Privacy and data flow](/open-source/reference/privacy-and-data-flow) for the details.

Plannotator is dual-licensed under [MIT](https://github.com/backnotprop/plannotator/blob/main/LICENSE-MIT) or [Apache 2.0](https://github.com/backnotprop/plannotator/blob/main/LICENSE-APACHE). Source code, releases, and issue tracking are in [`backnotprop/plannotator`](https://github.com/backnotprop/plannotator).

Last verified on July 31, 2026, using Plannotator product commit `7cd023c`. Maintained by the Plannotator project.


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