Skip to main content

vulkro summary

Produce a concise, shareable executive summary of a scan.

vulkro summary scans PATH, then renders a wrap-up: total findings by severity, coverage (languages / files / modules / endpoints), scan metadata (version, date, duration), and a deterministic "what to fix first" list of the top risk-ranked issues.

This is a reporting view, not a gate: it does not exit 1 on findings.

Usage

vulkro summary [PATH]
ArgumentDescriptionDefault
PATHPath to the project root..

Flags

FlagDescription
--format <FORMAT>text (default terminal view), md (Markdown for pasting into a doc), or json (the SummaryReport structure).
--top <TOP>How many top risk-ranked issues to include in the "what to fix first" list. Default 5.
--output, -o <FILE>Write the report to a file instead of stdout.

Privacy

This is a local report. No finding data leaves the machine.

Exit codes

  • 0 report produced (with or without findings).
  • 2 error: path not found, IO failure, or internal error.

Examples

# Terminal wrap-up of the current project.
vulkro summary .

# Markdown with the top 10 issues, written to a file.
vulkro summary . --format md --top 10 -o wrapup.md

# Structured report for tooling.
vulkro summary . --format json
  • vulkro scan - the full pipeline that gates on findings.
  • vulkro explain - per-rule explainers, including --risk-model for how the ranking is computed.
  • vulkro report - the longer report renderer.