term-img-x v0.0.1

term-img

Display images in iTerm

Even animated gifs!

Currently only supported on iTerm >=3.

Install

$ npm install term-img

Usage

const termImg = require('term-img');

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

termImg('unicorn.jpg', {fallback});

API

termImg(input, options)

Log the image to the terminal directly.

termImg.string(input, options)

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

input

Type: string Buffer

Filepath to an image or an image as a buffer.

options

width

height

Type: 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

• term-img-cli - CLI for this module

License

MIT © Sindre Sorhus