Skip to content

fumiyas/qrc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QR code generator for text terminals

What's this?

This program generates QR codes in ASCII art or Sixel format for text terminals, e.g., console, xterm (with -ti 340 option to enable Sixel), 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.

$ qrc --help
Usage: qrc [OPTIONS] [TEXT]

Options:
  -h, --help
    Show this help message
  -i, --invert
    Invert color

Text examples:
  http://www.example.jp/
  MAILTO:[email protected]
  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:

Build from source codes

If you have Go language environment, try the following:

$ go get github.com/fumiyas/qrc/cmd/qrc

TODO

  • Add the following options:
    • --format <aa|sixel>
    • --aa-color-scheme <ansi|windows>
    • --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