reportist/docs/build-cli.md

1.6 KiB

Reportist build CLI contract

build.sh accepts render, render-all, analyze, analyze-all, validate, validate-all, and export-json-all. A missing or unsupported command exits 2. Invalid input or a failed render exits nonzero. A successful command exits 0.

render report INPUT --output PDF accepts authored .yaml, .yml, or .json. render diagnostic INPUT --output PDF accepts raw WinDiagnostics JSON v1/v2. render consumables INPUT --output PDF accepts a Snipe-IT consumables .csv export. It supports --theme and uses the shared Reportist palettes. Each plugin keeps its own Typst document model. Both commands refuse to replace an existing output unless --force is supplied. They compile into a temporary directory and move the completed PDF into place.

render-all KIND INPUT_DIR --output-dir DIR finds matching files recursively and writes PDFs beneath DIR, preserving each input's relative path and replacing its extension with .pdf. It rejects an output inside the input tree. --force is forwarded to each render. Diagnostic rendering also accepts --author and --theme (a name from the palette catalog).

analyze and analyze-all produce normalized diagnostic evidence JSON. They require an evidence root, reference time, and producer version. validate and validate-all check authored reports or normalized diagnostic JSON; diagnostic validation can also verify the referenced raw evidence. The CLI passes their detailed arguments to the owning plugin tools.

export-json-all INPUT_DIR --output-dir DIR converts authored YAML reports to JSON while preserving relative paths.