https://github.com/fumiyas/qrc
QR code generator for text terminals (ASCII art, Sixel)
https://github.com/fumiyas/qrc
cli cui go qrcode-generator sixel terminal tui
Last synced: 8 months ago
JSON representation
QR code generator for text terminals (ASCII art, Sixel)
- Host: GitHub
- URL: https://github.com/fumiyas/qrc
- Owner: fumiyas
- License: mit
- Created: 2014-08-09T13:45:31.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T06:29:18.000Z (over 1 year ago)
- Last Synced: 2024-10-31T10:36:46.147Z (about 1 year ago)
- Topics: cli, cui, go, qrcode-generator, sixel, terminal, tui
- Language: Go
- Homepage:
- Size: 44.9 KB
- Stars: 352
- Watchers: 5
- Forks: 27
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
QR code generator for text terminals
======================================================================
* Copyright (C) 2014-2017 SATOH Fumiyasu @ OSS Technology Corp., Japan
* License: MIT License
* Development home:
* Author's home:
What's this?
---------------------------------------------------------------------
This program generates QR codes in
[ASCII art](http://en.wikipedia.org/wiki/ASCII_art) or
[Sixel](http://en.wikipedia.org/wiki/Sixel) format for
text terminals, e.g., console, xterm (with `-ti 340` option to enable Sixel),
[mlterm](http://sourceforge.net/projects/mlterm/),
Windows command prompt and so on.
Use case
---------------------------------------------------------------------
You can transfer data to smartphones with a QR code reader application
from your terminal.
Usage
---------------------------------------------------------------------
`qrc` program takes a text from command-line argument or standard
input (if no command-line argument) and encodes it to a QR code.
```console
$ qrc --help
Usage: qrc [OPTIONS] [TEXT]
Options:
-h, --help
Show this help message
-i, --invert
Invert color
Text examples:
http://www.example.jp/
MAILTO:foobar@example.jp
WIFI:S:myssid;T:WPA;P:pass123;;
$ qrc https://fumiyas.github.io/
...
$ qrc 'WIFI:S:Our-ssid;T:WPA;P:secret;;'
...
```
You can get a QR code in Sixel graphics if the standard output is
a terminal and it supports Sixel.
Download
---------------------------------------------------------------------
Binary files are here for Linux, Mac OS X and Windows:
* https://github.com/fumiyas/qrc/releases
Build from source codes
---------------------------------------------------------------------
If you have Go language environment, try the following:
```console
$ go get github.com/fumiyas/qrc/cmd/qrc
```
TODO
----------------------------------------------------------------------
* Add the following options:
* `--format `
* `--aa-color-scheme `
* `--foreground-color R:G:B`
* `--background-color R:G:B`
* `--margin-color R:G:B`
* `--margin-size N`
* `--input-encoding E`
* Timeout for tty.GetDeviceAttributes1()
Contributors
----------------------------------------------------------------------
* Hayaki Saito (@saitoha)
Similar products
----------------------------------------------------------------------
* Go
*
* JavaScript (Node)
*
* Ruby
* (qrcode-sixel)
* (qrcode-sixel)
*