Files
backnotprop__plannotator/apps/opencode-plugin/README.md
T

73 lines
2.4 KiB
Markdown
Raw Normal View History

# @plannotator/opencode
**Annotate plans. Not in the terminal.**
Interactive Plan Review for OpenCode. Select the exact parts of the plan you want to change—mark for deletion, add a comment, or suggest a replacement. Feedback flows back to your agent automatically.
Feat/save to obsidian (#11) * Add Obsidian integration for auto-saving approved plans - Auto-detect Obsidian vaults from system config - Settings UI with vault dropdown and folder config - Save plans with YAML frontmatter (created, source, tags) - Extract tags heuristically from H1 title and code fence languages - Human-readable filenames: "Title - Jan 2, 2026 2-30pm.md" - Cross-platform support (macOS, Windows, Linux) - Add local test script for hook simulation * Add backlinks and improve filename generation - Add [[Plannotator Plans]] backlink to saved notes for graph connectivity - Extract title from H1 for human-readable filenames - Format: "Title - Jan 2, 2026 2-30pm.md" - Add bulk test script for ~/.claude/plans - Add fix script to add backlinks to existing vault files * Add Obsidian integration docs to README, landing page, and plugins - Root README: Quick note about Obsidian support after video table - apps/hook README: Detailed setup and example file format - apps/opencode-plugin README: Feature list and setup instructions - Landing page: New "Save to Obsidian" feature card Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Add Obsidian Integration section to README * Screenshot Obsidian settings Added an implementation plan section for user authentication. * Update README with Obsidian auto-save feature Added information about auto-saving approved plans to Obsidian. * Update README with Obsidian integration link Added link to details about Obsidian integration. * Update README to include Obsidian auto-saving feature Clarified the new feature for saving to Obsidian with a link. ---------
2026-01-02 11:08:19 -08:00
Obsidian users can auto-save approved plans to Obsidian as well. [See details](#obsidian-integration)
<table>
<tr>
<td align="center">
<strong>Watch Demo</strong><br><br>
<a href="https://youtu.be/_N7uo0EFI-U">
<img src="https://img.youtube.com/vi/_N7uo0EFI-U/maxresdefault.jpg" alt="Watch Demo" width="600" />
</a>
</td>
</tr>
</table>
## Install
Add to your `opencode.json`:
```json
{
"$schema": "https://opencode.ai/config.json",
"plugin": ["@plannotator/opencode@latest"]
}
```
Restart OpenCode. The `submit_plan` tool is now available.
> **Note:** Use `@latest` to ensure you always get the newest version. Without it, OpenCode may cache an older version.
## How It Works
1. Agent calls `submit_plan` → Plannotator opens in your browser
2. Select text → annotate (delete, replace, comment)
3. **Approve** → Agent proceeds with implementation
4. **Request changes** → Annotations sent back as structured feedback
## Features
- **Visual annotations**: Select text, choose an action, see feedback in the sidebar
- **Runs locally**: No network requests. Plans never leave your machine.
- **Private sharing**: Plans and annotations compress into the URL itself—share a link, no accounts or backend required
Feat/save to obsidian (#11) * Add Obsidian integration for auto-saving approved plans - Auto-detect Obsidian vaults from system config - Settings UI with vault dropdown and folder config - Save plans with YAML frontmatter (created, source, tags) - Extract tags heuristically from H1 title and code fence languages - Human-readable filenames: "Title - Jan 2, 2026 2-30pm.md" - Cross-platform support (macOS, Windows, Linux) - Add local test script for hook simulation * Add backlinks and improve filename generation - Add [[Plannotator Plans]] backlink to saved notes for graph connectivity - Extract title from H1 for human-readable filenames - Format: "Title - Jan 2, 2026 2-30pm.md" - Add bulk test script for ~/.claude/plans - Add fix script to add backlinks to existing vault files * Add Obsidian integration docs to README, landing page, and plugins - Root README: Quick note about Obsidian support after video table - apps/hook README: Detailed setup and example file format - apps/opencode-plugin README: Feature list and setup instructions - Landing page: New "Save to Obsidian" feature card Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Add Obsidian Integration section to README * Screenshot Obsidian settings Added an implementation plan section for user authentication. * Update README with Obsidian auto-save feature Added information about auto-saving approved plans to Obsidian. * Update README with Obsidian integration link Added link to details about Obsidian integration. * Update README to include Obsidian auto-saving feature Clarified the new feature for saving to Obsidian with a link. ---------
2026-01-02 11:08:19 -08:00
- **Obsidian integration**: Auto-save approved plans to your vault with frontmatter and tags
## Obsidian Integration
Save approved plans directly to your Obsidian vault.
1. Open Settings in Plannotator UI
2. Enable "Obsidian Integration" and select your vault
3. Approved plans save automatically with:
- Human-readable filenames: `Title - Jan 2, 2026 2-30pm.md`
- YAML frontmatter (`created`, `source`, `tags`)
- Auto-extracted tags from plan title and code languages
- Backlink to `[[Plannotator Plans]]` for graph view
<img width="1190" height="730" alt="image" src="https://github.com/user-attachments/assets/5036a3ea-e5e8-426c-882d-0a1d991c1625" />
## Links
- [Website](https://plannotator.ai)
- [GitHub](https://github.com/backnotprop/plannotator)
- [Claude Code Plugin](https://github.com/backnotprop/plannotator/tree/main/apps/hook)
## License
Copyright (c) 2025 backnotprop. Licensed under [BSL-1.1](https://github.com/backnotprop/plannotator/blob/main/LICENSE).