CLI

The binary is built with the cli feature and ships prebuilt with every release, see installation.

renderreport render

Usage: renderreport render [OPTIONS] [INPUT]

Arguments:
  [INPUT]  Path to JSON input file (reads from stdin if omitted)

Options:
  -o, --output <OUTPUT>  Output path [default: report.pdf, or report.typ with --typ]
      --typ              Write the generated Typst source instead of compiling it to PDF
      --pack-path <DIR>  Directory to search for the pack named by the request's `pack_id`
                         (repeatable; searched before the default `./packs`)

Reads a render request and writes the PDF, or with --typ the Typst source the engine would compile (see the generated Typst source). Exit code 0 on success, 1 with Error: … and the cause on stderr for unreadable input, invalid JSON or a failed render.

The CLI engine uses the default configuration: packs from ./packs and ~/.renderreport/packs (after any --pack-path), system fonts plus the bundled Fira Sans. A request with pack_id loads that pack before rendering.

renderreport list-components

Usage: renderreport list-components [OPTIONS]

Options:
      --markdown             Output as Markdown instead of plain text
      --category <CATEGORY>  Filter by category (case-insensitive substring match)

Prints id, category, layout hint and description of every built-in component, sorted by id. See components for the output of the current version.