Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/sayanarijit/qrscan

Scan a QR code in the terminal using the system camera or a given image
https://github.com/sayanarijit/qrscan

camera command-line console-application qrcode qrcode-scanner terminal

Last synced: 1 day ago
JSON representation

Scan a QR code in the terminal using the system camera or a given image

Host: GitHub
URL: https://github.com/sayanarijit/qrscan
Owner: sayanarijit
License: mit
Created: 2022-07-13T10:12:48.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-07-03T07:47:00.000Z (over 1 year ago)
Last Synced: 2024-12-16T02:04:14.016Z (8 days ago)
Topics: camera, command-line, console-application, qrcode, qrcode-scanner, terminal
Language: Rust
Homepage:
Size: 109 KB
Stars: 165
Watchers: 6
Forks: 7
Open Issues: 8
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Scan a QR code in the terminal using the system camera or a given image.

https://user-images.githubusercontent.com/11632726/178779071-ad5ca7da-0fc3-48c1-b725-a9834db39134.mp4

### Install

[![Packaging status](https://repology.org/badge/vertical-allrepos/qrscan.svg)](https://repology.org/project/qrscan/versions)

#### Scoop

```powershell
scoop bucket add extras
scoop install qrscan
```

#### Cargo

```bash
# On Ubuntu, first install libclang-dev (apt-get install libclang-dev)
cargo install --locked --force qrscan
```

#### Nix

##### Nixpkgs

```bash
nix-env -f https://github.com/NixOS/nixpkgs/tarball/master -iA qrscan
```

##### Flake

```bash
nix profile install github:sayanarijit/qrscan
```

#### Pre-built binaries

Download the appropriate binary from the [latest release](https://github.com/sayanarijit/qrscan/releases/latest).

### Usage

Scan via the system camera with terminal preview

```bash
qrscan --preview
```

Scan a given image file

```bash
qrscan path/to/file

# Or read from stdin

cat /path/to/file | qrscan -
```

Print the QR code on the terminal

```bash
qrscan --qr --no-content
```

Also print QR code metadata

```bash
qrscan --metadata
```

Export the QR code as image files

```bash
qrscan --qr \
--svg path/to/out.svg \
--png path/to/out.png \
--jpeg path/to/out.jpeg \
--ascii path/to/out.ascii
```

### Some Usage Examples

Capture a screenshot of a selected area using [ImageMagic](https://imagemagick.org/index.php) and scan the QR code.

```bash
import png:- | qrscan -
```

### Introductions & Reviews

- [Scan QR codes right from your Linux Terminal ~ The Lunduke Journal](https://lunduke.substack.com/p/scan-qr-codes-right-from-your-linux)