terminal-image 
Display images in the terminal
Works in any terminal that supports colors.
In iTerm, the image will be displayed in full resolution, since iTerm has special image support.
Install
$ npm install terminal-image
Usage
const terminalImage = require('terminal-image');
(async () => {
console.log(await terminalImage.file('unicorn.jpg'));
})();
Optionally, you can specify the height and/or width to scale the image. That can be either the percentage of the terminal window or number of rows and/or columns. Please note that the image will always be scaled to fit the size of the terminal. If width and height are not defined, by default the image will take the width and height of the terminal.
It is recommended to use the percentage option.
const terminalImage = require('terminal-image');
(async () => {
console.log(await terminalImage.file('unicorn.jpg', {width: '50%', height: '50%'}));
})();
You can set width and/or height as columns and/or rows of the terminal window as well.
const terminalImage = require('terminal-image');
(async () => {
console.log(await terminalImage.file('unicorn.jpg', {width: 50 }));
})();
By default, aspect ratio is always maintained. If you don't want to maintain aspect ratio, set preserveAspectRatio to false. However, your image will be scaled to fit the size of the terminal.
const terminalImage = require('terminal-image');
(async () => {
console.log(await terminalImage.file('unicorn.jpg', {width: 70, height: 50, preserveAspectRatio: false}));
})();
API
Supports PNG and JPEG images.
terminalImage.buffer(imageBuffer, options?)
Returns a Promise<string> with the ansi escape codes to display the image.
options
Type: object
height
Type: string | number
Custom image height.
Can be set as percentage or number of rows of the terminal. It is recommended to use the percentage options.
width
Type: string | number
Custom image width.
Can be set as percentage or number of columns of the terminal. It is recommended to use the percentage options.
preserveAspectRatio
Type: boolean
Default: true
Whether to maintain image aspect ratio or not.
imageBuffer
Type: Buffer
Buffer with the image.
terminalImage.file(filePath, options?)
Returns a Promise<string> with the ansi escape codes to display the image.
filePath
Type: string
File path to the image.
options
Type: object
height
Type: string | number
Custom image height.
Can be set as percentage or number of rows of the terminal. It is recommended to use the percentage options.
width
Type: string | number
Custom image width.
Can be set as percentage or number of columns of the terminal. It is recommended to use the percentage options.
preserveAspectRatio
Type: boolean
Default: true
Whether to maintain image aspect ratio or not.
Tip
Display a remote image
const terminalImage = require('terminal-image');
const got = require('got');
(async () => {
const body = await got('https://sindresorhus.com/unicorn').buffer();
console.log(await terminalImage.buffer(body));
})();
Related
- terminal-image-cli - CLI for this module
- terminal-link - Create clickable links in the terminal
- chalk - Style and color text in the terminal
