Your docs pipeline, from the terminal
PaperQuire v0.2.0 ships with a full command-line interface. Everything you can do in the desktop app — render, template, brand — now works from your terminal.
This means you can automate document generation, integrate PaperQuire into CI/CD pipelines, and batch-process entire directories of Markdown without opening the GUI.
Quick start
If you installed via Homebrew, the paperquire command is already on your PATH:
brew install --cask paperquire/paperquire/paperquire
Enter fullscreen mode Exit fullscreen mode
Verify with:
paperquire version
Enter fullscreen mode Exit fullscreen mode
The simplest render is just:
paperquire report.md
Enter fullscreen mode Exit fullscreen mode
This produces report.pdf in the same directory, using the default template.
What you can do
Render with options
Apply templates, set metadata, control output:
paperquire report.md -t corporate --title "Q2 Report" --author "Jane Doe"
paperquire spec.md --page-size a4 --margins 0.75,0.75,0.75,0.75 --no-toc
paperquire draft.md --watermark "DRAFT" -o drafts/draft.pdf
Enter fullscreen mode Exit fullscreen mode
All 22 flags from the desktop app’s Document Setup panel are available. See the full list in the CLI Reference.
Pipe through stdin/stdout
PaperQuire works in Unix pipelines:
cat notes.md | paperquire - --stdout > out.pdf
Enter fullscreen mode Exit fullscreen mode
Use - as the input file to read from stdin, and --stdout to write the PDF to stdout instead of a file.
Batch render directories
Render every Markdown file in a directory with one command:
paperquire batch ./docs -o ./out
paperquire batch ./project --glob "**/*.md" -t corporate
paperquire batch ./docs --concurrency 8 --continue-on-error
Enter fullscreen mode Exit fullscreen mode
Use --dry-run to preview which files would be rendered without actually producing output.
Manage templates
List, inspect, create, and share templates:
paperquire templates list
paperquire templates show minimal-clean
paperquire templates init my-template
paperquire templates export corporate -o corporate.pqt
paperquire templates import ./shared-template.pqt
Enter fullscreen mode Exit fullscreen mode
We also launched a community templates repo where you can browse all built-in templates and submit your own via pull request.
Project configuration
Drop a .paperquire.yml in your project root and every render in that directory picks up your settings automatically:
template: corporate
toc: true
h1-page-break: true
cover:
title: "Project Documentation"
author: "Engineering Team"
company: "Acme Corp"
branding:
primary-color: "#2563eb"
Enter fullscreen mode Exit fullscreen mode
Config files are resolved in order: global (~/.paperquire/config.yml) then project (.paperquire.yml walked upward), then CLI flags win.
CI/CD integration
The CLI makes it straightforward to add document generation to your build pipeline. A GitHub Actions example:
- name: Generate docs
run: |
paperquire batch ./docs -o ./dist/docs -t corporate --continue-on-error
Enter fullscreen mode Exit fullscreen mode
Use --dry-run in your CI to validate Markdown and options without producing output — useful as a pre-merge check.
What’s next
This is the foundation. Future CLI updates will include watch mode for live rebuilding, PDF merge for combining multiple documents, and deeper CI integrations.
Get it
- Download v0.2.0 for macOS, Windows, or Linux
- CLI Reference for the full flag and command documentation
- Community Templates to browse and share templates
Or install via Homebrew:
brew install --cask paperquire/paperquire/paperquire
Enter fullscreen mode Exit fullscreen mode
답글 남기기