---
name: "upterm"
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"
---

# upterm(1)

Instant Terminal Sharing

## NAME

upterm - Instant Terminal Sharing

## SYNOPSIS

**upterm \[command\]**

## DESCRIPTION

Upterm shares a terminal session: you host a command, and guests join it from their own terminals, through a relay, with upterm join or plain ssh.

Flags can also be set with UPTERM\_ environment variables and the config file: see 'upterm config --help'.

## OPTIONS

**--debug**\[=false\]\
 	Enable debug logging (log file: /build/.upterm/upterm.log). A non-empty DEBUG turns it on too.

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

## EXAMPLE

```
  # Host $SHELL; upterm prints how guests join it:
  upterm host
  # A guest joins with the connect string the host shares:
  upterm join ssh://ID@uptermd.upterm.dev
  # Or with plain ssh:
  ssh ID@uptermd.upterm.dev
```

## SEE ALSO

**[upterm-attach(1)](/upterm-attach/1.md)**, **[upterm-config(1)](/upterm-config/1.md)**, **[upterm-host(1)](/upterm-host/1.md)**, **[upterm-join(1)](/upterm-join/1.md)**, **[upterm-proxy(1)](/upterm-proxy/1.md)**, **[upterm-session(1)](/upterm-session/1.md)**, **[upterm-upgrade(1)](/upterm-upgrade/1.md)**, **[upterm-version(1)](/upterm-version/1.md)**

## HISTORY

27-Oct-2026 Auto generated by spf13/cobra