qr-rs

Crates.ioqr-rs
lib.rsqr-rs
version0.3.0
created_at2022-07-14 22:37:09.918082+00
updated_at2025-06-06 14:21:31.886243+00
descriptionA CLI utility to encode URLs or text into QR codes in various formats and colors.
homepage
repositoryhttps://github.com/marcoradocchia/qr-rs
max_upload_size
id625941
size186,308
Marco Radocchia (marcoradocchia)

documentation

README

qr-rs

GitHub releases GitHub source size GitHub open issues GitHub open pull requests GitHub sponsors Crates.io downloads Crates.io version GitHub license

colored_qr

Packaging status

Command Line Interface utility to encode URLs or more generally text into QR codes in various file formats and colors.

Index

Install

The following installation instructions assume a Rust toolchain (rustc >=1.70.0) installed on the system. In order to install such toolchain you can use rusutp: see https://www.rust-lang.org/tools/install for further installation instructions and notes.

Cargo

In order to install using Rust's package manager cargo follow instructions below.

Master branch

To build and install from master branch run:

cargo install --git https://github.com/marcoradocchia/qr-rs --branch master

Latest release

To build and install the latest release from crates.io run:

cargo install qr-rs

AUR

For Arch Linux (and other Arch based distros) a binary package1 is available in the AUR (Arch User Repository):

You can install it using an AUR helper such as yay:

yay -S qr-rs-bin

or paru:

paru -S qr-rs-bin

Usage

qr-rs v0.3.0 by Marco Radocchia <mar.radocchia@proton.me>

A CLI utility to encode URLs or text into QR codes in various formats and colors.
Usage: qr [OPTIONS] [STRING]

Arguments:
  [STRING]  String to encode

Options:
  -o, --output <OUTPUT>
          Output file (supported file extensions: jpeg, jpg, png, svg); omit to print QR code to console
  -F, --force
          Force output, i.e. overwrite without user confirmation
  -f, --fg <FG>
          Background color (hex code) [default: #000]
  -b, --bg <BG>
          Foreground color (hex code) [default: #FFF]
  -B, --border <BORDER>
          Border size (expressed in unit blocks) [default: 1]
  -l, --error-correction-level <ERROR_CORRECTION_LEVEL>
          QR error orrection level [default: medium] [possible values: low, medium, quartile, high]
  -s, --scale <SCALE>
          Scale factor (raster image output only) [default: 25]
  -h, --help
          Print help
  -V, --version
          Print version

Changelog

Complete CHANGELOG.

License

GPLv3

Footnotes

  1. Currently only x86_64

Commit count: 40

cargo fmt