Skip to content

syzer/img2ascii

Repository files navigation

img2ascii

Greenkeeper badge

NPM Version Dependency Status Downloads Today Downloads Month Build Status

Purpose

  • Downloads images (jpeg/gif/png) and outputs them in your console.
  • Make custom ssh login message for your users.
  • Picture is worth thousands words.. we will use both!

Doge In terminal

Getting Started

brew install graphicsmagick
npm install -g img2ascii

Usage CLI

Usage: img2ascii [url|file] --cols [num] --ratio [num]

Options:
  -c, --cols   Number of columns in terminal                       [default: 80]
  -r, --ratio  Aspect ratio. Try 0.5 to flatten image
               and 2 to lengthen image                              [default: 1]

Examples

img2ascii doge.png
img2ascii https://pbs.twimg.com/profile_images/378800000822867536/3f5a00acf72df93528b6bb7cd0a4fd0c.jpeg
img2ascii doge.png --cols 20 --ratio 0.5

Usage as module

const img2ascii = require('img2ascii')({
    img: './assets/snafu.gif',
    cols: 90,                   // optional
    ratio: 1.2                  // optional
}).pipe(process.stdout)