33 lines
1.0 KiB
Markdown
33 lines
1.0 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 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.
|