@open-plan-annotator/pi-extension 1.5.1 → 1.5.3

package/README.md

@@ -1,5 +1,112 @@
-# open-plan-annotator Pi Extension
+![](.github/assets/header2.jpg)
 
-Installs the `submit_plan` tool and `/annotate-plan` command for Pi.
+[![npm version](https://img.shields.io/npm/v/open-plan-annotator?style=for-the-badge&labelColor=black&color=black)](https://www.npmjs.com/package/open-plan-annotator)
+[![License: MIT](https://img.shields.io/badge/license-MIT-orange.svg?style=for-the-badge&labelColor=black&color=black)](https://opensource.org/licenses/MIT)
+[![Platform](https://img.shields.io/badge/platform-Linux%20%7C%20macOS-pink?style=for-the-badge&labelColor=black&color=black)]()
 
-This package reuses the main `open-plan-annotator` package for the shared plan review flow.
+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 or OpenCode) 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. Nothing leaves your machine.
+
+![](.github/assets/screenshot.png)
+
+## Install
+
+> [!NOTE]
+> `open-plan-annotator` now ships as one package-managed install. The npm package
+> contains the plugin glue and resolves a platform runtime package locally. There
+> is no first-run binary download and no in-app self-update path.
+
+### Pi
+
+Install the dedicated Pi package:
+
+```sh
+pi install npm:@open-plan-annotator/pi-extension
+```
+
+The extension package registers:
+
+- a `submit_plan` tool, exposed to the model with prompt guidance to call it after drafting a concrete markdown plan and before implementation
+- an `/annotate-plan` command for manual review of the latest assistant message or supplied plan text
+
+Typical flow:
+
+1. Ask Pi to make a plan before coding.
+2. Pi drafts the plan and calls `submit_plan`.
+3. The browser review UI opens locally.
+4. Approval returns “Plan approved. Continue with implementation.”; requested changes return the serialized annotations as feedback.
+
+You can also trigger review manually:
+
+```sh
+/annotate-plan
+/annotate-plan # Plan\n\n1. Do the thing
+```
+
+### Manual Install
+
+If you want to run the CLI standalone or install the package globally:
+
+```sh
+pnpm add -g open-plan-annotator
+npm install -g open-plan-annotator
+```
+
+## Updates
+
+- OpenCode: update the installed npm plugin through OpenCode, then restart OpenCode.
+- Claude Code: update the marketplace/plugin install, then restart Claude Code.
+- Standalone/global install: update the npm package (`npm`, `pnpm`, or `bun`), then rerun `open-plan-annotator`.
+
+The built-in `doctor` command reports the resolved runtime package and runtime path:
+
+```sh
+open-plan-annotator doctor
+```
+
+## 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

package/package.json

@@ -1,11 +1,27 @@
 {
   "name": "@open-plan-annotator/pi-extension",
-  "version": "1.5.1",
+  "version": "1.5.3",
   "type": "module",
-  "description": "Pi extension for open-plan-annotator",
+  "description": "Pi extension for open-plan-annotator that adds plan review tools and commands",
+  "author": "ndom91",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ndom91/open-plan-annotator.git"
+  },
+  "homepage": "https://github.com/ndom91/open-plan-annotator#readme",
+  "bugs": {
+    "url": "https://github.com/ndom91/open-plan-annotator/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
   "keywords": [
-    "pi-package"
+    "pi-package",
+    "pi",
+    "extension",
+    "plan-mode",
+    "annotation"
   ],
   "main": "extensions/index.js",
   "files": [
@@ -13,7 +29,7 @@
     "README.md"
   ],
   "dependencies": {
-    "open-plan-annotator": "1.5.1"
+    "open-plan-annotator": "1.5.3"
   },
   "peerDependencies": {
     "@mariozechner/pi-coding-agent": "*",