|
Beffroi Reporting CI A component or integration check failed.
Beffroi/beffroi-reporting/pipeline/head There was a failure building this commit
Details
|
||
|---|---|---|
| diagnostics@caa17cc575 | ||
| docs | ||
| reporter@fe421e4ffa | ||
| reports@5cf1945f56 | ||
| scripts | ||
| .gitignore | ||
| .gitmodules | ||
| Jenkinsfile | ||
| LICENSE.md | ||
| README.md | ||
| beffroi.sh | ||
| bootstrap.sh | ||
README.md
Beffroi Reporting
Beffroi Reporting turns structured reports and Windows diagnostic captures into
PDFs. The root beffroi.sh command is the main entry point.
Generate one personal report
Write a Reportist YAML or JSON file, then run:
./beffroi.sh report my-report.yaml my-report.pdf
See reporter/examples for complete inputs.
Generate one diagnostic report
./beffroi.sh diagnostic \
capture.json /path/to/evidence /path/to/new-output \
2026-09-15T12:00:00Z 'Diagnostic review' 'Reviewer Name' 2026-09-15
The output contains the normalized diagnostic, evidence-backed draft generation, and rendered PDF.
Generate every stored PDF
Add report YAML files under
reports/reports
or diagnostic JSON captures under
reports/diagnostics,
commit them with the reports submodule update, and run:
./beffroi.sh all build/publication
Jenkins runs the same build and publishes encrypted report archives from main.
Commands
./beffroi.sh report INPUT OUTPUT.pdf
./beffroi.sh diagnostic CAPTURE EVIDENCE_ROOT OUTPUT_DIR REFERENCE_TIME TITLE AUTHOR DATE
./beffroi.sh all NEW_OUTPUT_DIR
./beffroi.sh package BUILD_DIR ARTIFACT_DIR
./beffroi.sh test
./beffroi.sh bootstrap
./beffroi.sh doctor
The command reports missing tools for the requested operation. See
docs/development.md for repository structure, testing,
publication details, and component development.