Introduction
press is the Press.js CLI — the bridge between your web application and PDF output.
It orchestrates the full render pipeline: building your app, routing artifacts into a headless Chromium browser, running the Press.js pagination engine, and exporting the result as a PDF. With --remote, the same command delegates rendering to Press.js Cloud.
The pipeline
Section titled “The pipeline”press.toml ──► build ──► artifact routing ──► Playwright ──► pagination ──► PDF- Configure — a
press.tomlfile declares one or more document entries, each pointing to a built web app - Build (optional) — the CLI runs your app’s build command
- Route — the CLI fulfills internal browser requests from the built artifacts
- Capture — Playwright launches Chromium, navigates to your app, and waits for the ready signal
- Paginate — the Press.js runtime measures and paginates the DOM into pages
- Export — the paginated result is rendered to PDF
For cloud rendering, press render --remote keeps steps 1 and 2 local, then hands the resolved artifact path and render options to press-cloud-cli.
Relationship with Press.js packages
Section titled “Relationship with Press.js packages”@press-js/cli— this tool (thepresscommand)@press-js/reactor@press-js/vue— framework components for marking up your document (see Special Elements)@press-js/playwright— the Chromium renderer (the CLI uses this internally)
You don’t need to install @press-js/playwright separately — it’s bundled with the CLI.
Quick example
Section titled “Quick example”# Install the CLInpm install --global @press-js/cli
# Render a PDF (requires press.toml and a built app)press renderSee the Press.js Quickstart for a complete walkthrough.