qr-rs

KO | EN

gitlite — search

#javascript #react #typescript #go #golang #android #rust #deep-learning #macos #nodejs #awesome-list #security #ios #mcp

(★ 39)

A CLI utility to encode URLs or text into QR codes in various formats and colors.

qr-rs Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![GitHub releases](https://img.shields.io/github/downloads/marcoradocchia/qr-rs/total?color=%23a9b665&logo=github)
  ![GitHub source size](https://img.shields.io/github/languages/code-size/marcoradocchia/qr-rs?color=ea6962&logo=github)
  ![GitHub open issues](https://img.shields.io/github/issues-raw/marcoradocchia/qr-rs?color=%23d8a657&logo=github)
  ![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/marcoradocchia/qr-rs?color=%2389b482&logo=github)
  ![GitHub sponsors](https://img.shields.io/github/sponsors/marcoradocchia?color=%23d3869b&logo=github)
  ![Crates.io downloads](https://img.shields.io/crates/d/qr-rs?label=crates.io%20downloads&logo=rust)
  ![Crates.io version](https://img.shields.io/crates/v/qr-rs?logo=rust&color=%23d8a657)
  ![GitHub license](https://img.shields.io/github/license/marcoradocchia/qr-rs?color=%23e78a4e)

![colored_qr](https://raw.githubusercontent.com/marcoradocchia/qr-rs/master/assets/colored_qr.png)
</div>
  
<a href="https://repology.org/project/qr-rs/versions">
  <img src="https://repology.org/badge/vertical-allrepos/qr-rs.svg" alt="Packaging status" align="right">
</a>

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

## Index

- [Install](#install)
  * [Cargo](#cargo)
    - [Master branch](#master-branch)
    - [Latest release](#latest-release)
  * [AUR](#aur)
- [Usage](#usage)
- [Changelog](#changelog)
- [License](#license)

## 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:
```sh
cargo install --git https://github.com/marcoradocchia/qr-rs --branch master
```

#### Latest release

To build and install the latest release from
[crates.io](https://crates.io/crates/qr-rs) run:
```
cargo install qr-rs
```

### AUR

For **Arch Linux** (and other Arch based distros) a binary package[^1] is
available in the **AUR** (**A**rch **U**ser **R**epository):

- [qr-rs-bin](https://aur.archlinux.org/packages/qr-rs-bin)

You can install it using an _AUR helper_ such as `yay`:
```sh
yay -S qr-rs-bin
```
or `paru`:
```sh
paru -S qr-rs-bin
```

[^1]: Currently only `x86_64`

## 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](CHANGELOG.md).

## License

[GPLv3](LICENSE)

qr-rs

qr-rs Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

qr-rs

qr-rs Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README