reportist/README.md

1.0 KiB

Reportist

Reportist is the standalone Typst engine for authored reports and raw WinDiagnostics captures. Each plugin owns its input interpretation and document layout. Plugins share graphical elements and themes in visual/.

./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 consumables plugins/consumables/tests/fixtures/sample.csv --output consumables.pdf
./tests/test.sh

The public CLI also renders source directories, analyzes diagnostic evidence, validates inputs, and exports authored YAML as JSON. See the CLI contract for commands and output behavior, the plugin guide to add a renderer, and the authored report contract for report input. The palette catalog lists the themes available to both plugins. The AGENTS.md file is a short implementation manifest for coding agents.