Terminals¶

Each terminal represents an application rendering the shell’s output, and is associated with:

a unique terminal ID
a human-readable name
an icon (emoji / unicode character)
a detection function
various metadata in its info() method

Terminal usage¶

Each terminal is materialized by a Terminal object, from which you can access various metadata:

>>> from extra_platforms import KITTY
>>> KITTY
Terminal(id='kitty', name='Kitty')
>>> KITTY.id
'kitty'
>>> KITTY.current
False
>>> KITTY.info()
{'id': 'kitty', 'name': 'Kitty', 'icon': '🐱', 'url': 'https://sw.kovidgoyal.net/kitty/', 'current': False, 'version': None, 'color_support': None}

To check if the current environment is running in a specific terminal, use the corresponding detection function:

>>> from extra_platforms import is_kitty
>>> is_kitty()
False

The current terminal can be obtained via the current_terminal() function:

>>> from extra_platforms import current_terminal
>>> current_terminal()
Terminal(id='unknown_terminal', name='Unknown terminal')

Recognized terminals¶

Icon	Symbol	Name	Detection function
🔳	`ALACRITTY`	Alacritty	`is_alacritty()`
🍏	`APPLE_TERMINAL`	Apple Terminal	`is_apple_terminal()`
◰	`CONTOUR`	Contour	`is_contour()`
🦶	`FOOT`	foot	`is_foot()`
👻	`GHOSTTY`	Ghostty	`is_ghostty()`
𝐆	`GNOME_TERMINAL`	GNOME Terminal	`is_gnome_terminal()`
📺	`GNU_SCREEN`	GNU Screen	`is_gnu_screen()`
⬡	`HYPER`	Hyper	`is_hyper()`
⬛	`ITERM2`	iTerm2	`is_iterm2()`
🐱	`KITTY`	Kitty	`is_kitty()`
💎	`KONSOLE`	Konsole	`is_konsole()`
🏞️	`RIO`	Rio	`is_rio()`
🐈	`TABBY`	Tabby	`is_tabby()`
🔀	`TILIX`	Tilix	`is_tilix()`
📟	`TMUX`	tmux	`is_tmux()`
🔵	`VSCODE_TERMINAL`	VS Code Terminal	`is_vscode_terminal()`
🔡	`WEZTERM`	WezTerm	`is_wezterm()`
⊡	`WINDOWS_TERMINAL`	Windows Terminal	`is_windows_terminal()`
𝐗	`XTERM`	xterm	`is_xterm()`
🪵	`ZELLIJ`	Zellij	`is_zellij()`

Hint

The UNKNOWN_TERMINAL trait represents an unrecognized terminal. It is not included in the ALL_TERMINALS group, and will be returned by current_terminal() if the current terminal is not recognized.

Groups of terminals¶

Icon	Symbol	Description	Detection	`Canonical`
💻	`ALL_TERMINALS`	All terminals	`is_any_terminal()`
🎮	`GPU_TERMINALS`	GPU-accelerated terminals	`is_gpu_terminals()`	⬥
⧉	`MULTIPLEXERS`	Terminal multiplexers	`is_multiplexers()`	⬥
▦	`NATIVE_TERMINALS`	Native terminal emulators	`is_native_terminals()`	⬥
⬢	`WEB_TERMINALS`	Web-based terminals	`is_web_terminals()`	⬥

Hint

Canonical groups are non-overlapping groups that together cover all recognized traits. They are marked with a ⬥ icon in the table above.

Other groups are provided for convenience, but overlap with each other or with canonical groups.

        ---
config:
  sankey:
    height: 800
    showValues: false
    width: 800

---
sankey-beta

ALL_TERMINALS,NATIVE_TERMINALS,7
ALL_TERMINALS,GPU_TERMINALS,7
ALL_TERMINALS,WEB_TERMINALS,3
ALL_TERMINALS,MULTIPLEXERS,3
NATIVE_TERMINALS,APPLE_TERMINAL,1
NATIVE_TERMINALS,GNOME_TERMINAL,1
NATIVE_TERMINALS,ITERM2,1
NATIVE_TERMINALS,KONSOLE,1
NATIVE_TERMINALS,TILIX,1
NATIVE_TERMINALS,WINDOWS_TERMINAL,1
NATIVE_TERMINALS,XTERM,1
GPU_TERMINALS,ALACRITTY,1
GPU_TERMINALS,CONTOUR,1
GPU_TERMINALS,FOOT,1
GPU_TERMINALS,GHOSTTY,1
GPU_TERMINALS,KITTY,1
GPU_TERMINALS,RIO,1
GPU_TERMINALS,WEZTERM,1
WEB_TERMINALS,HYPER,1
WEB_TERMINALS,TABBY,1
WEB_TERMINALS,VSCODE_TERMINAL,1
MULTIPLEXERS,GNU_SCREEN,1
MULTIPLEXERS,TMUX,1
MULTIPLEXERS,ZELLIJ,1

        ---
config:
  mindmap:
    padding: 5

