---
name: "upterm-proxy"
section: "1"
platform: "linux"
package: "upterm"
version: "0.40.0-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/upterm-proxy"
---

# upterm-proxy(1)

Proxy a terminal session via WebSocket

## NAME

upterm-proxy - Proxy a terminal session via WebSocket

## SYNOPSIS

**upterm proxy \[flags\] URL**

## DESCRIPTION

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.

## OPTIONS

**-h**, **--help**\[=false\]\
 	help for proxy

**--proxy**=""\
 	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**\[=false\]\
 	Enable debug logging (log file: /build/.upterm/upterm.log). A non-empty DEBUG turns it on too.

## EXAMPLE

```
  # 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)](/upterm/1.md)**

## HISTORY

27-Oct-2026 Auto generated by spf13/cobra