Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QR CLI

qr-cli logo

Generate QR codes in your terminal or save them as PNG files.

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

Install (no PAT required)

Install directly from the public GitHub repo:

npm install -g github:asharahmed/qr-cli

Install (GitHub Packages)

If you prefer GitHub Packages, configure npm for the @asharahmed scope:

npm config set @asharahmed:registry https://npm.pkg.github.com

Then install the CLI (GitHub Packages requires auth):

npm install -g @asharahmed/qr-cli

Usage

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

Options:

  • -i, --invert Invert colors (for light terminals)
  • -l, --large Use large mode (2 chars per module)
  • -o, --output <file> Save as PNG file

Examples:

qr -l "Hello from the terminal"
qr -o code.png "https://example.com"

Development

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

Publishing

Publishing is handled by GitHub Actions using the built-in GITHUB_TOKEN, so a PAT is not needed. Create a GitHub Release on the repo and the workflow will publish to GitHub Packages.

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