CLI reference¶
The cuere command renders a QR code for a payload to the terminal (or to a
file with --output). The reference below is generated from the typer app.
cuere¶
Render DATA as a QR code in the terminal.
Usage¶
cuere [OPTIONS][DATA]
Arguments¶
| Name | Description | Required |
|---|---|---|
DATA |
Data to encode; '-' (the default) reads from stdin. | No |
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
--input PATH |
Read the payload from this file instead of DATA/stdin. | No | - |
--mode, -m [half|block|ansi] |
Rendering mode. | No | half |
-i, --invert |
Flip dark and light modules. | No | False |
--border INTEGER |
Quiet-zone width in modules (the spec wants >= 4). | No | 4 |
--error, -e [L|M|Q|H] |
Error-correction level. | No | L |
--micro |
Use a compact Micro QR code (small payloads only). | No | False |
--boost-error |
Raise EC level when there is spare capacity. | No | False |
--optimize-uri |
Uppercase a lowercase URI when that shrinks the QR. | No | False |
--check-width / --no-check-width |
Fail when the code is wider than the terminal. | No | check-width |
--force |
Emit ANSI colors even when NO_COLOR/not a tty. | No | False |
--dark TEXT |
ANSI dark-module color: a name, 0-255 index, #hex, or r,g,b. Needs --mode ansi. | No | - |
--light TEXT |
ANSI light-ground color: a name, 0-255 index, #hex, or r,g,b. Needs --mode ansi. | No | - |
-o, --output FORMAT[:PATH] |
Write FORMAT (text/svg/png) to PATH instead of the terminal; PATH '-' or omitted means stdout. PNG needs the cuere[image] extra. | No | - |
--scale INTEGER |
Pixels per module for svg/png output. | No | 10 |
--version |
No | False |
Commands¶
No commands available