UPTERM(1)

📦
version 0.41.0 · 2 versions
, in arch rolling

💖 NAME 💖

Okay so this is the UPTERM(1) page from the Upterm Manual, and today's main character is upterm-proxy - Proxy a terminal session via WebSocket. It's giving remote-terminal-but-make-it-WebSocket, and we're obsessed. 💅

🐚 SYNOPSIS 🐚

upterm proxy [flags] URL

✨ DESCRIPTION ✨

Okay bestie, here's the tea: upterm-proxy carries ssh's connection to a session over a WebSocket, as its ProxyCommand. So the SSH line of a host on a ws:// or wss:// relay runs it. literally the little bridge doing the most.

URL is the ws:// or wss:// URL in the ProxyCommand of the host's SSH line. And if you want the simpler way to join such a session? That's upterm join: it takes the connect string on the host's Join line, and needs no ssh options. easy, breezy, iconic.

🚨 Exit-status vibe check, because this part matters: 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. periodt.

💅 OPTIONS 💅

  • -h, --help[=false] — help for proxy. Default is false, bestie. slay.
  • --proxy="" — HTTP proxy to reach the relay through (e.g. http://proxy.example.com:3128). Without it, HTTPS_PROXY/HTTP_PROXY are used. so it knows where to route the vibe.

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

  • --debug[=false] — Enable debug logging (log file: /build/.upterm/upterm.log). A non-empty DEBUG turns it on too. Default is false. but the env var said "not today."

🎀 EXAMPLE 🎀

Okay, examples, because reading is one thing and seeing it is another. iykyk.

# 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://ID@uptermd.upterm.dev' ID@uptermd.upterm.dev:443

# The simpler way:
upterm join wss://ID@uptermd.upterm.dev

🦋 SEE ALSO 🦋

  • upterm(1) — the other page in the group chat, go say hi.

📜 HISTORY 📜

2-Nov-2026 Auto generated by spf13/cobra — the origin story, auto-generated and everything.

🫶 cute sign-off: this page comes from Upterm 0.0.0+dev, dated Nov 2026. mwah 💋✨
📦 where this page comes from