1.0.0 • Published 11 months ago

@ladabees/qr-cli v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
11 months ago

LadaQR CLI

A command-line tool for generating QR codes. This tool combines Node.js and Python to provide a simple yet powerful QR code generation utility.

Prerequisites

  • Node.js (>= 12.0.0)
  • Python 3.x
  • pip (Python package installer)

Installation

Install the package globally using npm:

npm install -g ladaqr-cli

The installation process will automatically install the required Python dependencies.

Usage

Once installed, you can use the ladaqr command from anywhere in your terminal:

ladaqr <data> [output_file] [size]

Parameters:

  • <data>: The data to encode in the QR code (URL, text, etc.)
  • [output_file]: (Optional) The output file name (default: output.png)
  • [size]: (Optional) The size of the QR code in pixels (default: 300)

Examples

  1. Generate a QR code for a URL:
ladaqr "https://example.com"
  1. Generate a QR code with a custom filename:
ladaqr "Hello World" hello.png
  1. Generate a QR code with custom size:
ladaqr "Hello World" qr.png 500

Features

  • Simple command-line interface
  • Customizable QR code size
  • High-quality QR code generation using Python's qrcode library
  • Cross-platform support (Windows, macOS, Linux)

Troubleshooting

If you encounter any issues with Python dependencies, you can manually install them:

pip install qrcode[pil]

License

ISC

Author

Ladabees

- To generate a QR code for a URL and save it as `my_qr_code.png` with a size of `400`:

```bash
./qr-cli.sh "https://example.com" "my_qr_code.png" 400
  • To generate a QR code for a simple text and save it as text_qr.png with a size of 200:

    ./qr-cli.sh "Hello, World!" "text_qr.png" 200

Dependencies

  • Python 3: The script requires Python 3 to execute the Python script (main.py).
  • qrcode library: The script uses the qrcode library to generate QR codes.

The script will automatically install the required qrcode library if it is not already installed.

To manually install the qrcode library, run:

pip install qrcode[pil]

License

This project is licensed under the MIT License - see the LICENSE file for details.


Feel free to contribute to the project by opening issues or pull requests.

1.0.0

11 months ago