UPTERM(1)

💅 UPTERM(1) — the Upterm Manual, bestie edition 🎀

okay so like, hi, this is UPTERM(1) from the Upterm Manual and I'm about to make terminal sharing make Sense. pull up a chair. 🪑

---

✨ NAME ✨

upterm — Instant Terminal Sharing (yes that's the actual tagline and yes it ate 💅)

---

🦋 SYNOPSIS 🦋

upterm [command]

that's it. that's the whole vibe. one command name, and then whatever subcommand you're feeling.

---

🌸 DESCRIPTION 🌸

okay so picture this: Upterm shares a terminal session. You host a command — your command, main character energy 👑 — and guests join it from their own terminals.

How do they join? Through a relay, bestie. And they can come in either with upterm join or with plain ssh. literally that easy. no cap. 🔥

and listen, flags can also be set with UPTERM_ environment variables and the config file — so if you're the kind of girl who likes setting things once and never touching them again (me), go check out upterm config --help. 👀

---

🎀 OPTIONS 🎀

• --debug[=false] — turns on debug logging 💀 the log file lives at /build/.upterm/upterm.log. also, a non-empty DEBUG turns it on too — so like, you don't have to pass the flag, the vibe check on DEBUG is enough. 🫶
• -h, --help[=false] — shows help for upterm. classic. iconic. always there for you. 💖

---

🌈 EXAMPLE 🌈

here's the group chat in action:

  # 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

so: upterm host hosts $SHELL and prints how guests join it — that's your invite link basically 💌. then a guest joins with the connect string the host shares via upterm join ssh://ID@uptermd.upterm.dev, or goes old-school with plain ssh ID@uptermd.upterm.dev. slay either way. ✨

---

🧚 SEE ALSO 🧚

the whole friend group, fr fr — go say hi:

• upterm-attach(1)
• upterm-config(1)
• upterm-host(1)
• upterm-join(1)
• upterm-proxy(1)
• upterm-session(1)
• upterm-upgrade(1)
• upterm-version(1)

---

⭐ HISTORY ⭐

2-Nov-2026 — Auto generated by spf13/cobra. not me being a bot-written page and still serving looks 😭💅

---

okay that's the whole page, mwah 💋 this was Upterm 0.0.0+dev, dated Nov 2026, and it's giving UPTERM(1) in the Upterm Manual. go share a terminal, bestie. 🦋🍓