open-plan-annotator
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Badge for your README
Markdown
[](/listings/ndom91--open-plan-annotator)HTML
<a href="/listings/ndom91--open-plan-annotator"><img src="/api/listings/ndom91--open-plan-annotator/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
`open-plan-annotator` is package-managed as a plugin within your harness of choice. The main plugin package then installs the specific local platform runtime it needs for your host (`linux`/`darwin`, `x86_64`/`arm64`, etc). After installing the plugin, your agent will call `open-plan-annotator` autonomously when you ask it to "make a plan" or any similar such comment, including in claude-code specifically as a hook when exiting `PlanMode`. Alternatively, you can call it yourself explicitly via the exposed command. See below for more details.
Claude Code
Install from inside Claude Code:
/plugin marketplace add ndom91/open-plan-annotator /plugin install open-plan-annotator@ndom91-open-plan-annotator
What you get:
- `ExitPlanMode` hook: opens the annotation UI whenever Claude submits a plan - `/annotate-plan [task description]`: asks Claude to draft a plan and send it to the UI - `open-plan-annotator`: runtime command invoked by the hook
Third-party marketplace auto-update is disabled by default in Claude Code. Enable auto-update for the `ndom91-open-plan-annotator` marketplace in the Marketplace UI if you want updates automatically.
OpenCode
Add the plugin to your OpenCode V2 config (`opencode.jsonc` or `.opencode/opencode.jsonc`):
{
"plugins": ["open-plan-annotator@latest"]
}What you get:
- `annotate_plan`: tool the agent calls after drafting a markdown plan - `open-plan-annotator`: runtime command spawned by the plugin - optional implementation-agent handoff after approval
Restart the OpenCode background service after installing or updating so it reloads the package-managed runtime. The package default export is an OpenCode V2 plugin definition with a stable `id` and `setup()` method. It also temporarily exposes `server()` for OpenCode V1.18.29+ compatibility; the two implementations use their respective APIs.
Pi
Install the Pi extension:
pi install npm:@open-plan-annotator/pi-extension
What you get:
- `annotate_plan`: tool the agent calls after drafting a markdown plan - `/annotate-plan [plan markdown]`: command for manually reviewing supplied text or the latest assistant message - `open-plan-annotator`: runtime command used by the extension
Manual review examples:
/annotate-plan /annotate-plan # Plan\n\n1. Do the thing
Manual / CLI
Install globally if you want to run the CLI directly:
bun add -g open-plan-annotator npm install -g open-plan-annotator
This adds the `open-plan-annotator` command. To verify the resolved runtime:
open-plan-annotator doctor
You can also review a Markdown plan directly from disk, which is useful for agents without a native plugin:
open-plan-annotator review /absolute/path/to/plan.md
The command opens the same local review UI and blocks until approval or requested changes. It prints review result JSON to stdout when the user is done.
Generic agent setup instructions are available with:
open-plan-annotator agent-setup open-plan-annotator help agent
Skipping the Annotator
Set `OPEN_PLAN_ANNOTATOR_SKIP_FILE` to a file path. While that file exists, the Claude Code hook exits without a decision and Claude Code shows its native plan approval instead. The file is checked on every hook call, so you can toggle it mid session, for example while continuing a session through Remote Control where the local browser UI is unreachable:
export OPEN_PLAN_ANNOTATOR_SKIP_FILE="$HOME/.open-plan-annotator-skip" touch "$OPEN_PLAN_ANNOTATOR_SKIP_FILE" # use native approval rm "$OPEN_PLAN_ANNOTATOR_SKIP_FILE" # back to the annotator
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
.claude-plugin/marketplace.json · Manifest · 30 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
- {
- "name": "open-plan-annotator",
- "owner": {
- "name": "ndom91"
- },
- "metadata": {
- "description": "Interactive plan annotation plugin for Claude Code",
- "version": "1.13.2"
- },
- "plugins": [
- {
- "name": "open-plan-annotator",
- "source": "./",
- "description": "Interactive plan annotation UI: review, strikethrough, and comment on Claude's plans before approving. Fully local, no external services.",
- "version": "1.13.2",
- "author": {
- "name": "ndom91"
- },
- "homepage": "https://github.com/ndom91/open-plan-annotator",
- "license": "MIT",
- "keywords": [
- "planning",
- "review",
- "hooks",
- "ExitPlanMode",
- "annotations"
- ]
- }
- ]
- }
README.md · README · 167 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
- # open-plan-annotator
- [](https://www.npmjs.com/package/open-plan-annotator)
- [](https://opensource.org/licenses/MIT)
- []()
- A fully local agentic coding plugin that intercepts plan mode and opens an annotation UI in your browser. Mark up the plan, send structured feedback to the agent, and receive a revised version — iterate as many times as you need until you're ready to approve.
- Select text to <code>strikethrough</code>, <code>replace</code>, <code>insert</code>, or <code>comment</code> — then approve the plan or request changes
- ## How It Works
- 1. Your coding agent (Claude Code, OpenCode, and pi) finishes writing a plan
- 2. The plugin launches an ephemeral HTTP server and opens a React UI in your browser
- 3. You review the plan and annotate it — strikethrough, replace, insert, or comment on any section
- 4. **Approve** to let the agent proceed, or **Request Changes** to send your annotations back as structured feedback
- 5. The agent revises the plan and the cycle repeats until you're satisfied
- Everything runs locally.
- 
- ## Install
- `open-plan-annotator` is package-managed as a plugin within your harness of choice. The main plugin package then installs the specific local platform runtime it needs for your host (`linux`/`darwin`, `x86_64`/`arm64`, etc). After installing the plugin, your agent will call `open-plan-annotator` autonomously when you ask it to "make a plan" or any similar such comment, including in claude-code specifically as a hook when exiting `PlanMode`. Alternatively, you can call it yourself explicitly via the exposed command. See below for more details.
- ### Claude Code
- Install from inside Claude Code:
- ```
- /plugin marketplace add ndom91/open-plan-annotator
- /plugin install open-plan-annotator@ndom91-open-plan-annotator
- ```
- What you get:
- - `ExitPlanMode` hook: opens the annotation UI whenever Claude submits a plan
- - `/annotate-plan [task description]`: asks Claude to draft a plan and send it to the UI
- - `open-plan-annotator`: runtime command invoked by the hook
- Third-party marketplace auto-update is disabled by default in Claude Code. Enable auto-update for the `ndom91-open-plan-annotator` marketplace in the Marketplace UI if you want updates automatically.
- ### OpenCode
- Add the plugin to your OpenCode V2 config (`opencode.jsonc` or `.opencode/opencode.jsonc`):
- ```jsonc
- {
- "plugins": ["open-plan-annotator@latest"]
- }
- ```
- What you get:
- - `annotate_plan`: tool the agent calls after drafting a markdown plan
- - `open-plan-annotator`: runtime command spawned by the plugin
- - optional implementation-agent handoff after approval
- Restart the OpenCode background service after installing or updating so it reloads the package-managed runtime.
- The package default export is an OpenCode V2 plugin definition with a stable
- `id` and `setup()` method. It also temporarily exposes `server()` for OpenCode
- V1.18.29+ compatibility; the two implementations use their respective APIs.
- ### Pi
- Install the Pi extension:
- ```sh
- pi install npm:@open-plan-annotator/pi-extension
- ```
- What you get:
- - `annotate_plan`: tool the agent calls after drafting a markdown plan
- - `/annotate-plan [plan markdown]`: command for manually reviewing supplied text or the latest assistant message
- - `open-plan-annotator`: runtime command used by the extension
- Manual review examples:
- ```sh
- /annotate-plan
- /annotate-plan # Plan\n\n1. Do the thing
- ```
- ### Manual / CLI
- Install globally if you want to run the CLI directly:
- ```sh
- bun add -g open-plan-annotator
- npm install -g open-plan-annotator
- ```
- This adds the `open-plan-annotator` command. To verify the resolved runtime:
- ```sh
- open-plan-annotator doctor
- ```
- You can also review a Markdown plan directly from disk, which is useful for agents without a native plugin:
- ```sh
- open-plan-annotator review /absolute/path/to/plan.md
- ```
- The command opens the same local review UI and blocks until approval or requested changes. It prints review result JSON to stdout when the user is done.
- Generic agent setup instructions are available with:
- ```sh
- open-plan-annotator agent-setup
- open-plan-annotator help agent
- ```
- ### Skipping the Annotator
- Set `OPEN_PLAN_ANNOTATOR_SKIP_FILE` to a file path. While that file exists, the Claude Code hook exits without a decision and Claude Code shows its native plan approval instead. The file is checked on every hook call, so you can toggle it mid session, for example while continuing a session through Remote Control where the local browser UI is unreachable:
- ```sh
- export OPEN_PLAN_ANNOTATOR_SKIP_FILE="$HOME/.open-plan-annotator-skip"
- touch "$OPEN_PLAN_ANNOTATOR_SKIP_FILE" # use native approval
- rm "$OPEN_PLAN_ANNOTATOR_SKIP_FILE" # back to the annotator
- ```
- ## Updates
- - **Claude Code**: navigate to the `/plugin` -> "Installed" -> `open-plan-annotator` entry and select "Update", then restart Claude Code.
- - **OpenCode**: bump the version number in your `opencode.jsonc` `plugins` `open-plan-annotator` entry, then restart the OpenCode service.
- - **Pi**: update the Pi extension, then restart Pi.
- - **Manual/global install**: update the npm package, then rerun `open-plan-annotator`.
- ## Keyboard Shortcuts
- | Action | Shortcut | Description |
- |--------|----------|-------------|
- | Delete | `d` | Strikethrough selected text |
- | Replace | `r` | Replace selected text with new content |
- | Insert | `s` | Insert text after the selection |
- | Comment | `c` | Attach a comment to selected text |
- | Approve | `Cmd+Enter` | Approve the plan and proceed |
- | Request Changes | `Cmd+Shift+Enter` | Send annotations back to the agent |
- ## Development
- ```sh
- bun run dev
- ```
- Starts the Bun server on port 3847 with a test plan and the Vite dev server on port 5173 with HMR.
- ```sh
- bun run lint # check
- bun run lint:fix # auto-fix
- bun run format # format
- ```
- ## Maintainer Docs
- - Architecture: [`docs/architecture.md`](docs/architecture.md)
- - Operations: [`docs/operations.md`](docs/operations.md)
- - Release process: [`docs/release.md`](docs/release.md)
- ## License
- MIT
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.