it2 session badge

Manage session badges

Description

Get, set, and clear session badges.

Session badges appear in the top-right corner of the terminal window
and can display custom text, useful for showing environment, server names,
or other contextual information.

Commands

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

  # Query Badge

  it2 session badge get

  # Set Badge

  it2 session badge set sess_123 "PROD"

  # Clear Badge

  it2 session badge clear sess_123