UPTERM(1)

📦
version 0.41.0 · 2 versions
, in arch rolling

🎀 UPTERM(1) — the upterm manual, bestie edition 🎀

okay so you're looking at the Upterm Manual, specifically the page for upterm-session-info, and honestly? it's a good one. let's get into it 💅

✨ NAME ✨

upterm-session-info — show a session, given its name or session ID. that's it. that's the whole gig 🫶

🌸 SYNOPSIS 🌸

upterm session info NAME|ID [flags]

🦋 DESCRIPTION 🦋

So you wanna see a session? say less. this command shows you a session given its name or session ID — literally all the deets: its status, how guests join it, who is connected, and what guests may do. the full vibe check, no cap ✨

NAME|ID is either the session's name (the one upterm host printed, or the one --name gave it) or its session ID. and if you're like "bestie where do I even find those" — upterm session list shows both. iconic. 👑

One thing to know: a name is looked up before an ID. so if you've got something that could be either, the name wins. iykyk.

And plot twist — a session that has ended still answers you, pulling from the record it left behind: how it ended. it's giving ghosting but make it helpful 😭💀

💖 Output formats 💖

  • -o json — JSON. that's the one. that's the list.

🍓 Exit status 🍓

  • 4 — exits 4 when no session has that name 🙈
  • 1 — exits 1 for any other failure 💀

🌈 OPTIONS 🌈

  • -h, --help[=false] — help for info. your little emergency exit when you're lost 🧚
  • --hide-client-ip[=false] — hides guests' IP addresses from upterm's output. and here's the nuance, bestie: when it isn't set (whether by flag, environment, or config file), they're hidden in CI only. and if you're like "no actually show me" — --hide-client-ip=false shows them there too. so you do have the power 🫶
  • -o, --output="" — output format: json. default is empty (""), so set it if you want it. lowkey important ✨

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

  • --debug[=false] — enables debug logging. the log file lives at /build/.upterm/upterm.log. also, a non-empty DEBUG turns it on too — so the env var is doing the same job. two paths, same slay 🔥

💜 EXAMPLE 💜

okay real talk, examples are the main character here:

# Show the session named build:
upterm session info build
# The same session, by its session ID:
upterm session info d3k5fia7m4us73ehblug
# As JSON:
upterm session info build -o json

look at that. same session, three ways, all valid. ate 💅

⭐ SEE ALSO ⭐

🎀 HISTORY 🎀

2-Nov-2026 — Auto generated by spf13/cobra. yeah, it was built by the robot, we're just vibing with it 🤖✨

ngl the one thing to keep in your head: name gets looked up before ID, and a dead session still spills its ending. periodt 💀💖

and that's the page!! Upterm 0.0.0+dev, Nov 2026 — mwah, go show some sessions who's boss 🫶🌸

📦 where this page comes from