# qrcode-terminal

> QRCodes, in the terminal

Latest version **0.12.0** (published 2018-03-20) · 0 weekly downloads

## Install

```sh
npm install qrcode-terminal
pnpm add qrcode-terminal
yarn add qrcode-terminal
bun add qrcode-terminal
```

Provides the command `qrcode-terminal`.

## Health

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

Positive: has types package; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.12.0 |
| Published | 2018-03-20 |
| First published | 2013-02-28 |
| Weekly downloads | 0 |
| TypeScript types | separate (@types/qrcode-terminal) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 94.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1351 |
| Maintainers | gtanner, mwbrooks |
| Keywords | ansi, ascii, qrcode, console |

## Links

- npm: https://www.npmjs.com/package/qrcode-terminal
- Repository: https://github.com/gtanner/qrcode-terminal
- Issues: https://github.com/gtanner/qrcode-terminal/issues
- npm.io page: https://npm.io/package/qrcode-terminal

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.12.0 (latest) — 2018-03-20
- 0.11.0 — 2016-09-22
- 0.10.0 — 2015-06-04
- 0.9.5 — 2014-08-26
- 0.9.4 — 2013-03-19
- 0.9.3 — 2013-03-11
- 0.9.2 — 2013-03-11
- 0.9.1 — 2013-03-11
- 0.9.0 — 2013-03-05
- 0.8.0 — 2013-03-03
- 0.7.0 — 2013-02-28
- 0.6.0 — 2013-02-28
- 0.5.1 — 2013-02-28
- 0.5.0 — 2013-02-28
- 0.4.0 — 2013-02-28
- … 3 more at https://npm.io/package/qrcode-terminal/versions

## README

# QRCode Terminal Edition [![Build Status][travis-ci-img]][travis-ci-url]

> Going where no QRCode has gone before.

![Basic Example][basic-example-img]

# Node Library

## Install

Can be installed with:

    $ npm install qrcode-terminal

and used:

    var qrcode = require('qrcode-terminal');

## Usage

To display some data to the terminal just call:

    qrcode.generate('This will be a QRCode, eh!');

You can even specify the error level (default is 'L'):
    
    qrcode.setErrorLevel('Q');
    qrcode.generate('This will be a QRCode with error level Q!');

If you don't want to display to the terminal but just want to string you can provide a callback:

    qrcode.generate('http://github.com', function (qrcode) {
        console.log(qrcode);
    });

If you want to display small output, provide `opts` with `small`:

    qrcode.generate('This will be a small QRCode, eh!', {small: true});

    qrcode.generate('This will be a small QRCode, eh!', {small: true}, function (qrcode) {
        console.log(qrcode)
    });

# Command-Line

## Install

    $ npm install -g qrcode-terminal

## Usage

    $ qrcode-terminal --help
    $ qrcode-terminal 'http://github.com'
    $ echo 'http://github.com' | qrcode-terminal

# Support

- OS X
- Linux
- Windows

# Server-side

[node-qrcode][node-qrcode-url] is a popular server-side QRCode generator that
renders to a `canvas` object.

# Developing

To setup the development envrionment run `npm install`

To run tests run `npm test`

# Contributers

    Gord Tanner <gtanner@gmail.com>
    Micheal Brooks <michael@michaelbrooks.ca>

[travis-ci-img]: https://travis-ci.org/gtanner/qrcode-terminal.png
[travis-ci-url]: https://travis-ci.org/gtanner/qrcode-terminal
[basic-example-img]: https://raw.github.com/gtanner/qrcode-terminal/master/example/basic.png
[node-qrcode-url]: https://github.com/soldair/node-qrcode

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