# Command-line printing (Linux & macOS)

Print a `.pos` template without opening the GUI.

Run `posprint cli-help` to print this section from the binary (no GUI required).

## Syntax

```bash
posprint list
posprint print <file.pos> --printer <DEVICE> --set Name=Value [--set Other=Value ...]
posprint link <file.pos>
```

Short form:

```bash
posprint list
posprint print receipt.pos -p /dev/ttyUSB0 --set StoreName="My Shop" --set DocumentNumber=1001
posprint print receipt.pos -p /dev/rfcomm0 --set StoreName="My Shop" --set DocumentNumber=1001
posprint link receipt.pos
```

## Rules

- **`posprint list`**: print discovered printers (USB, USB-serial, paired Classic Bluetooth SPP). Use the device path from the list as `-p`.
- **`--printer` / `-p`** (required): printer id from `posprint list` (e.g. `usb:28e9:0289:0:1` or `usb:28e9:0289`), `auto` (first discovered printer), or serial device path (e.g. `/dev/ttyUSB0`, `/dev/ttyACM0`, `/dev/rfcomm0`, `/dev/cu.usbserial-*`).
- **`--set NAME=VALUE`** (required for every parameter): one flag per `${Name}` or `$[Name]` in the template.
- Checkbox params (`$[Name]`): use `true`/`false` (also `1`/`0`, `yes`/`no`).
- If any text `${Name}` is missing or empty, or a `$[Name]` is omitted / not a boolean, the command **fails**.
- The GUI is not started when using the `print` subcommand.
- **`posprint link`** encodes the `.pos` file as a `posprint://` URL on stdout (see [POSPRINT-URL.md](POSPRINT-URL.md)). Warns if the URL is very long.

## Permissions

Your user must be in the **`dialout`** group:

```bash
sudo usermod -aG dialout "$USER"
# log out and back in
groups
```

## Examples

```bash
posprint print ~/receipts/sale.pos -p /dev/ttyUSB0 \
  --set StoreName="Corner Cafe" \
  --set DocumentNumber=42 \
  --set Date=2026-07-15 \
  --set GrandTotal=19.99
```

## Printer device

```bash
posprint list
ls -l /dev/ttyUSB* /dev/ttyACM* /dev/rfcomm* 2>/dev/null
```

Use the device node shown when the printer is connected. Pair a Classic Bluetooth SPP printer in the OS first; BLE is not supported.

## Exit codes

| Code | Meaning |
|------|---------|
| `0` | Printed successfully |
| `1` | Error (missing parameters, parse error, permission denied, etc.) |

## Help

```bash
posprint print --help
posprint link --help
posprint --help
```

Launch the graphical designer by running `posprint` with **no** subcommand. Opening a `posprint://…` URL (from a browser) or `posprint --print` starts print-only mode: live preview on the left, parameters and printer on the right.

After package install, if `posprint://` links do not open:

```bash
xdg-mime default posprint-url.desktop x-scheme-handler/posprint
```
