Skip to main content

Display images in the terminal

Project description


Display images in the terminal with Python

📖 Docs ║ 🏫 Tutorial

Documentation Status


⚠️ NOTICE!!! ⚠️

The image viewer (CLI and TUI) has been moved to termvisage.




The latest stable version can be installed from PyPI with:

pip install term-image

The development version can be installed with:

pip install git+

Supported Terminal Emulators

See here for a list of tested terminal emulators.

If you've tested this library on any other terminal emulator that meets the requirements for any of the render styles, please mention the name (and version) in a new thread under this discussion.

Also, if you have any issue with terminal support, you may report or check information about it in the discussion linked above.


  • Multiple image formats (basically all formats supported by
  • Multiple image source types: PIL image instance, local file, URL
  • Multiple image render styles (with automatic support detection)
  • Support for multiple terminal graphics protocols: Kitty, iTerm2
    • Exposes various features of the protocols
  • Transparency support (with multiple options)
  • Animated image support (including transparent ones)
    • Multiple formats: GIF, WEBP, APNG (and possibly more)
    • Fully controllable iteration over rendered frames of animated images
    • Image animation with multiple parameters
  • Integration into various TUI / terminal-based output libraries.
  • Terminal size awareness
  • Automatic and manual image sizing
  • Horizontal and vertical alignment
  • Automatic and manual font ratio adjustment (to preserve image aspect ratio)
  • and more... 😁


Check out this image viewer based on this library.

Quick Start

Creating an instance

  1. Initialize with a file path:

    from term_image.image import from_file
    image = from_file("path/to/image.png")
  2. Initialize with a URL:

    from term_image.image import from_url
    image = from_url("")
  3. Initialize with a PIL (Pillow) image instance:

    from PIL import Image
    from term_image.image import AutoImage
    img ="path/to/image.png")
    image = AutoImage(img)

Drawing/Displaying an Image

There are two basic ways to draw an image to the terminal screen:

  1. Using the draw() method:


    NOTE: draw() has various parameters for render formatting.

  2. Using print() with an image render output:

    print(image)  # without formatting
    # OR
    print(f"{image:>200.^100#ffffff}")  # with formatting

For animated images, only the former animates the output, the latter only draws the current frame.

See the tutorial for a more detailed introduction.


🚧 Under Construction - There will most likely be incompatible changes between minor versions of version zero!

If you want to use this library in a project while it's still on version zero, ensure you pin the dependency to a specific minor version e.g >=0.4,<0.5.

See the docs for the User Guide and API Reference.


Please read through the guidelines.

For code contributions, you should also check out the Planned Features. If you wish to work on any of the listed features/improvements, please click on the linked issue or go through the issues section and join in on an ongoing discussion about the task or create a new issue if one hasn't been created yet, so that the implementation can be discussed.

Hint: You can filter issues by label or simply search using the features's description.

Thanks! 💓

Planned Features

See here.

Known Issues

See here.


See the FAQs section of the docs.


The following projects have been (and are still) crucial to the development of this project:

The logo was composed using resource(s) from the following source(s):

Sponsor This Project

Buy Me A Coffee

Any amount will go a long way in aiding the progress and development of this project. Thank you! 💓

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

term-image-0.7.1.tar.gz (61.2 kB view hashes)

Uploaded Source

Built Distribution

term_image-0.7.1-py3-none-any.whl (62.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page