qrtool

qrtool is a command-line utility for encoding or decoding QR code.

Installation

From source

cargo install qrtool

From binaries

The release page contains pre-built binaries for Linux, macOS and Windows.

How to build

Please see BUILD.adoc.

Usage

Basic usage

Encode a string in a QR code:

qrtool encode "QR code" > output.png

Generate this image:

Decode a QR code from this image:

qrtool decode output.png

Output:

QR code

SVG generation

qrtool encode -o output.svg -t svg "QR code"

Generate this image:

Micro QR code generation

qrtool encode -v 3 --variant micro "QR code" > output.png

Generate this image:

Colored output

qrtool encode --foreground "#bc002d" "QR code" > output.png

Generate this image:

Generate shell completion

--generate-completion option generates shell completions to stdout.

The following shells are supported:

• bash
• elvish
• fish
• powershell
• zsh

Example:

qrtool --generate-completion bash > qrtool.bash

Integration with other programs

Both encode and decode can read from stdin and output to stdout.

The following example, the encoded result is saved as a JPEG XL image:

cat Cargo.toml | qrtool encode | magick png:- output.jxl

The following example, the decoded result is displayed by bat:

magick output.jxl png:- | qrtool decode | bat -l toml

Command-line options

Please see the following:

• qrtool(1)
• qrtool-encode(1)
• qrtool-decode(1)

Changelog

Please see CHANGELOG.adoc.

Contributing

Please see CONTRIBUTING.adoc.

License

Copyright © 2022–2023 Shun Sakai (see AUTHORS.adoc)

This program is distributed under the terms of either the Apache License 2.0 or the MIT License.

See COPYRIGHT, LICENSE-APACHE and LICENSE-MIT for more details.