Upterm

Instant Terminal Sharing

View project on GitHub

upterm session info

Show a session, given its name or session ID

Synopsis

Show a session, given its name or session ID: its status, how guests join it, who is connected, and what guests may do.

NAME|ID is the session’s name (the one ‘upterm host’ printed, or –name gave it) or its session ID; ‘upterm session list’ shows both. A name is looked up before an ID.

A session that has ended still answers, from the record it left behind: how it ended.

Output formats: -o json JSON

Exits 4 when no session has the name, and 1 for any other failure.

upterm session info NAME|ID [flags]

Examples

  # 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

Options

  -h, --help             help for info
      --hide-client-ip   Hide guests' IP addresses from upterm's output. When it isn't set (by flag, environment or config file), they are hidden in CI only; --hide-client-ip=false shows them there too.
  -o, --output string    Output format: json

Options inherited from parent commands

      --debug   Enable debug logging (log file: /home/user/.local/state/upterm/upterm.log). A non-empty DEBUG turns it on too.

SEE ALSO

Auto generated by spf13/cobra on 18-Oct-2026