https://github.com/marcoradocchia/qr-rs
A CLI utility to encode URLs or text into QR codes in various formats and colors.
https://github.com/marcoradocchia/qr-rs
command-line qr qr-code qrcode-generator rust rust-lang text url
Last synced: 2 months ago
JSON representation
A CLI utility to encode URLs or text into QR codes in various formats and colors.
- Host: GitHub
- URL: https://github.com/marcoradocchia/qr-rs
- Owner: marcoradocchia
- License: gpl-3.0
- Created: 2022-06-29T16:44:45.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-07-20T12:53:02.000Z (about 3 years ago)
- Last Synced: 2025-03-17T20:01:45.272Z (7 months ago)
- Topics: command-line, qr, qr-code, qrcode-generator, rust, rust-lang, text, url
- Language: Rust
- Homepage:
- Size: 118 KB
- Stars: 35
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
qr-rs
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
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 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
Background color (hex code) [default: #000]
-b, --bg
Foreground color (hex code) [default: #FFF]
-B, --border
Border size (expressed in unit blocks) [default: 1]
-l, --error-correction-level
QR error orrection level [default: medium] [possible values: low, medium, quartile, high]
-s, --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)