An agent skill that writes a Guided Review, a chaptered walkthrough of a diff, and exports it as a single portable HTML file.
Share the HTML or use the optional, encrypted, share service:
- (optional) the guide is uploaded to guides.show encrypted; the server can't read it, only people with the link can.
This is also built into Plannotator Code Review
npx skills add plannotator/guidesAlso needs git and the plannotator CLI (the minimal install is enough if you don't use the Plannotator UI):
curl -fsSL https://plannotator.ai/install.sh | bash -s -- --minimalAsk your agent for a guide, walkthrough, or tour of a branch, PR, commit, or uncommitted work. It saves the diff, writes guide.json, runs the export, and gives you the path to the HTML. Open it in any browser, or run the same thing from a PR pipeline with whichever agent you use there.
The guide shape and the full flow are in skills/plannotator-guide/SKILL.md.
The agent reads the diff and writes the guide. The plannotator CLI validates it, adds repo, branch and commit, and writes the HTML:
plannotator guide export --guide guide.json --patch guide.patchFor a link instead of a file:
plannotator guide share --guide guide.json --patch guide.patchThat prints the URL and a delete token. The key is the part of the URL after #, which browsers never send to the server, so guides.show only ever holds encrypted data. --public skips the encryption so chat apps can show a preview. plannotator guide unshare <id> --token <token> removes it. Nothing is uploaded unless you ask for a link.
The code that displays a guide loads from guides.show and never changes out from under a file, so old files keep working. guides.show itself is a small Cloudflare Worker you can run yourself; see apps/guides-show in the Plannotator repo and set PLANNOTATOR_GUIDE_SHARE_URL to your own host.
- Portable guide format: what is in the file, the snapshot format, share links, and guides.show.
- Plannotator: the review tool that generates these guides in-app.