Compatibility
Supported terminal emulators
These image protocols are supported:
- Inline Images Protocol (iTerm2)
- Terminal graphics protocol (kitty)
- Supports both the existing graphics protocol mode and the Unicode placeholder mode.
The terminals on which each has been confirmed to work are listed below.
Inline Images Protocol
| Terminal emulator | Note |
|---|---|
| iTerm2 | But slower than other terminals |
| WezTerm | |
| Rio | |
| VSCode integrated terminal * | Requires the terminal.integrated.enableImages setting to be enabled |
*Not only the VSCode integrated terminal, but any terminal emulator using xterm.js may basically work in the same way as long as image display feature is enabled.
Terminal graphics protocol
Rendering using Unicode Placeholder is available by explicitly specifying kitty-unicode as protocol option or config.
Partially supported environments
- tmux is supported only when using the kitty Unicode placeholder protocol.
- Requires
set -g allow-passthrough onin tmux.conf (version 3.2+).
- Requires
Unsupported environments
- Sixel graphics is not supported.
- Other terminal multiplexers (screen, Zellij, etc.) other than those listed in Partially supported environments are not supported.
- Windows is not officially supported. Please refer to the related issue.