DEV Community

sun young
sun young

Posted on

plannotator: a browser review layer for coding agents, now with a Chinese README

plannotator has 13,224 stars on GitHub and is written in TypeScript. It is a local, browser-based review interface that sits between you and a coding agent: the agent proposes a plan, a spec, an HTML artifact, or a finished diff, the page opens in your browser, you annotate it, and the feedback goes back to the agent to act on. The Chinese translation of its README is at https://github.com/yangshun2005/plannotator-cn, published 2026-11-18 under Apache-2.0.

That translation is the reason for this post. The tool is not hard to install, but its documentation is dense and assumes you already know which agent you are wiring up and how. For a Chinese-speaking developer the first twenty minutes are usually spent translating terminology rather than running commands.

What the tool actually does

Three surfaces, described in the original README:

Document and plan review. The agent produces a plan, spec, message, or HTML artifact. plannotator opens it in the browser. You highlight, comment, and send the result back.

Code review. Local changes or remote PRs. Comment on diffs, suggest code, and the comments return to the agent. The README lists Git, GitButler, Jujutsu (jj), Perforce (p4), GitHub, and GitLab as supported. For large changes there is a guided review mode where the agent splits the diff into sections, most important first.

Inbox. A local window where agents leave messages, questions, files, and guided reviews while they keep working. You answer when convenient; nothing blocks the agent session, and replies route back to the session that asked.

The integration is through plugins, hooks, and commands rather than a wrapper CLI you drive by hand. The README names Claude Code, Codex, Copilot CLI, Gemini CLI, OpenCode, Kiro, Droid, Amp, DeepSeek Harness, and Pi as coding agents, plus personal assistants (Grok Bot, Muse, Hermes, OpenClaw) for the Inbox.

The Chinese README adds a section the original does not have

The translated repo keeps the original document intact as a faithful translation and adds a separate section at the top called 中文快速上手 ("quick start for Chinese users"), explicitly marked as supplementary and not part of the original. That split matters: you can trust the body as a translation, and you can use the header as a shortcut.

What the supplement covers that the upstream README leaves implicit:

The minimum path to a running instance. bun install, bun run build, then plannotator inbox. The repo is a Bun workspace monorepo (apps/*, packages/*), and the build scripts are split per sub-application (build:hook, build:review), so a single build command may not produce every artifact. The supplement says this outright.

Two different integration routes. Claude Code, Pi, and OpenCode connect through the plannotator plugin; other agents connect over MCP with plannotator inbox mcp. If you have only read the marketing page you might assume one config works everywhere. It does not.

Annotating a local dev server. plannotator annotate http://localhost:5173 is in the README, but it is easy to miss among the screenshots.

Terminal-side review. herdr plugin install plannotator/herdr-annotate if you would rather stay in the terminal.

A license discrepancy worth checking before commercial use. The project metadata says Apache-2.0, package.json says MIT OR Apache-2.0, and the repo contains both LICENSE-APACHE and LICENSE-MIT. The supplement flags the mismatch instead of picking one.

Where the documentation is silent. Operating system support, hardware requirements, Node version, and the minimum agent versions are all listed as "原文未说明" (not stated in the original) rather than guessed. That is the right call. A translation that invents requirements is worse than one that admits a gap.

The supplement also notes that in mainland China, dependency installs and plugin fetches may need a mirror or accelerated download. Small point, real friction.

Version and install caveats

package.json reports version 0.29.0. The bin field points at bin/plannotator.js, but neither README gives a global install command (npm, brew, or otherwise). The Chinese supplement says this directly and points readers back to the main README body. If you are writing setup instructions for a team, that is the gap you will hit first.

The runtime is Bun: bun.lock, bunfig.toml, and bun run scripts throughout. TypeScript is the main language. You need a local browser for the review UI, which is the whole point of the design.

Who benefits from the translation

If your team already runs Claude Code or Codex and wants a review step before changes land, the English README is workable. If you are evaluating the tool and your working language is Chinese, the translated README removes a layer of interpretation: the distinction between plugin integration and MCP integration, the monorepo build split, the dual license, and the missing install command are all surfaced in the first screen instead of buried.

One hedge: this translation is new, published 2026-11-18, and the repository has no stars yet. I have not run the Chinese quick-start end to end on a clean machine, so treat the command sequence as documentation rather than a verified transcript. Translation errors go to Issues or PRs on the translated repo, per its own note.

The upstream project is at https://github.com/backnotprop/plannotator. The Chinese version is at https://github.com/yangshun2005/plannotator-cn, with the original English README preserved as README_en.md.


Chinese documentation: https://github.com/yangshun2005/plannotator-cn

I'm an independent enterprise AI delivery consultant — private LLM deployment, RAG, agent workflows, AIOps. If your team is stuck somewhere in that stack, my inbox is open.

Top comments (0)