Installation

Requirements

• Operating System: Unix / Linux / MacOS X / Windows (limited support, see the FAQs)

• Python >= 3.8

• A terminal emulator with any of the following:

  • support for the Kitty graphics protocol.

  • support for the iTerm2 inline image protocol.

  • full Unicode support and truecolor support

  Plans to support a wider variety of terminal emulators are in motion (see the library's Planned Features).

Steps

The latest version can be installed from PyPI using pipx with:

pipx install termvisage

and upgraded with:

pipx upgrade termvisage

Note

pip can also be used but pipx is recommended.

Supported Terminal Emulators

Some terminals emulators that have been tested to meet the requirements for at least one render style include:

• libvte-based terminal emulators such as:

  • Gnome Terminal

  • Terminator

  • Tilix

• Kitty

• Konsole

• iTerm2

• WezTerm

• Alacritty

• Windows Terminal

• MinTTY (on Windows)

• Termux (on Android)

For render style-specific support, see Render Styles.

Note

Some terminal emulators support truecolor escape sequences but have a 256-color palette. This will limit color reproduction.