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.
Examples
Query Badge
$ it2 session badge get
Set Badge
$ it2 session badge set sess_123 "PROD"
Clear Badge
$ it2 session badge clear sess_123
Command Reference
- it2 session badge clear - Clear a session's badge
- it2 session badge get - Get a session's badge text
- it2 session badge set - Set a session's badge text
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
- it2 session - Manage iTerm2 sessions
- it2 session autorespond - Monitor and automatically respond to session prompts
- it2 session close - Close one or more sessions
- it2 session copy - Copy current selection to clipboard
- it2 session current - Show the current session ID
- it2 session focus - Focus/activate a session
- it2 session focused - Get the currently focused session ID
- it2 session get-buffer - Get buffer contents of a session
- it2 session get-info - Get comprehensive session information
- it2 session get-pid - Get the process ID (PID) of the shell in a session
- it2 session get-screen - Get current screen contents of a session
- it2 session has-shell-integration - Check if shell integration is enabled for a session
- it2 session list - List all iTerm2 sessions
- it2 session lookup - Look up session relationships and hierarchy
- it2 session monitor - Monitor session events in real-time
- it2 session move - Move a session to be a split pane next to another session
- it2 session paste - Paste clipboard content to session
- it2 session process - Process inspection for sessions
- it2 session profile - Manage session profile properties
- it2 session prompt - Get shell prompt metadata for a session
- it2 session resize - Resize a pane in a split layout
- it2 session restart - Restart a session
- it2 session select - Select text in a session
- it2 session send-key - Send a special key to a session
- it2 session send-text - Send text to a session as if typed
- it2 session split - Split a session pane
- it2 session splits - Show split pane layout (moved to 'tab splits')
- it2 session tail - Continuously monitor session output (like tail -f)
- it2 session title - Manage session titles
- it2 session variable - Manage session variables
- it2 session watch - Watch sessions and provide status overview