Operating System: Unix / Linux / MacOS X / Windows (limited support, see the FAQs)
Python >= 3.7
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 ANSI 24-bit color support
Plans to support a wider variety of terminal emulators are in motion (see Planned Features).
The latest stable version can be installed from PyPI using
pip install term-image
The development version can be installed thus:
NOTE: it’s recommended to install in an isolated virtual environment, can be created by any means.
Clone the repository,
git clone https://github.com/AnonymouX47/term-image.git
then navigate into the local repository
pip install .
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:
MinTTY (on Windows)
Termux (on Android)
For style-specific support, see the descriptions of the respective Image Classes
or the Render Styles section towards the bottom of the command-line help text
(i.e the output of
If you’ve tested
term-image on any other terminal emulator that meets all
requirements, please mention the name in a new thread under this discussion.
Also, if you’re having an issue with terminal support, you may report or check information about it in the discussion linked above.
Some terminal emulators support 24-bit color escape sequences but have a 256-color pallete. This will limit color reproduction.