Contact
Open source · Security & Privacy

Findings Report Builder

Build private and reviewed shareable findings reports from an offline case file.

v0.1.0 · Node.js 22+ · MIT AND BSD-2-Clause AND LicenseRef-Bitstream-Vera

Browse the public repository · View releases

Build an executive summary and a technical report, each as Markdown and PDF, from an analyst's local JSON case. CVSS v4.0 scores are computed offline from the supplied vectors. The tool executes no exploits, retrieves no evidence, and performs no retests.

This walkthrough uses the tool's public README and checked-in example files. Run the command from a repository checkout with Node.js 22+.

Run the checked-in example

node bin/findings-report-builder.mjs --input examples/pass/case.json --out-dir reports-pass
node bin/findings-report-builder.mjs --input examples/fail/case.json --out-dir reports-fail
node bin/findings-report-builder.mjs --input examples/shareable/case.json --out-dir reports-shareable --shareable
node bin/findings-report-builder.mjs --input examples/incomplete/case.json --out-dir reports-incomplete

Read the result

Stdout is one catalog JSON object. Diagnostics go to stderr. --help writes usage to stderr with empty stdout and exits 0. Missing, duplicate, or unknown options, and unsafe existing destinations, exit 2 with empty stdout. Once case evaluation begins, incomplete results emit catalog JSON and zero artifacts.