Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QR CLI

qr-cli logo

A fast, minimal CLI for generating terminal and PNG QR codes.

Features

  • Render QR codes in the terminal
  • Read input from arguments or stdin
  • Save QR codes as PNG files
  • Invert colors or use large rendering
  • Cross-platform binaries available via GitHub Releases

Install

Install directly from the public GitHub repo:

npm install -g github:asharahmed/qr-cli

Prefer a binary? Download one from the Releases page: https://github.com/asharahmed/qr-cli/releases

Quick start

qr "https://example.com"
echo "hello world" | qr

Options

Flag Description
-i, --invert Invert colors (for light terminals)
-l, --large Use large mode (2 chars per module)
-e, --error <level> Error correction level: L, M, Q, H
--format <format> Output format: text, png, svg
--size <px> PNG size in pixels
--margin <px> Quiet zone margin in modules
--raw Do not trim input
--quiet Suppress non-essential output
-o, --output <file> Save output to file, or use - for stdout

Examples

qr -l "Hello from the terminal"
qr -o code.png "https://example.com"
qr --format svg -o code.svg "https://example.com"
echo "secret message" | qr --format png -o -
echo "secret message" | qr -i

Development

npm install
npm run build
node dist/index.js "hello"

License

MIT

About

A fast and minimal command-line interface for generating terminal and PNG QR codes.

Topics

Resources

Stars

5 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages