https://github.com/lenivaya/qrrs

CLI QR code generator and reader written in rust
https://github.com/lenivaya/qrrs

cli cli-qr nix nix-flake qrcode qrcode-generator qrcode-scanner reader rust rust-crate rust-lang rustlang shell terminal terminal-based

Last synced: 6 days ago
JSON representation

CLI QR code generator and reader written in rust

• Host: GitHub
• URL: https://github.com/lenivaya/qrrs
• Owner: Lenivaya
• License: mit
• Created: 2020-07-17T11:20:26.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-15T20:35:54.000Z (6 months ago)
• Last Synced: 2025-02-01T00:14:45.963Z (6 days ago)
• Topics: cli, cli-qr, nix, nix-flake, qrcode, qrcode-generator, qrcode-scanner, reader, rust, rust-crate, rust-lang, rustlang, shell, terminal, terminal-based
• Language: Rust
• Homepage:
• Size: 302 KB
• Stars: 77
• Watchers: 3
• Forks: 6
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
QRrs

CLI QR code generator and reader written in rust




![CI](https://github.com/Lenivaya/qrrs/workflows/CI/badge.svg)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)

[![codecov](https://codecov.io/gh/Lenivaya/qrrs/branch/master/graph/badge.svg?token=UBGW1EV2GV)](https://codecov.io/gh/Lenivaya/qrrs)




![image](https://github.com/Lenivaya/qrrs/assets/49302467/d83217a5-0b11-4171-8d5c-1c4bb09b4339)



# Info

QRrs is a simple, cross-platform, command-line utility written in rust for working with qr codes (what actually follows from the name).

## Usage

### Quickly generate qr code

```console

qrrs "Your input here"

```

### Generate code, than read it

```console

qrrs "Something" /tmp/qr.png

```

```console

$ qrrs --read /tmp/qr.png

Something

```

### Print generated code to term

```console

qrrs -t "Something" /tmp/qr.png

```

```rich-text-format

█████████████████████████████

█████████████████████████████

████ ▄▄▄▄▄ █▄ █▄▄█ ▄▄▄▄▄ ████

████ █   █ █▀▄████ █   █ ████

████ █▄▄▄█ █ ▄█▀▄█ █▄▄▄█ ████

████▄▄▄▄▄▄▄█ ▀ ▀ █▄▄▄▄▄▄▄████

████▄███ █▄▄ ▄▀ ▀▄▄▄  █▀▄████

████▄ ▀█▀▄▄▀▄▀▀▄█▀▄█ █▄ ▀████

████▄█▄██▄▄▄▀▀▀█ ▄▀█ ▀█▄ ████

████ ▄▄▄▄▄ █▄▀▄▀ ▄▄▀ ██ █████

████ █   █ █▄█▀ ▀▄▄█ ▀▀ ▀████

████ █▄▄▄█ ██▀ ▄█▀ ▀ ████████

████▄▄▄▄▄▄▄█▄▄▄█▄▄▄▄█▄██▄████

█████████████████████████████

▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀

```

### Show code as text in terminal

```console

qrrs --read --terminal /tmp/qr.png

```

```rich-text-format

█████████████████████████████

█████████████████████████████

████ ▄▄▄▄▄ █▄ █▄▄█ ▄▄▄▄▄ ████

████ █   █ █▀▄████ █   █ ████

████ █▄▄▄█ █ ▄█▀▄█ █▄▄▄█ ████

████▄▄▄▄▄▄▄█ ▀ ▀ █▄▄▄▄▄▄▄████

████▄███ █▄▄ ▄▀ ▀▄▄▄  █▀▄████

████▄ ▀█▀▄▄▀▄▀▀▄█▀▄█ █▄ ▀████

████▄█▄██▄▄▄▀▀▀█ ▄▀█ ▀█▄ ████

████ ▄▄▄▄▄ █▄▀▄▀ ▄▄▀ ██ █████

████ █   █ █▄█▀ ▀▄▄█ ▀▀ ▀████

████ █▄▄▄█ ██▀ ▄█▀ ▀ ████████

████▄▄▄▄▄▄▄█▄▄▄█▄▄▄▄█▄██▄████

█████████████████████████████

▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀

```

### Save it into another file

```console

qrrs --read --terminal /tmp/qr.png /tmp/qr1.png

```

Almost the same result will be without terminal flag, but now instead of QrCode printed in terminal we will see text from it.

```console

qrrs --read /tmp/qr.png /tmp/qr1.png

```

### Create code using pipeline

Use "**-**" to signalize passing data via stdin.

```console

$ echo "something" | qrrs - /tmp/something.png

$ qrrs -r /tmp/something.png

something

```

### Invert colors

![image](https://github.com/Lenivaya/qrrs/assets/49302467/186e2501-8ef1-4728-9567-5b2013911ec0)

### Create code specifying it's margin

![image](https://github.com/Lenivaya/qrrs/assets/49302467/b98a7df7-171a-4707-b733-e095fa7da814)

![image](https://github.com/Lenivaya/qrrs/assets/49302467/6be8fee9-a4a5-4855-b515-8649b68d8028)

## Install

## Nix

```console

nix run github:Lenivaya/qrrs -- "your input"

```

### Using last version through overlay in nixos config

Add this repository as an input to your flake:

```nix

nixpkgs.url = "nixpkgs/nixpkgs-unstable";

qrrs = {

  url = "github:lenivaya/qrrs";

  inputs.nixpkgs.follows = "nixpkgs";

};

```

Then use the overlay somewhere in your config:

```nix

{inputs, pkgs, ...}: {

  nixpkgs.overlays = [inputs.qrrs.overlays.default];

  environment.systemPackages = with pkgs; [qrrs];

}

```

## NetBSD

```console

pkgin install qrrs

```

### From crates.io

```console

cargo install qrrs

```

### From github

```console

cargo install --git https://github.com/Lenivaya/qrrs.git

```

### [Precompiled binaries](https://github.com/Lenivaya/qrrs/releases)