---
mindmap
    ((💻 ALL_TERMINALS))
        )⬢ WEB_TERMINALS(
            (⬡ HYPER)
            (🐈 TABBY)
            (🔵 VSCODE_TERMINAL)
        )▦ NATIVE_TERMINALS(
            (🍏 APPLE_TERMINAL)
            (𝐆 GNOME_TERMINAL)
            (⬛ ITERM2)
            (💎 KONSOLE)
            (🔀 TILIX)
            (⊡ WINDOWS_TERMINAL)
            (𝐗 XTERM)
        )⧉ MULTIPLEXERS(
            (📺 GNU_SCREEN)
            (📟 TMUX)
            (🪵 ZELLIJ)
        )🎮 GPU_TERMINALS(
            (🔳 ALACRITTY)
            (◰ CONTOUR)
            (🦶 FOOT)
            (👻 GHOSTTY)
            (🐱 KITTY)
            (🏞️ RIO)
            (🔡 WEZTERM)

Predefined terminals¶

Terminal definitions and metadata.

extra_platforms.ALACRITTY = Terminal(id='alacritty', name='Alacritty')¶

ID: alacritty
Aliases: -
Name: Alacritty
Icon: 🔳
Reference: <https://alacritty.org>_
Detection function: is_alacritty()
Pytest decorators: @skip_alacritty / @unless_alacritty
Groups (3): ALL_TERMINALS, ALL_TRAITS, GPU_TERMINALS ⬥

extra_platforms.APPLE_TERMINAL = Terminal(id='apple_terminal', name='Apple Terminal')¶

ID: apple_terminal
Aliases: -
Name: Apple Terminal
Icon: 🍏
Reference: <https://support.apple.com/guide/terminal/welcome/mac>_
Detection function: is_apple_terminal()
Pytest decorators: @skip_apple_terminal / @unless_apple_terminal
Groups (3): ALL_TERMINALS, ALL_TRAITS, NATIVE_TERMINALS ⬥

extra_platforms.CONTOUR = Terminal(id='contour', name='Contour')¶

ID: contour
Aliases: -
Name: Contour
Icon: ◰
Reference: <https://contour-terminal.org>_
Detection function: is_contour()
Pytest decorators: @skip_contour / @unless_contour
Groups (3): ALL_TERMINALS, ALL_TRAITS, GPU_TERMINALS ⬥

extra_platforms.FOOT = Terminal(id='foot', name='foot')¶

ID: foot
Aliases: -
Name: foot
Icon: 🦶
Reference: <https://codeberg.org/dnkl/foot>_
Detection function: is_foot()
Pytest decorators: @skip_foot / @unless_foot
Groups (3): ALL_TERMINALS, ALL_TRAITS, GPU_TERMINALS ⬥

extra_platforms.GHOSTTY = Terminal(id='ghostty', name='Ghostty')¶

ID: ghostty
Aliases: -
Name: Ghostty
Icon: 👻
Reference: <https://ghostty.org>_
Detection function: is_ghostty()
Pytest decorators: @skip_ghostty / @unless_ghostty
Groups (3): ALL_TERMINALS, ALL_TRAITS, GPU_TERMINALS ⬥

extra_platforms.GNOME_TERMINAL = Terminal(id='gnome_terminal', name='GNOME Terminal')¶

ID: gnome_terminal
Aliases: -
Name: GNOME Terminal
Icon: 𝐆
Reference: <https://help.gnome.org/users/gnome-terminal/stable/>_
Detection function: is_gnome_terminal()
Pytest decorators: @skip_gnome_terminal / @unless_gnome_terminal
Groups (3): ALL_TERMINALS, ALL_TRAITS, NATIVE_TERMINALS ⬥

extra_platforms.GNU_SCREEN = Terminal(id='gnu_screen', name='GNU Screen')¶

ID: gnu_screen
Aliases: -
Name: GNU Screen
Icon: 📺
Reference: <https://www.gnu.org/software/screen/>_
Detection function: is_gnu_screen()
Pytest decorators: @skip_gnu_screen / @unless_gnu_screen
Groups (3): ALL_TERMINALS, ALL_TRAITS, MULTIPLEXERS ⬥

extra_platforms.HYPER = Terminal(id='hyper', name='Hyper')¶

ID: hyper
Aliases: -
Name: Hyper
Icon: ⬡
Reference: <https://hyper.is>_
Detection function: is_hyper()
Pytest decorators: @skip_hyper / @unless_hyper
Groups (3): ALL_TERMINALS, ALL_TRAITS, WEB_TERMINALS ⬥

extra_platforms.ITERM2 = Terminal(id='iterm2', name='iTerm2')¶

ID: iterm2
Aliases: -
Name: iTerm2
Icon: ⬛
Reference: <https://iterm2.com>_
Detection function: is_iterm2()
Pytest decorators: @skip_iterm2 / @unless_iterm2
Groups (3): ALL_TERMINALS, ALL_TRAITS, NATIVE_TERMINALS ⬥

extra_platforms.KITTY = Terminal(id='kitty', name='Kitty')¶

ID: kitty
Aliases: -
Name: Kitty
Icon: 🐱
Reference: <https://sw.kovidgoyal.net/kitty/>_
Detection function: is_kitty()
Pytest decorators: @skip_kitty / @unless_kitty
Groups (3): ALL_TERMINALS, ALL_TRAITS, GPU_TERMINALS ⬥

extra_platforms.KONSOLE = Terminal(id='konsole', name='Konsole')¶

ID: konsole
Aliases: -
Name: Konsole
Icon: 💎
Reference: <https://konsole.kde.org>_
Detection function: is_konsole()
Pytest decorators: @skip_konsole / @unless_konsole
Groups (3): ALL_TERMINALS, ALL_TRAITS, NATIVE_TERMINALS ⬥

extra_platforms.RIO = Terminal(id='rio', name='Rio')¶

ID: rio
Aliases: -
Name: Rio
Icon: 🏞️
Reference: <https://rioterm.com>_
Detection function: is_rio()
Pytest decorators: @skip_rio / @unless_rio
Groups (3): ALL_TERMINALS, ALL_TRAITS, GPU_TERMINALS ⬥

extra_platforms.TABBY = Terminal(id='tabby', name='Tabby')¶

ID: tabby
Aliases: -
Name: Tabby
Icon: 🐈
Reference: <https://tabby.sh>_
Detection function: is_tabby()
Pytest decorators: @skip_tabby / @unless_tabby
Groups (3): ALL_TERMINALS, ALL_TRAITS, WEB_TERMINALS ⬥

extra_platforms.TILIX = Terminal(id='tilix', name='Tilix')¶

ID: tilix
Aliases: -
Name: Tilix
Icon: 🔀
Reference: <https://gnunn1.github.io/tilix-web/>_
Detection function: is_tilix()
Pytest decorators: @skip_tilix / @unless_tilix
Groups (3): ALL_TERMINALS, ALL_TRAITS, NATIVE_TERMINALS ⬥

extra_platforms.TMUX = Terminal(id='tmux', name='tmux')¶

ID: tmux
Aliases: -
Name: tmux
Icon: 📟
Reference: <https://github.com/tmux/tmux/wiki>_
Detection function: is_tmux()
Pytest decorators: @skip_tmux / @unless_tmux
Groups (3): ALL_TERMINALS, ALL_TRAITS, MULTIPLEXERS ⬥

extra_platforms.UNKNOWN_TERMINAL = Terminal(id='unknown_terminal', name='Unknown terminal')¶

ID: unknown_terminal
Aliases: -
Name: Unknown terminal
Icon: ❓
Reference: <https://en.wikipedia.org/wiki/Terminal_emulator>_
Detection function: is_unknown_terminal()
Pytest decorators: @skip_unknown_terminal / @unless_unknown_terminal
Groups (2): ALL_TRAITS, UNKNOWN ⬥

extra_platforms.VSCODE_TERMINAL = Terminal(id='vscode_terminal', name='VS Code Terminal')¶

ID: vscode_terminal
Aliases: -
Name: VS Code Terminal
Icon: 🔵
Reference: <https://code.visualstudio.com/docs/terminal/basics>_
Detection function: is_vscode_terminal()
Pytest decorators: @skip_vscode_terminal / @unless_vscode_terminal
Groups (3): ALL_TERMINALS, ALL_TRAITS, WEB_TERMINALS ⬥

extra_platforms.WEZTERM = Terminal(id='wezterm', name='WezTerm')¶

ID: wezterm
Aliases: -
Name: WezTerm
Icon: 🔡
Reference: <https://wezfurlong.org/wezterm/>_
Detection function: is_wezterm()
Pytest decorators: @skip_wezterm / @unless_wezterm
Groups (3): ALL_TERMINALS, ALL_TRAITS, GPU_TERMINALS ⬥

extra_platforms.WINDOWS_TERMINAL = Terminal(id='windows_terminal', name='Windows Terminal')¶

ID: windows_terminal
Aliases: -
Name: Windows Terminal
Icon: ⊡
Reference: <https://github.com/microsoft/terminal>_
Detection function: is_windows_terminal()
Pytest decorators: @skip_windows_terminal / @unless_windows_terminal
Groups (3): ALL_TERMINALS, ALL_TRAITS, NATIVE_TERMINALS ⬥

extra_platforms.XTERM = Terminal(id='xterm', name='xterm')¶

ID: xterm
Aliases: -
Name: xterm
Icon: 𝐗
Reference: <https://invisible-island.net/xterm/>_
Detection function: is_xterm()
Pytest decorators: @skip_xterm / @unless_xterm
Groups (3): ALL_TERMINALS, ALL_TRAITS, NATIVE_TERMINALS ⬥

extra_platforms.ZELLIJ = Terminal(id='zellij', name='Zellij')¶

ID: zellij
Aliases: -
Name: Zellij
Icon: 🪵
Reference: <https://zellij.dev>_
Detection function: is_zellij()
Pytest decorators: @skip_zellij / @unless_zellij
Groups (3): ALL_TERMINALS, ALL_TRAITS, MULTIPLEXERS ⬥