-
Notifications
You must be signed in to change notification settings - Fork 23
Remote Access
English · 中文
Optionally share a WispTerm session to a browser over a Cloudflare-hosted relay. Disabled by default.
Remote access lets you view and drive a running WispTerm session from a browser (for example, your phone) through a Cloudflare-hosted relay. It is an opt-in feature and is disabled by default — nothing leaves your machine until you enable it.
When enabled, WispTerm creates one shared outbound RemoteClient for the running instance. All tabs and splits publish their PTY output through that client.
Set these keys in the config:
remote-enabled = true
remote-server-url = https://remote.example.com
remote-server-fingerprint = sha256:... # optional: pin the relay identity
remote-device-name = Workstation # optional: friendly name
-
remote-enabled— start the RemoteClient. -
remote-server-url— the Cloudflare relay URL. -
remote-server-fingerprint— expected relay fingerprint for identity pinning. -
remote-device-name— friendly device name sent with pairing.
By default the session key is random for every process. The generated key is printed in the debug console and shown in the in-window remote status pill. Click the status pill to copy the active session key, or run Copy Remote Key from the command center.
Set remote-session-key = mypass to use predictable keys across multiple
concurrent local instances: the first process gets mypass, the next mypass_1,
then mypass_2, and so on. This only chooses the relay session key the browser
enters — it is separate from the relay's own web-admin login password.
WispTerm Remote mirrors the local window because the desktop app is the source of truth: the local PTY, VT state, scrollback, cursor, and split layout are captured there and streamed to the browser. The mobile UI can refocus a single surface instead of squeezing every split onto a small screen, but it does not create a separate phone-sized terminal grid (see FAQ).
See also: Configuration · FAQ