Skip to main content

Flexible terminal image viewer for iTerm2

Project description

iv: Terminal Image Viewer for iTerm2

PyPI version

iv is a utility for viewing images in the terminal using iTerm2's image display capability. It's useful for dealing with images on a remote server, for example with large image processing tasks.

When displaying single images, iv will resize them to speed up transfer over an SSH connection:

iv displaying a single image

When displaying multiple images, iv will produce a "contact sheet" of images with filenames. These images are decoded and resized in parallel:

iv displaying multiple images

Installation

iv can be installed using pip:

$ pip3 install iv

If iv can't find any suitable TrueType fonts on your system it'll use an ugly default bitmap font. To get some nicer fonts on Linux, install the Open Sans or msttcorefonts collections (fonts-open-sans or ttf-mscorefonts-installer packages on Debian-like distributions).

Usage

Usage: iv [OPTIONS] FILENAME...

  Display images within an iTerm2 terminal.

  iv will resize images to reduce the time taken to display them over SSH
  connections, and it will combine multiple images into a single image, with
  filenames.

  Usage:

    iv ./file.jpg # Display a single file, resizing as appropriate.
    iv *.jpg      # Display a number of files combined into a single image, with filenames.

  The IV_SIZE environment variable can be used to set the output image size
  instead of the -s/--size option.

Options:
  --version           Show the version and exit.
  -s, --size INTEGER  Maximum output image width in pixels.
  --help              Show this message and exit.

Limitations

iTerm2 has some image resizing logic which means that increasing the displayed width may actually decrease the size of the image. This seems to be partly dependent on terminal dimensions.

iTerm2 may refuse to display extremely large images, and replace them with an extremely retro "broken image" icon. You can always right-click and "Open image" to view the image with an external viewer.

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

iv-1.0.4.tar.gz (3.9 kB view hashes)

Uploaded Source

Built Distribution

iv-1.0.4-py3-none-any.whl (4.2 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