← Back to Plugins
Tools

Plannotator Openclaw

deanmoore1696-ops By deanmoore1696-ops 👁 53 views ▲ 0 votes

OpenClaw plugin for Plannotator โ€” interactive plan and code review for AI coding agents

GitHub

Install

openclaw plugins install --link

Configuration Example

{
  "plannotator": {
    "autoInstall": true,          // auto-install CLI if not found
    "browser": "Google Chrome",   // browser to open (macOS app name or executable path)
    "remoteMode": false,          // enable for SSH / devcontainer / WSL
    "port": 19432,                // fixed port for remote mode
    "shareUrl": "...",            // custom share portal URL for self-hosting
    "pasteUrl": "..."             // custom paste service URL
  }
}

README

# Plannotator Plugin for OpenClaw

Interactive plan and code review for AI coding agents โ€” built as an OpenClaw plugin.

## What it does

Registers 4 tools in OpenClaw that pipe through the [Plannotator CLI](https://plannotator.ai):

| Tool | What it does |
|------|-------------|
| `plannotator_plan` | Submit your implementation plan for human review before execution |
| `plannotator_review` | Open code review UI for the current git diff or a GitHub PR |
| `plannotator_annotate` | Annotate any file, folder, URL, or markdown document |
| `plannotator_last` | Annotate the agent's most recent message |

When a tool is called, Plannotator opens in your browser. You annotate text visually โ€” delete, replace, comment โ€” then Approve or Request Changes. Structured feedback flows back to the agent.

## Installation

Requires plannotator CLI to be installed:

```bash
curl -fsSL https://plannotator.ai/install.sh | bash
```

Then link the plugin:

```bash
openclaw plugins install --link ./path/to/plannotator-openclaw --dangerously-force-unsafe-install
openclaw gateway restart
```

> Note: `--dangerously-force-unsafe-install` is required because the plugin spawns a CLI subprocess (inherent to how Plannotator works).

## Configuration

In `plugins.entries.plannotator` (in your OpenClaw config):

```json
{
  "plannotator": {
    "autoInstall": true,          // auto-install CLI if not found
    "browser": "Google Chrome",   // browser to open (macOS app name or executable path)
    "remoteMode": false,          // enable for SSH / devcontainer / WSL
    "port": 19432,                // fixed port for remote mode
    "shareUrl": "...",            // custom share portal URL for self-hosting
    "pasteUrl": "..."             // custom paste service URL
  }
}
```

## How it works

1. **Tool called** โ†’ spawns `plannotator` CLI subprocess in background
2. **CLI starts local HTTP server** + opens your browser with the Plannotator UI
3. **You annotate** (delete, replace, comment) and click Approve or Request Changes
4. **Tool returns** structured feedback to the agent

Plans are encrypted end-to-end when shared via URL โ€” zero-knowledge storage. Small plans are encoded entirely in the URL hash (no server storage).

## Files

```
plannotator-openclaw/
โ”œโ”€โ”€ openclaw.plugin.json    # Plugin manifest
โ”œโ”€โ”€ package.json            # npm package metadata
โ”œโ”€โ”€ dist/
โ”‚   โ”œโ”€โ”€ index.js            # Plugin entry point
โ”‚   โ”œโ”€โ”€ plannotator-cli.js  # CLI detection / install / spawn
โ”‚   โ””โ”€โ”€ tools/
โ”‚       โ”œโ”€โ”€ plan-review.js
โ”‚       โ”œโ”€โ”€ code-review.js
โ”‚       โ”œโ”€โ”€ annotate.js
โ”‚       โ””โ”€โ”€ last-message.js
โ””โ”€โ”€ skills/
    โ””โ”€โ”€ plannotator/
        โ””โ”€โ”€ SKILL.md        # Agent skill documentation
```

## Publishing to ClawHub / npm

```bash
# Publish to npm
npm publish --access public

# Then install via OpenClaw
openclaw plugins install @your-scope/plannotator-plugin
```

## License

Apache-2.0 / MIT (same as Plannotator itself)
tools

Comments

Sign in to leave a comment

Loading comments...