Reproducible Beffroi diagnostics and reporting workspace, pinning the collector, report archive and renderer into one workflow.
Go to file
Dandaedre 22a6d477c5
Route reports and diagnostics through Typst plugin IR
2026-09-16 18:54:30 +02:00
docs Integrate diagnostic plugin and retire analysis submodule 2026-09-16 18:03:05 +02:00
reporter@2eebf62f12 Route reports and diagnostics through Typst plugin IR 2026-09-16 18:54:30 +02:00
reports@c42ba8c095 Route reports and diagnostics through Typst plugin IR 2026-09-16 18:54:30 +02:00
scripts Route reports and diagnostics through Typst plugin IR 2026-09-16 18:54:30 +02:00
.gitignore Render stored reports directly from native YAML 2026-09-16 17:23:32 +02:00
.gitmodules Integrate diagnostic plugin and retire analysis submodule 2026-09-16 18:03:05 +02:00
AGENT-TASKS.md Integrate diagnostic plugin and retire analysis submodule 2026-09-16 18:03:05 +02:00
Jenkinsfile ci: publish archives to work reports directory 2026-09-16 02:20:30 +02:00
LICENSE.md New licences 2026-09-15 15:05:13 +02:00
README.md Route reports and diagnostics through Typst plugin IR 2026-09-16 18:54:30 +02:00
beffroi.sh Route reports and diagnostics through Typst plugin IR 2026-09-16 18:54:30 +02:00
bootstrap.sh Integrate diagnostic plugin and retire analysis submodule 2026-09-16 18:03:05 +02:00

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. To select a built-in palette in YAML, set branding.theme to default or teal; an explicit theme object is also supported.

Generate one diagnostic report

Render a normalized diagnostic JSON v1 through the shared Reportist engine:

./beffroi.sh diagnostic-pdf diagnostic.json diagnostic.pdf

Set DIAGNOSTICS_THEME=default, cic, or eridani to choose a bundled palette. Reportist can also emit its JSON intermediate directly:

./beffroi.sh report diagnostic.json diagnostic.pdf \
  --plugin reports/plugins/diagnostics --plugin-input theme=cic \
  --emit-ir diagnostic.report.json

For a raw WinDiagnostics capture, run ./beffroi.sh capture-pdf capture.json diagnostic.pdf. This analyzes the capture first, then renders the diagnostic. For a persistent evidence-backed draft generation, run:

./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 generation includes normalized diagnostic JSON, a Reportist JSON draft, evidence snapshots, a hash manifest, and a PDF. Custom reports can use the same tables, progress bars, finding lists, and section page breaks; see reporter/examples/diagnostic-style.yaml.

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

Stored report YAML is validated and rendered directly. Use --include-json to export structured report JSON beside report PDFs and the original diagnostic JSON beside diagnostic PDFs. Packaging includes these JSON files, which is useful for downstream automation:

./beffroi.sh all build/publication --include-json

Jenkins runs the same build and publishes AES-encrypted Reports.zip and Diagnostics.zip archives from main into the dedicated work_reports destination.

Commands

./beffroi.sh report INPUT OUTPUT.pdf [Reportist options]
./beffroi.sh diagnostic-pdf DIAGNOSTIC.json OUTPUT.pdf
./beffroi.sh capture-pdf CAPTURE OUTPUT.pdf
./beffroi.sh diagnostic CAPTURE EVIDENCE_ROOT OUTPUT_DIR REFERENCE_TIME TITLE AUTHOR DATE
./beffroi.sh all NEW_OUTPUT_DIR [--include-json]
./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.