Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fitims/qrcli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

qrcli

A simple CLI tool to encode text into a QR code image and decode text from a QR code image.


Features

  • Encode any text into a QR code and save it as a PNG image.
  • Decode text from an existing QR code PNG image.
  • Minimal and easy-to-use interface.

Installation

# Clone the repository
$ git clone https://github.com/fitims/qrcli.git

# Move into the project directory
$ cd qrcli

# Build the binary (example for Go)
$ go build -o qrcli

Or install via Go:

$ go install github.com/fitims/qrcli@latest

Usage

Encode

Encode a string into a QR code PNG image.

$ qrcli encode -t "Hello, World!" -o output.png

Options:

  • -t, --text : The text you want to encode.
  • -o, --output : The path to save the generated QR code PNG image.

Decode

Decode text from a QR code PNG image.

$ qrcli decode -i input.png

Options:

  • -i, --input : The path to the PNG image containing the QR code.

Examples

Encoding Example

$ qrcli encode -t "https://example.com" -o website_qr.png

Creates a QR code pointing to https://example.com saved as website_qr.png.

Decoding Example

$ qrcli decode -i website_qr.png

Outputs:

https://example.com

Requirements

  • Go 1.24+
  • Libraries for QR code generation and decoding (e.g., github.com/skip2/go-qrcode, github.com/caiguanhao/readqr)

License

MIT License. See LICENSE for more information.


Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.


Author

Created by Your Name.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages