term-img2

Display images in your terminal

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
term-img2
202.0.17 years ago7 years agoMinified + gzip package size for term-img2 in KB

Readme

term-img2
Display images in your terminal


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

Install

$ npm install --save term-img2

Usage

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

termImg('unicorn.jpg', {log: true});

API

termImg(input, options)

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

Log image in terminal, false by default.
fallback
Type: function
Default: () => throw new UnsupportedTerminal()
Enables you to do something else when the terminal doesn't support images.

return

Type: string
The image string that can be displayed in terminal.

Related

License

MIT © EGOIST