You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -97,14 +97,14 @@ claude --plugin-dir ./apps/hook
97
97
98
98
| Variable | Description |
99
99
|----------|-------------|
100
-
|`PLANNOTATOR_REMOTE`| Set to `1`or`true` for remote mode (devcontainer, SSH). Uses fixed port and skips browser open. |
100
+
|`PLANNOTATOR_REMOTE`| Set to `1`/`true` for remote mode, `0` / `false` for local mode, or leave unset for SSH auto-detection. Uses a fixed port in remote mode; browser-opening behavior depends on the environment. |
101
101
|`PLANNOTATOR_PORT`| Fixed port to use. Default: random locally, `19432` for remote sessions. |
102
102
|`PLANNOTATOR_BROWSER`| Custom browser to open plans in. macOS: app name or path. Linux/Windows: executable path. |
103
103
|`PLANNOTATOR_SHARE`| Set to `disabled` to turn off URL sharing entirely. Default: enabled. |
104
104
|`PLANNOTATOR_SHARE_URL`| Custom base URL for share links (self-hosted portal). Default: `https://share.plannotator.ai`. |
105
105
|`PLANNOTATOR_PASTE_URL`| Base URL of the paste service API for short URL sharing. Default: `https://plannotator-paste.plannotator.workers.dev`. |
106
106
107
-
**Legacy:**`SSH_TTY` and `SSH_CONNECTION` are still detected. Prefer`PLANNOTATOR_REMOTE=1`for explicit control.
107
+
**Legacy:**`SSH_TTY` and `SSH_CONNECTION` are still detected when `PLANNOTATOR_REMOTE` is unset. Set`PLANNOTATOR_REMOTE=1`/ `true` to force remote mode or `0` / `false` to force local mode.
Copy file name to clipboardExpand all lines: apps/codex/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,7 @@ The message opens in the annotation UI where you can highlight text, add comment
50
50
51
51
| Variable | Description |
52
52
|----------|-------------|
53
-
|`PLANNOTATOR_REMOTE`| Set to `1` for remote mode (devcontainer, SSH). Uses fixed port and skips browser open. |
53
+
|`PLANNOTATOR_REMOTE`| Set to `1`/ `true`for remote mode, `0` / `false` for local mode, or leave unset for SSH auto-detection. Uses a fixed port in remote mode; browser-opening behavior depends on the environment. |
54
54
|`PLANNOTATOR_PORT`| Fixed port to use. Default: random locally, `19432` for remote sessions. |
55
55
|`PLANNOTATOR_BROWSER`| Custom browser to open. macOS: app name or path. Linux/Windows: executable path. |
Copy file name to clipboardExpand all lines: apps/copilot/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ When you use plan mode in Copilot CLI:
52
52
53
53
| Variable | Description |
54
54
|----------|-------------|
55
-
|`PLANNOTATOR_REMOTE`| Set to `1` for remote mode (devcontainer, SSH). Uses fixed port and skips browser open. |
55
+
|`PLANNOTATOR_REMOTE`| Set to `1`/ `true`for remote mode, `0` / `false` for local mode, or leave unset for SSH auto-detection. Uses a fixed port in remote mode; browser-opening behavior depends on the environment. |
56
56
|`PLANNOTATOR_PORT`| Fixed port to use. Default: random locally, `19432` for remote sessions. |
57
57
|`PLANNOTATOR_BROWSER`| Custom browser to open. macOS: app name or path. Linux/Windows: executable path. |
58
58
|`PLANNOTATOR_SHARE`| Set to `disabled` to turn off URL sharing. |
Copy file name to clipboardExpand all lines: apps/hook/README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,14 +75,14 @@ When Claude Code calls `ExitPlanMode`, this hook intercepts and:
75
75
76
76
| Variable | Description |
77
77
|----------|-------------|
78
-
|`PLANNOTATOR_REMOTE`| Set to `1` for remote mode (devcontainer, SSH). Uses fixed port and skips browser open. |
78
+
|`PLANNOTATOR_REMOTE`| Set to `1`/ `true`for remote mode, `0` / `false` for local mode, or leave unset for SSH auto-detection. Uses a fixed port in remote mode; browser-opening behavior depends on the environment. |
79
79
|`PLANNOTATOR_PORT`| Fixed port to use. Default: random locally, `19432` for remote sessions. |
80
80
|`PLANNOTATOR_BROWSER`| Custom browser to open plans in. macOS: app name or path. Linux/Windows: executable path. |
81
81
|`PLANNOTATOR_SHARE_URL`| Custom share portal URL for self-hosting. Default: `https://share.plannotator.ai`. |
82
82
83
83
## Remote / Devcontainer Usage
84
84
85
-
When running Claude Code in a remote environment (SSH, devcontainer, WSL), set these environment variables:
85
+
When running Claude Code in a remote environment (SSH, devcontainer, WSL), set `PLANNOTATOR_REMOTE=1` (or `true`) and these environment variables:
86
86
87
87
```bash
88
88
export PLANNOTATOR_REMOTE=1
@@ -91,7 +91,7 @@ export PLANNOTATOR_PORT=9999 # Choose a port you'll forward
91
91
92
92
This tells Plannotator to:
93
93
- Use a fixed port instead of a random one (so you can set up port forwarding)
94
-
-Skip auto-opening the browser (since you'll open it manually on your local machine)
94
+
-Use remote-friendly port/browser handling for forwarded environments
95
95
- Print the URL to the terminal for you to access
96
96
97
97
**Port forwarding in VS Code devcontainers:** The port should be automatically forwarded. Check the "Ports" tab.
Copy file name to clipboardExpand all lines: apps/marketing/src/content/docs/getting-started/configuration.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Plannotator is configured through environment variables and hook/plugin configur
12
12
13
13
| Variable | Default | Description |
14
14
|----------|---------|-------------|
15
-
|`PLANNOTATOR_REMOTE`| auto-detect | Set to `1` or `true` to force remote mode. Uses a fixed port and skips browser auto-open. |
15
+
|`PLANNOTATOR_REMOTE`| auto-detect | Set to `1` or `true` to force remote mode, `0` or `false` to force local mode, or leave unset to auto-detect via `SSH_TTY` / `SSH_CONNECTION`. Uses a fixed port in remote mode; browser-opening behavior depends on the environment. |
16
16
|`PLANNOTATOR_PORT`| random (local) / `19432` (remote) | Fixed server port. Useful for port forwarding in remote environments. |
17
17
|`PLANNOTATOR_BROWSER`| system default | Custom browser or script to open the UI. |
18
18
|`PLANNOTATOR_SHARE`| enabled | Set to `disabled` to turn off URL sharing entirely. |
@@ -65,7 +65,7 @@ Approved and denied plans are saved to `~/.plannotator/plans/` by default. You c
65
65
66
66
## Remote mode
67
67
68
-
When working over SSH, in a devcontainer, or in Docker, set `PLANNOTATOR_REMOTE=1` and `PLANNOTATOR_PORT` to a port you'll forward. See the [remote & devcontainers guide](/docs/guides/remote-and-devcontainers/) for setup instructions.
68
+
When working over SSH, in a devcontainer, or in Docker, set `PLANNOTATOR_REMOTE=1`(or `true`) and `PLANNOTATOR_PORT` to a port you'll forward. Set `PLANNOTATOR_REMOTE=0` / `false` if you need to force local behavior even when SSH env vars are present. See the [remote & devcontainers guide](/docs/guides/remote-and-devcontainers/) for setup instructions.
Copy file name to clipboardExpand all lines: apps/marketing/src/content/docs/guides/remote-and-devcontainers.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,11 @@ sidebar:
6
6
section: "Guides"
7
7
---
8
8
9
-
Plannotator works in remote environments — SSH sessions, VS Code Remote, devcontainers, and Docker. The key difference is that the browser can't auto-open on a headless server, so you need a fixed port and manual URL access.
9
+
Plannotator works in remote environments — SSH sessions, VS Code Remote, devcontainers, and Docker. The key difference is that remote sessions benefit from a fixed port for forwarding, and browser-opening behavior depends on your environment.
10
10
11
11
## Remote mode
12
12
13
-
Set `PLANNOTATOR_REMOTE=1` to enable remote mode:
13
+
Set `PLANNOTATOR_REMOTE=1`(or `true`) to force remote mode:
14
14
15
15
```bash
16
16
export PLANNOTATOR_REMOTE=1
@@ -20,11 +20,11 @@ export PLANNOTATOR_PORT=9999 # Choose a port you'll forward
20
20
Remote mode changes two behaviors:
21
21
22
22
1.**Fixed port** — Uses `PLANNOTATOR_PORT` (default: `19432`) instead of a random port, so you can set up port forwarding once
23
-
2.**No browser auto-open** — Prints the URL to the terminal instead of trying to open a browser
23
+
2.**Browser handling changes** — In headless setups you may need to open the forwarded URL manually instead of relying on browser auto-open
24
24
25
25
### Legacy detection
26
26
27
-
Plannotator also detects `SSH_TTY` and `SSH_CONNECTION` environment variables for automatic remote mode. However,`PLANNOTATOR_REMOTE=1`is preferred for explicit control.
27
+
Plannotator also detects `SSH_TTY` and `SSH_CONNECTION` environment variables for automatic remote mode when `PLANNOTATOR_REMOTE` is unset. Use`PLANNOTATOR_REMOTE=1`/ `true` to force remote mode or `PLANNOTATOR_REMOTE=0` / `false` to force local mode.
28
28
29
29
## VS Code Remote / devcontainers
30
30
@@ -62,7 +62,7 @@ Or forward ad-hoc when connecting:
62
62
ssh -L 9999:localhost:9999 your-server
63
63
```
64
64
65
-
Then open `http://localhost:9999` locally when Plannotator prints the URL.
65
+
Then open `http://localhost:9999` locally if Plannotator does not open a browser for you.
Copy file name to clipboardExpand all lines: apps/marketing/src/content/docs/reference/environment-variables.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ All Plannotator environment variables and their defaults.
12
12
13
13
| Variable | Default | Description |
14
14
|----------|---------|-------------|
15
-
|`PLANNOTATOR_REMOTE`| auto-detect | Set to `1` or `true` to force remote mode. Uses fixed port and skips browser auto-open. |
15
+
|`PLANNOTATOR_REMOTE`| auto-detect | Set to `1` or `true` to force remote mode, `0` or `false` to force local mode, or leave unset to auto-detect via `SSH_TTY` / `SSH_CONNECTION`. Uses a fixed port in remote mode; browser-opening behavior depends on the environment. |
16
16
|`PLANNOTATOR_PORT`| random (local) / `19432` (remote) | Fixed server port. When not set, local sessions use a random port; remote sessions default to `19432`. |
17
17
|`PLANNOTATOR_BROWSER`| system default | Custom browser to open the UI in. macOS: app name or path. Linux/Windows: executable path. Can also be a script. Takes priority over `BROWSER`. Also settable per-invocation with `--browser`. |
18
18
|`BROWSER`| (none) | Standard env var for specifying a browser. VS Code sets this automatically in devcontainers. Used as fallback when `PLANNOTATOR_BROWSER` is not set. |
@@ -46,11 +46,11 @@ When running your own paste service binary, these variables configure it:
46
46
47
47
## Remote mode behavior
48
48
49
-
When `PLANNOTATOR_REMOTE=1` or SSH is detected:
49
+
When remote mode is forced with `PLANNOTATOR_REMOTE=1`/ `true`, or SSH is detected while `PLANNOTATOR_REMOTE` is unset:
50
50
51
51
- Server binds to `PLANNOTATOR_PORT` (default `19432`) instead of a random port
52
-
- Browser auto-open is skipped
53
-
-The URL is printed to stderr for manual access
52
+
- Browser-opening behavior depends on the environment and configured browser handler
53
+
-In headless setups, you may need to open the forwarded URL manually
54
54
55
55
### Legacy SSH detection
56
56
@@ -61,7 +61,7 @@ These environment variables are still detected for backwards compatibility:
61
61
|`SSH_TTY`| Set by SSH when a TTY is allocated |
62
62
|`SSH_CONNECTION`| Set by SSH with connection details |
63
63
64
-
If either is present, Plannotator enables remote mode automatically. Prefer`PLANNOTATOR_REMOTE=1`for explicit control.
64
+
If either is present, Plannotator enables remote mode automatically when `PLANNOTATOR_REMOTE` is unset. Set`PLANNOTATOR_REMOTE=1`/ `true` to force remote mode or `0` / `false` to force local mode.
Copy file name to clipboardExpand all lines: apps/opencode-plugin/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ Restart OpenCode. The `submit_plan` tool is now available.
56
56
57
57
| Variable | Description |
58
58
|----------|-------------|
59
-
| `PLANNOTATOR_REMOTE` | Set to `1` for remote mode (devcontainer, SSH). Uses fixed port and skips browser open. |
59
+
| `PLANNOTATOR_REMOTE` | Set to `1` / `true` for remote mode, `0` / `false` for local mode, or leave unset for SSH auto-detection. Uses a fixed port in remote mode; browser-opening behavior depends on the environment. |
60
60
| `PLANNOTATOR_PORT` | Fixed port to use. Default: random locally, `19432` for remote sessions. |
61
61
| `PLANNOTATOR_BROWSER` | Custom browser to open plans in. macOS: app name or path. Linux/Windows: executable path. |
Copy file name to clipboardExpand all lines: apps/opencode-plugin/devcontainer.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Add these to your `devcontainer.json`:
18
18
19
19
| Variable | Purpose |
20
20
|----------|---------|
21
-
|`PLANNOTATOR_REMOTE=1`|Tells Plannotator not to open a browser (required in containers) |
21
+
|`PLANNOTATOR_REMOTE=1`|Forces remote mode for container-friendly port/browser handling (required in containers) |
22
22
|`PLANNOTATOR_PORT=9999`| Fixed port for the UI (required for port forwarding) |
23
23
24
24
Both are required. Just setting the port isn't enough.
@@ -35,7 +35,7 @@ Ensure port 9999 (or your chosen port) is forwarded to your host. In VS Code dev
35
35
4. Open `http://localhost:9999` in your host browser
36
36
5. Approve or deny the plan
37
37
38
-
**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`.
38
+
**Note:**Browser opening depends on your container/browser setup. If nothing opens automatically, navigate to the forwarded URL manually when you see the agent call `submit_plan`.
39
39
40
40
## OpenCode Web
41
41
@@ -49,7 +49,7 @@ Ensure port 9999 (or your chosen port) is forwarded to your host. In VS Code dev
49
49
50
50
## Legacy Support
51
51
52
-
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.
52
+
If your environment already has `SSH_TTY` or `SSH_CONNECTION` set (common in SSH sessions), Plannotator will detect remote mode automatically when`PLANNOTATOR_REMOTE`is unset. You can also force local mode with `PLANNOTATOR_REMOTE=false` or `0`.
0 commit comments