CLI

npx quirepdf-cli login [email protected]
npx quirepdf-cli render order.json

→ We sent a sign-in link to [email protected].
  Open it and enter this code: 482 913
  Waiting… (Ctrl+C to cancel)
✓ Logged in as [email protected]. Key saved to ~/.config/quire/config.json
✓ wrote order.pdf (1 page, 29 KB) · template document (fallback) · 10.4 ms · 19/20 renders left this month

The CLI needs Node.js 18 or later and has no dependencies. Run it with npx quirepdf-cli, or install it once to get the quirepdf command:

npm install -g quirepdf-cli
quirepdf render order.json

The examples below use quirepdf.

Commands

Add --json to any command for machine-readable output.

Sign in

quirepdf login [email protected]

Quire emails you a sign-in link and the CLI shows a 6-digit code. Open the link, enter the code and approve. The CLI waits up to 15 minutes, then saves the new key to ~/.config/quire/config.json with permissions 600. Without an email argument, the CLI asks for one. With --json, the code and instructions go to stderr so stdout stays a single JSON object.

The first sign-in creates your account on the free plan. If the saved key still works, login tells you who you’re signed in as and creates nothing; add --force to sign in again. Each new sign-in adds a key named after this machine (quirepdf-cli on your-laptop), and the old keys keep working until you revoke them.

quirepdf logout deletes the saved file. The key itself stays valid until you run quirepdf keys revoke <id>.

Render

quirepdf render invoice.json                 # → invoice.pdf, template auto-detected
quirepdf render invoice.json -t invoice      # require the invoice template
quirepdf render invoice.json -o out/inv.pdf  # choose the output path
quirepdf render report.json --png --page 2   # → report-p2.png
quirepdf render invoice.json --open          # open the file when done
cat order.json | quirepdf render - -o order.pdf

The CLI checks that the file is valid JSON before sending it. When your data falls back to the generic layout but nearly matched a template, it prints a tip:

✓ wrote order.pdf (1 page, 37 KB) · template document (fallback) · 9.7 ms
  tip: almost matched invoice (seller is required); fix that to get the specialised layout

Invalid data prints every problem:

✗ data has 2 problems
  • seller is required
  • items[0].qty must be a number
  See the expected fields with `quirepdf templates <name>`.

Templates

quirepdf templates                            # list all seven
quirepdf templates receipt                    # required and optional fields
quirepdf templates receipt --sample > r.json  # a complete, valid example
quirepdf templates receipt --schema           # the JSON Schema

The quickest way to learn a template is to print its sample, edit it and render it.

Usage and keys

quirepdf usage
quirepdf keys
quirepdf keys create ci
quirepdf keys revoke key_nb6N6M2qmGo7

keys create prints the new secret once; copy it then. keys marks the key the CLI is using with “(this key)”. You can’t revoke your only active key. See Accounts and billing.

Upgrade

quirepdf upgrade        # list plans and prices
quirepdf upgrade pro    # open hosted checkout in your browser

Your plan changes as soon as payment completes. Add --no-open to print the checkout URL without opening a browser.

quirepdf billing        # open the billing portal: change plan, cancel, card, invoices

Once you’re on a paid plan, change plans or cancel from billing; upgrade won’t start a second subscription.

CI and scripts

export QUIRE_API_KEY=qk_live_...
quirepdf render invoice.json --json

{"file":"invoice.pdf","bytes":27559,"pages":1,"template":"invoice","source":"detected","render_ms":6.1,"quota_remaining":1873,"quota_limit":2000}

Exit codes:

View this page as Markdown