upterm proxy
Proxy a terminal session via WebSocket
Synopsis
Carry ssh’s connection to a session over a WebSocket, as its ProxyCommand: the SSH line of a host on a ws:// or wss:// relay runs it.
URL is the ws:// or wss:// URL in the ProxyCommand of the host’s SSH line. upterm join is the simpler way to join such a session: it takes the connect string on the host’s Join line, and needs no ssh options.
Exit status: 1 when it can’t connect to the relay, including a usage or configuration error. Once connected, 0 for end-of-input from ssh unless a relay close or read or write failure is also reported; those failures take precedence and give 1. Errors caused by proxy’s own cleanup do not change the result.
upterm proxy [flags] URL
Examples
# A host shares a session over a WebSocket:
upterm host --server wss://uptermd.upterm.dev
# A guest joins with the SSH line the host prints, which runs upterm proxy:
ssh -o ProxyCommand='upterm proxy wss://[email protected]' [email protected]:443
# The simpler way:
upterm join wss://[email protected]
Options
-h, --help help for proxy
--proxy string HTTP proxy to reach the relay through (e.g. http://proxy.example.com:3128). Without it, HTTPS_PROXY/HTTP_PROXY are used.
Options inherited from parent commands
--debug Enable debug logging (log file: /home/user/.local/state/upterm/upterm.log). A non-empty DEBUG turns it on too.
SEE ALSO
- upterm - Instant Terminal Sharing