# picture-tuber

> render 256 color images on the terminal

Latest version **2.0.0** (published 2019-04-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install picture-tuber
pnpm add picture-tuber
yarn add picture-tuber
bun add picture-tuber
```

Provides the command `picture-tube`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2019-04-14 |
| First published | 2019-02-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.4.0 |
| Dependencies | 6 |
| Unpacked size | 3.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Liran Tal |
| Maintainers | lirantal |
| Keywords | png, viewer, terminal, ansi |

## Links

- npm: https://www.npmjs.com/package/picture-tuber
- Repository: https://github.com/lirantal/picture-tuber
- Homepage: https://github.com/lirantal/picture-tuber#readme
- Issues: https://github.com/lirantal/picture-tuber/issues
- npm.io page: https://npm.io/package/picture-tuber

## Dependencies (6)

- [x256](https://npm.io/package/x256.md) ~0.0.1
- [charm](https://npm.io/package/charm.md) ~0.1.0
- [png-js](https://npm.io/package/png-js.md) ~0.1.0
- [buffers](https://npm.io/package/buffers.md) ~0.1.1
- [optimist](https://npm.io/package/optimist.md) ~0.3.4
- [event-stream](https://npm.io/package/event-stream.md) ~0.9.8

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2019-04-14
- 1.0.2 — 2019-02-21
- 1.0.1 — 2019-02-08

## README

# picture-tuber

Render images on the terminal.

# example

## command

<img width="1094" height="694" alt="image" src="https://github.com/user-attachments/assets/450e745e-1ac0-4144-89fa-51e04422c81d" />

## 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

## Contributing

Please consult [CONTRIBUTING](./CONTRIBUTING.md) for guidelines on contributing to this project.

---
_Source: https://npm.io/package/picture-tuber · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._