https://github.com/lirantal/picture-tuber
render images on the terminal (forked from substack/picture-tube)
https://github.com/lirantal/picture-tuber
cli nodejs picture terminal-emulator
Last synced: 7 months ago
JSON representation
render images on the terminal (forked from substack/picture-tube)
- Host: GitHub
- URL: https://github.com/lirantal/picture-tuber
- Owner: lirantal
- License: mit
- Created: 2019-02-08T09:15:17.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-02-08T22:34:44.000Z (almost 5 years ago)
- Last Synced: 2025-04-22T00:03:01.802Z (7 months ago)
- Topics: cli, nodejs, picture, terminal-emulator
- Language: JavaScript
- Size: 36.1 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.markdown
- License: LICENSE.md
Awesome Lists containing this project
README
# picture-tuber
Render images on the terminal.
# example
## command
## code
```js
var pictureTube = require("picture-tuber");
var tube = pictureTube();
tube.pipe(process.stdout);
var fs = require("fs");
fs.createReadStream("robot.png").pipe(tube);
```
# usage
```
Usage: picture-tube OPTIONS { file or uri }
Options:
--cols number of columns to use for output
```
# methods
```js
var pictureTube = require("picture-tuber");
```
## var tube = pictureTube(opts)
Return a readable/writable stream that reads png image data and writes ansi
terminal codes.
Set the number of columns to display the image as with `opts.cols`.
Right now only png files work.
# install
To install as a library, with [npm](http://npmjs.org) do:
```
npm install picture-tuber
```
To install the command-line tool, with [npm](http://npmjs.org) do:
```
npm install -g picture-tuber
```
# license
MIT