reportist/README.md

875 B

Reportist

Reportist renders authored YAML/JSON reports and raw WinDiagnostics captures. The report and diagnostic plugins own their document structure independently; both use visual/elements.typ and visual/themes.yaml.

build.sh is the public CLI and works without the Beffroi macro checkout:

./build.sh render report examples/example-report.yaml --output report.pdf
./build.sh render diagnostic plugins/diagnostics/tests/fixtures/legacy/windiagnostics-v1.json --output diagnostic.pdf
./build.sh render-all report /path/to/reports --output-dir /path/to/pdfs
./build.sh render-all diagnostic /path/to/captures --output-dir /path/to/pdfs

It also exposes analyze, analyze-all, validate, validate-all, and export-json-all. See the CLI contract for arguments and output behavior. tests/test.sh runs both plugin test suites.