Install the OpenRemote plugin
The plugin is optional. Core OpenRemote connection and discovery work without it.
What it adds
- TUI sidebar QR code for fast OpenRemote connection.
- Keep-awake while OpenRemote is connected.
- Connection status visible inside OpenCode.
Setup
Use the setup wizard or add the plugin entries manually.
npx installer
Run the setup wizard to add OpenRemote to your OpenCode config. It asks before writing files.
npx opencode-openremote@latest Restart opencode for changes to take effect.
manual config
Add the server plugin to opencode.json:
{
"$schema": "https://opencode.ai/config.json",
"plugin": ["opencode-openremote"]
} Add the TUI sidebar plugin to tui.json:
{
"$schema": "https://opencode.ai/tui.json",
"plugin": ["opencode-openremote/tui"]
} Restart opencode for changes to take effect.
Connect
Restart OpenCode, open the OpenRemote sidebar QR code, then scan it from the app.
Configuration
The TUI QR code includes separate OpenRemote proxy credentials. Leave OpenCode's built-in OPENCODE_SERVER_USERNAME and OPENCODE_SERVER_PASSWORD at their defaults unless you need them for OpenCode itself.
| Variable | Default | Description |
|---|---|---|
OPENCODE_REMOTE_USERNAME | opencode | QR/proxy username used by OpenRemote. |
OPENCODE_REMOTE_SECRET | generated | Fixed QR/proxy secret. When set, rotation is disabled. |
OPENCODE_REMOTE_SECRET_ROTATION_SECONDS | 30 | Rotation interval from 0 to 3600 seconds. 0 means generate once on start and never rotate. Ignored when OPENCODE_REMOTE_SECRET is set. |
OPENCODE_REMOTE_MAX_CLIENTS | 1 | Maximum authenticated OpenRemote clients allowed through the proxy. 0 allows any number. |