term-img

Display images in iTerm

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
term-img
6.0.03 years ago8 years agoMinified + gzip package size for term-img in KB

Popular Searches

Readme

term-img
Display images in iTerm

You probably want the higher-level terminal-image package for displaying your images.

Even animated gifs!
Currently only supported on iTerm >=3.

Install

$ npm install term-img

Usage

import terminalImage from 'term-img';

function fallback() {
	// Return something else when not supported
}

console.log(terminalImage('unicorn.jpg', {fallback}));

API

terminalImage(image, options?)

Get the image as a string that you can log manually.

image

Type: string | Buffer
File path to an image or an image as a buffer.

options

Type: object
width
height
Type: 'auto' | string | number
The width and height are given as a number followed by a unit, or the word 'auto'.
  • N: N character cells.
  • Npx: N pixels.
  • N%: N percent of the session's width or height.
  • auto: The image's inherent size will be used to determine an appropriate dimension.
preserveAspectRatio
Type: boolean\ Default: true
fallback
Type: Function\ Default: () => throw new UnsupportedTerminalError()
Enables you to do something else when the terminal doesn't support images.

Related