https://github.com/sevinf/termimage

Node.js library for displaying images in terminal
https://github.com/sevinf/termimage

Last synced: over 1 year ago
JSON representation

Node.js library for displaying images in terminal

• Host: GitHub
• URL: https://github.com/sevinf/termimage
• Owner: SevInf
• License: mit
• Created: 2015-05-23T14:57:00.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2015-05-23T14:57:20.000Z (about 11 years ago)
• Last Synced: 2025-02-03T21:57:28.449Z (over 1 year ago)
• Language: JavaScript
• Size: 97.7 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Termimage

Library for displaying images in supported terminals:

* iTerm2 nightly builds

* TODO: Xterm with a help of w3m

## Usage

```javascript

var termimage = require('termimage');

// Show image from file

termimage.displayImage('/path/to/image');

// Show image from buffer

termimage.displayImage(buffer);

// Show scaled image.

termimage.displayImage(buffer, {

    width: 100,

    height: 100

});

// Aspect ratio will be preserved if

// only one dimension is specified 

termimage.displayImage(buffer, {

    width: 100

});

// Specify the name of the image

termimage.displayImage(buffer, {

    name: 'my photo'

});

```