quirepdf-cli
v0.2.0
Published
Send JSON, get a beautiful PDF. CLI for the Quire document API.
Maintainers
Readme
quirepdf-cli: the Quire PDF CLI
Send JSON, get a beautiful PDF.
npx quirepdf-cli login [email protected] # open the email link, enter the code shown; your key is saved
npx quirepdf-cli render data.json # → data.pdf (template auto-detected)No template needed. Quire uses the matching gallery template (invoice, receipt, quote, credit note, statement, certificate) when your data fits one. Otherwise it uses a clean generic layout for any JSON.
Commands
| Command | What it does |
|---|---|
| quirepdf login [email] [--force] | Sign in by email link plus the code the CLI shows. The key is saved to ~/.config/quire/config.json (mode 600). Does nothing if the saved key still works, unless --force. |
| quirepdf render [file\|-] [-t name] [-o out] [--png [--page N]] [--open] | Render JSON to PDF or PNG. Reads stdin with - or a pipe. |
| quirepdf templates [name] [--sample\|--schema] | List templates, show their fields, or print sample data / the JSON Schema. |
| quirepdf usage | Plan and renders used this month. |
| quirepdf keys [create [name] \| revoke <id>] | Manage API keys. Secrets are shown once. |
| quirepdf upgrade [starter\|pro\|scale] | Open hosted checkout. |
| quirepdf billing | Open the billing portal: change plan, cancel, update card, invoices. |
| quirepdf logout | Forget the saved key. |
Add --json to any command for machine-readable output, for agents and scripts.
For CI and agents
export QUIRE_API_KEY=qk_live_... # takes precedence over the saved config
quirepdf render invoice.json --json # {"file":"invoice.pdf","template":"invoice","source":"detected",...}Exit codes: 0 success, 1 API or data error (readable message, every field problem listed), 2 bad usage.
Development
Zero dependencies (Node ≥ 18 built-ins only). End-to-end tests start the real engine in accounts mode:
make build && cd cli && npm test