reportist/README.md

19 lines
866 B
Markdown

# 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/`.
```bash
./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
./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](docs/build-cli.md) for commands and output behavior, the
[plugin guide](docs/plugins.md) to add a renderer, and the
[authored report contract](docs/report-contract.md) for report input. The
`AGENTS.md` file is a short implementation manifest for coding agents.