reportist/README.md

54 lines
1.5 KiB
Markdown

# Reportist
Reportist is a standalone structured-report maker. Give it a YAML or JSON report
definition and it produces a PDF with Typst. It has no dependency on the Beffroi
integration repository or diagnostic tools.
## Render one report
```bash
./render.sh examples/example-report.yaml --output report.pdf
```
The renderer validates the input, loads an optional report-relative logo, and
writes the completed PDF. Existing output requires `--force`.
## Render one diagnostic
```bash
./render-diagnostic.sh capture.json \
--output diagnostic.pdf \
--author "Reviewer Name" \
--logo /path/to/logo.png
```
The diagnostic renderer supports the established Windows diagnostic JSON
formats and layout. Select a configured color scheme with `--theme NAME`.
## Render every diagnostic in a directory
```bash
./render-diagnostics.sh /path/to/diagnostics \
--output-dir /path/to/pdfs \
--author "Reviewer Name" \
--logo /path/to/logo.png
```
## Render every report in a directory
```bash
bash tools/render-all.sh /path/to/reports --output-dir /path/to/pdfs
```
## Validate without rendering
```bash
bash tools/validate.sh examples/example-report.yaml
bash tools/validate-all.sh /path/to/reports
```
Start with [`examples/example-report.yaml`](examples/example-report.yaml) or the
smaller [`examples/minimal-report.json`](examples/minimal-report.json). See
[`docs/report-contract.md`](docs/report-contract.md) for all fields and
[`docs/development.md`](docs/development.md) for tests and template development.