Reproducible Beffroi diagnostics and reporting workspace, pinning the collector, report archive and renderer into one workflow.
Go to file
Dandaedre 328a85261c
Beffroi Reporting CI A component or integration check failed.
Beffroi/beffroi-reporting/pipeline/head There was a failure building this commit Details
Update Reports reference for corrected NVMe diagnostic report
2026-09-24 16:41:06 +02:00
docs Integrate Reports source syntax check 2026-09-17 00:18:12 +02:00
reporter@b8cc88e4af Expose consumables report command 2026-09-17 16:03:25 +02:00
reports@612ad0d055 Update Reports reference for corrected NVMe diagnostic report 2026-09-24 16:41:06 +02:00
scripts Integrate Reports source syntax check 2026-09-17 00:18:12 +02:00
.gitignore Gitignore 2026-09-16 20:11:36 +02:00
.gitmodules Integrate diagnostic plugin and retire analysis submodule 2026-09-16 18:03:05 +02:00
Jenkinsfile Route publications through independent renderer plugins 2026-09-16 20:08:22 +02:00
LICENSE.md New licences 2026-09-15 15:05:13 +02:00
README.md Expose consumables report command 2026-09-17 16:03:25 +02:00
beffroi.sh Expose consumables report command 2026-09-17 16:03:25 +02:00
bootstrap.sh Format Beffroi shell scripts and record local verification 2026-09-16 21:07:18 +02:00

README.md

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.