upterm-session-list1

Usage

Overview

List the running sessions, one row each: name, status, session ID, command and relay. * marks the session this terminal is in ($UPTERM_ADMIN_SOCKET).

The sessions come from the records in: /build/.upterm/results Sessions started under another XDG_RUNTIME_DIR are listed too. Listing deletes the records of sessions that ended more than 7 days ago, after which 'upterm session info' and 'upterm session wait' no longer know them.

-o json prints a JSON array of what 'upterm session info NAME -o json' prints, one per running session, and [] when none is running.

Exit status: 0, or 1 when the records directory can't be read, or for a usage or configuration error. A session whose own record can't be read is left out of the list.

Options

-h, --help[=false]
help for list

--hide-client-ip[=false]
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=""
Output format: json (command line only)

Options inherited from parent commands

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

Examples

  # List the running sessions:
  upterm session list
  # As JSON, for a script:
  upterm session list -o json