beffroi-reporting/README.md

1.9 KiB

Beffroi Reporting

This repository is the editing and publishing workspace for Beffroi reports. It pins two components: Reports holds authored YAML and raw diagnostic JSON sources; Reportist turns those sources into PDFs with independent Typst plugins and shared graphical elements. The macro pipeline checks, packages, and publishes the results.

./beffroi.sh bootstrap
./beffroi.sh report reports/reports/2026-09-04-clevo-handoff.yaml /tmp/report.pdf
./beffroi.sh diagnostic-pdf reports/diagnostics/windows_system_report_DESKTOP-SAU019H_20260915_121057.json /tmp/diagnostic.pdf
./beffroi.sh consumables reporter/plugins/consumables/tests/fixtures/sample.csv /tmp/consumables.pdf
./beffroi.sh test
./beffroi.sh all build/publication --replace

beffroi.sh diagnostic CAPTURE EVIDENCE_ROOT NEW_OUTPUT_DIR REFERENCE_TIME [AUTHOR] [THEME] also creates normalized evidence JSON. capture-pdf is an alias for diagnostic-pdf. --include-json on all includes source JSON in the publication. beffroi.sh package BUILD_DIR ARTIFACT_DIR creates encrypted archives when REPORT_ZIP_PASSWORD is set.

Documentation

Run ./beffroi.sh doctor to check local tools. ./beffroi.sh --help lists all workspace commands. The original Typst project under legacy/typst_reporter is retained locally as the visual parity reference for the 17 stored PDFs.