it2 session get-info

Get comprehensive session information

Synopsis

it2 session get-info [<session-id>] [flags]

Description

Get comprehensive information about a session including:

  • Basic session details (ID, name, title)
  • Window and tab associations
  • Session properties
  • Current prompt information (if Shell Integration enabled)
  • Process information

Session ID can be:

  • Omitted (uses current session from $ITERM_SESSION_ID)
  • Full UUID
  • Partial ID (minimum 4 characters)

This command combines multiple API calls to provide a complete view of the session.

Options

--extract

Extract specific property value (e.g., 'frame', 'frame.coords', 'name')

--prompt

Include current prompt information

--properties

Include session properties

Options inherited from parent commands

--format (default "text")

Output format (text, json, yaml) - affects how command results are displayed

--timeout

Timeout for API operations - how long to wait for iTerm2 to respond

--url

WebSocket URL for iTerm2 API - typically ws://localhost:1912 for local iTerm2

See Also

Examples

  # Basic Usage (defaults to current session)

  it2 session get-info

  # Using full session ID
  it2 session get-info 7AA97682-C080-4D65-8C19-FDEF4669AA84

  # Using partial session ID (4+ characters)
  it2 session get-info 7aa9
  it2 session get-info 6b1a4c

  # Output Formats (default: text)

  it2 session get-info --format json
  it2 session get-info --format yaml

  # Include session properties
  it2 session get-info --properties

  # Include prompt information
  it2 session get-info --prompt

  # Extract specific fields
  it2 session get-info --extract name
  it2 session get-info --extract grid_size.width