@imprint-pdf/cli

Command-line tools for imprint-pdf.

pnpm add -D @imprint-pdf/cli

Commands

imprint render

Render a React component to a PDF file.

imprint render ./src/templates/Invoice.tsx --out ./out/invoice.pdf

| Flag | Default | Description | | --------- | ----------- | -------------------------------------------- | | --out | ./out.pdf | Output file path. | | --props | {} | JSON-encoded props to pass to the component. | | --watch | off | Rebuild on file change. | | --open | off | Open in the system PDF viewer after render. |

imprint dev

Live preview server with element inspector.

imprint dev ./src/templates/Invoice.tsx

Opens a browser tab at http://localhost:4000 with the rendered PDF on the left and a tree inspector on the right. Click any node to see its resolved style, sanitized props, and post-layout geometry box (x/y/w/h, padding, content size, effective fontFamily). On file save, both panes refresh over SSE — no polling, no hard reload.

| Flag | Default | Description | | -------- | ------- | ------------ | | --port | 4000 | Listen port. |

Endpoints:

• GET / — inspector UI
• GET /pdf — current PDF bytes (application/pdf)
• GET /inspect — { file, renderedAt, tree } JSON tree (PdfNode IR + geometry)
• GET /events — Server-Sent Events; reload fires after each successful render

The fixture file must be loadable by Node directly (.js / .mjs) or via a TypeScript loader (e.g. node --import tsx ./node_modules/@imprint-pdf/cli/dist/bin.js dev …).

imprint validate

Validate a PDF against PDF/X-4 or PDF/UA-1 using veraPDF.

imprint validate ./out/invoice.pdf --profile pdf-ua-1

Requires @imprint-pdf/print or @imprint-pdf/ua. Exits non-zero on failure — wire it into your CI pipeline.

# In CI
imprint render ./src/Invoice.tsx --out ./dist/invoice.pdf
imprint validate ./dist/invoice.pdf --profile pdf-ua-1

imprint init

Scaffold imprint.config.ts in the current directory.

npx imprint init

Config

// imprint.config.ts
import { defineConfig } from '@imprint-pdf/core/config';

export default defineConfig({
  fonts: [
    { family: 'Inter', src: './public/fonts/Inter.woff2' },
    { family: 'JetBrains Mono', src: './public/fonts/JetBrainsMono.woff2' },
  ],
  // tailwind.stylesheet auto-detects src/app.css, src/globals.css, etc.
});