@plannotator/opencode 0.5.0-beta.2 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -30,9 +30,9 @@ Add to your `opencode.json`:
30
30
 
31
31
  Restart OpenCode. The `submit_plan` tool is now available.
32
32
 
33
- > **Existing users:** If you're stuck on an old version, clear the cache and restart:
33
+ > **Existing users:** If you're stuck on an old version, clear both caches and restart:
34
34
  > ```bash
35
- > rm -rf ~/.cache/opencode/node_modules/@plannotator
35
+ > rm -rf ~/.cache/opencode/node_modules/@plannotator ~/.bun/install/cache/@plannotator
36
36
  > ```
37
37
 
38
38
  ## How It Works
@@ -49,6 +49,32 @@ Restart OpenCode. The `submit_plan` tool is now available.
49
49
  - **Private sharing**: Plans and annotations compress into the URL itself—share a link, no accounts or backend required
50
50
  - **Obsidian integration**: Auto-save approved plans to your vault with frontmatter and tags
51
51
 
52
+ ## Environment Variables
53
+
54
+ | Variable | Description |
55
+ |----------|-------------|
56
+ | `PLANNOTATOR_REMOTE` | Set to `1` for remote mode (devcontainer, SSH). Uses fixed port and skips browser open. |
57
+ | `PLANNOTATOR_PORT` | Fixed port to use. Default: random locally, `19432` for remote sessions. |
58
+ | `PLANNOTATOR_BROWSER` | Custom browser to open plans in. macOS: app name or path. Linux/Windows: executable path. |
59
+
60
+ ## Devcontainer / Docker
61
+
62
+ Works in containerized environments. Set the env vars and forward the port:
63
+
64
+ ```json
65
+ {
66
+ "containerEnv": {
67
+ "PLANNOTATOR_REMOTE": "1",
68
+ "PLANNOTATOR_PORT": "9999"
69
+ },
70
+ "forwardPorts": [9999]
71
+ }
72
+ ```
73
+
74
+ Then open `http://localhost:9999` when `submit_plan` is called.
75
+
76
+ See [devcontainer.md](./devcontainer.md) for full setup details.
77
+
52
78
  ## Obsidian Integration
53
79
 
54
80
  Save approved plans directly to your Obsidian vault.
@@ -0,0 +1,6 @@
1
+ ---
2
+ description: Open interactive code review for current changes
3
+ ---
4
+
5
+ The Plannotator Code Review has been triggered. Opening the review UI...
6
+ Acknowledge "Opening code review..." and wait for the user's feedback.