mirror of https://github.com/backnotprop/plannotator.git synced 2026-09-14 14:17:26 +08:00

Files

T

Michael Ramos b1883d38e8 fix(opencode): include HTML files in npm package

The `files` array in package.json was missing plannotator.html and
review-editor.html, causing them to be omitted from npm publishes.
This explains why users were stuck on old versions.

Also fixes incorrect cache path in docs and install script.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

2026-01-15 10:04:26 -08:00

1.9 KiB

Raw Blame History

Devcontainer / Docker Setup

Plannotator works in devcontainers and Docker environments with minimal configuration.

Required Environment Variables

Add these to your devcontainer.json:

{
  "containerEnv": {
    "PLANNOTATOR_REMOTE": "1",
    "PLANNOTATOR_PORT": "9999"
  },
  "forwardPorts": [9999]
}

Variable	Purpose
`PLANNOTATOR_REMOTE=1`	Tells Plannotator not to open a browser (required in containers)
`PLANNOTATOR_PORT=9999`	Fixed port for the UI (required for port forwarding)

Both are required. Just setting the port isn't enough.

Port Forwarding

Ensure port 9999 (or your chosen port) is forwarded to your host. In VS Code devcontainers, add it to forwardPorts as shown above.

Usage

Run OpenCode in your container (opencode or opencode web)
Ask the agent to create a plan
When submit_plan is called, Plannotator starts on port 9999
Open http://localhost:9999 in your host browser
Approve or deny the plan

Note: There's no browser auto-open or notification in remote mode. You'll need to manually navigate to the URL when you see the agent call submit_plan.

OpenCode Web

opencode web works in devcontainers. Forward port 4096 (default) for the OpenCode UI, and port 9999 for Plannotator:

{
  "forwardPorts": [4096, 9999]
}

Legacy Support

If your environment already has SSH_TTY or SSH_CONNECTION set (common in SSH sessions), Plannotator will detect remote mode automatically. The PLANNOTATOR_REMOTE env var is preferred for Docker/devcontainer setups where those aren't present.

Troubleshooting

Plugin not updating?

rm -rf ~/.bun/install/cache/@plannotator

OpenCode crashes on startup?

rm -rf ~/.cache/opencode ~/.bun/install/cache/@opencode-ai

Port not accessible? Check your devcontainer's port forwarding. In VS Code, check the "Ports" tab.

1.9 KiB Raw Blame History