# console-png

> Print PNG images to terminal output

Latest version **1.2.1** (published 2017-06-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install console-png
pnpm add console-png
yarn add console-png
bun add console-png
```

Provides the command `console-png`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2017-06-30 |
| First published | 2015-11-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 85 |
| Author | Anthony Foster |
| Maintainers | aantthony |
| Keywords | console, png, terminal, ansi, xterm, 256, colors |

## Links

- npm: https://www.npmjs.com/package/console-png
- Repository: https://github.com/aantthony/console-png
- Homepage: https://github.com/aantthony/console-png#readme
- Issues: https://github.com/aantthony/console-png/issues
- npm.io page: https://npm.io/package/console-png

## Dependencies (2)

- [png.js](https://npm.io/package/png.js.md) ^0.1.1
- [ansi-256-colors](https://npm.io/package/ansi-256-colors.md) ^1.1.0

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

- 1.2.1 (latest) — 2017-06-30
- 1.2.0 — 2017-05-24
- 1.1.0 — 2015-12-01
- 1.0.0 — 2015-11-02

## README

# console-png

[![NPM Version](https://img.shields.io/npm/v/console-png.svg)](https://www.npmjs.com/package/console-png)
[![Build Status](https://img.shields.io/travis/aantthony/console-png/master.svg)](https://travis-ci.org/aantthony/console-png)

Print PNG images to terminal output.

## Install

To use this on your terminal:
```
npm install -g console-png
```

To use this programatically:
```
npm install --save console-png
```

## Terminal Usage
```
> console-png
Usage: console-png [PNG FILE]...
> console-png apple.png
{image shown here}
```

## Example Usage

```js
require('console-png').attachTo(console);

var image = require('fs').readFileSync(__dirname + '/nodejs-green.png');

console.png(image);
```

![Screenshot](/demo/screenshot.png)

## Alternate Usage

```js
var pngStringify = require('console-png');

var image = require('fs').readFileSync(__dirname + '/nodejs-green.png');

pngStringify(image, function (err, string) {
  if (err) throw err;
  console.log(string);
})
```

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