> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plannotator.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Plannotator environment variables

> Runtime, browser, remote-session, sharing, installer, and agent environment variables supported by Plannotator.

Use environment variables when a setting belongs to a shell, remote machine, or agent. Values set for one command affect only that run:

```bash theme={null}
PLANNOTATOR_PORT=19432 plannotator review
```

## Session and browser

| Variable                     | Accepted value and behavior                                                                                                                                               |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PLANNOTATOR_REMOTE`         | `1` or `true` forces remote mode. `0` or `false` forces local mode. If unset, Plannotator detects SSH from `SSH_TTY` or `SSH_CONNECTION`.                                 |
| `PLANNOTATOR_PORT`           | A fixed port such as `19432`, or an inclusive range such as `19432-19463`. The default is a random available port locally and `19432` remotely.                           |
| `PLANNOTATOR_BROWSER`        | Browser app name or path on macOS, or an executable on Linux and Windows. The CLI `--browser` flag takes precedence.                                                      |
| `BROWSER`                    | Fallback browser command when `PLANNOTATOR_BROWSER` is unset. Values commonly used to suppress opening, including `none`, `false`, `0`, and `:`, do not launch a browser. |
| `PLANNOTATOR_GLIMPSE`        | `1` or `true` enables the Glimpse window when available. Other values disable it. The default is enabled.                                                                 |
| `PLANNOTATOR_GLIMPSE_WIDTH`  | Initial Glimpse window width. Default: `1280`.                                                                                                                            |
| `PLANNOTATOR_GLIMPSE_HEIGHT` | Initial Glimpse window height. Default: `900`.                                                                                                                            |

Remote mode binds the unauthenticated local server to `0.0.0.0`. Forward it through SSH or your development environment and do not expose that port to an untrusted network. See [Troubleshooting](/open-source/troubleshooting#remote-ssh-and-development-containers).

## Annotation, history, and sharing

| Variable                       | Accepted value and behavior                                                                                                                   |
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `PLANNOTATOR_JINA`             | `1` or `true` uses Jina Reader for URL annotation. Other values use direct fetch and local conversion. The `--no-jina` flag takes precedence. |
| `JINA_API_KEY`                 | Optional bearer token sent to Jina Reader.                                                                                                    |
| `PLANNOTATOR_ANNOTATE_HISTORY` | `1` or `true` saves per-file annotation history. Other values disable it. The default is enabled.                                             |
| `PLANNOTATOR_SHARE`            | `disabled` hides sharing. Any other value enables it. This overrides `share` in `config.json`.                                                |
| `PLANNOTATOR_SHARE_URL`        | Share portal base URL. Default: `https://share.plannotator.ai`.                                                                               |
| `PLANNOTATOR_PASTE_URL`        | Paste API used for encrypted short links and raw HTML sharing.                                                                                |

## Files, diagnostics, and local tools

| Variable                             | Accepted value and behavior                                                                                                                                     |
| ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PLANNOTATOR_DATA_DIR`               | Replaces `~/.plannotator` as the data directory. It affects config, plans, history, sessions, and installed runtime state.                                      |
| `PLANNOTATOR_FILE_BROWSER_MAX_FILES` | Maximum files returned by the file browser. It must be a positive integer. Default: `5000`.                                                                     |
| `PLANNOTATOR_SEM_PATH`               | Explicit path to the optional `sem` semantic-diff binary.                                                                                                       |
| `PLANNOTATOR_GIT_TIMEOUT_MS`         | Git command timeout in milliseconds. Use only when diagnosing unusually slow repositories.                                                                      |
| `PLANNOTATOR_DEBUG`                  | Any non-empty value enables additional diagnostic output.                                                                                                       |
| `PLANNOTATOR_AGENT_TERMINAL_REMOTE`  | `1`, `true`, or `yes` enables the embedded agent terminal in remote mode. It is disabled remotely by default because it can run commands on the remote machine. |

## Agent setup

Most users should let the installer set these values for supported agents.

| Variable                           | Accepted value and behavior                                                                                                                                            |
| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PLANNOTATOR_ORIGIN`               | Forces the calling agent: `claude-code`, `amp`, `droid`, `opencode`, `codex`, `copilot-cli`, `gemini-cli`, `kiro-cli`, or `pi`. Invalid values fall back to detection. |
| `PLANNOTATOR_CWD`                  | Original project directory supplied by an integration wrapper.                                                                                                         |
| `PLANNOTATOR_BIN`                  | Path to the Plannotator executable used by integrations that launch the CLI. Default: `plannotator` from `PATH`.                                                       |
| `PLANNOTATOR_PLAN_TIMEOUT_SECONDS` | Maximum wait for OpenCode `submit_plan`. Default: `345600`. Set `0` to disable the timeout.                                                                            |
| `PLANNOTATOR_ALLOW_SUBAGENTS`      | `1` allows OpenCode subagents to use `submit_plan`. It is off by default.                                                                                              |

Other `PLANNOTATOR_*` values in the source tree coordinate child processes, tests, or packaged integrations. They are not stable user configuration.

## Installer controls

| Variable                                  | Accepted value and behavior                                                                                     |
| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `PLANNOTATOR_MINIMAL`                     | `1`, `true`, or `yes` installs only the CLI binary. It does not install hooks, skills, or sidecar tools.        |
| `PLANNOTATOR_VERIFY_ATTESTATION`          | `1`, `true`, or `yes` requires build-provenance verification. `0`, `false`, or `no` disables it.                |
| `PLANNOTATOR_SKIP_SEM_INSTALL`            | `1`, `true`, or `yes` skips the semantic-diff sidecar.                                                          |
| `PLANNOTATOR_SKIP_AGENT_TERMINAL_INSTALL` | `1`, `true`, or `yes` skips the agent-terminal runtime.                                                         |
| `PLANNOTATOR_PROMPT_TIMEOUT`              | Seconds the installer waits for an interactive integration choice. Default: `30`. Set `0` to wait indefinitely. |

The installer reads `PLANNOTATOR_DATA_DIR` and `PLANNOTATOR_VERIFY_ATTESTATION` too.

Last verified against Plannotator OSS v0.23.1 on July 18, 2026. Maintained by the Plannotator project.
