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]

Argument	Description	Default
PATH	Path to the project root.	.

Flags

Flag	Description
--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

Related

• 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.

Command reference

Generated from vulkro help summary on vulkro 0.26.0. This block is the authoritative flag, usage, and exit-code reference for this command; the prose above is the friendly explanation. Do not edit this block by hand; run npm run docs:cli after a release.

Print a short, shareable summary of a scan, worst findings first.

Produce a concise, shareable executive summary of a scan.

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 (see `vulkro explain --risk-model`).

This is a LOCAL report: no finding data leaves the machine. The Markdown format is meant for pasting into a wrap-up doc or a case study ("Vulkro caught N exploitable issues"). It is a reporting view, not a gate, so it does NOT exit 1 on findings.

The count matches `vulkro scan`: the same default confidence floor and unreachable-code suppression are applied. `--all-confidence` reports the raw pool instead, labelled with both numbers.

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

Usage: vulkro summary [OPTIONS] [PATH]

Arguments:
  [PATH]
          Path to the project root (default: current directory)
          
          [default: .]

Options:
      --format <FORMAT>
          Output format: `text` (default terminal view), `md` (Markdown for pasting into a doc), or `json` (the SummaryReport structure)

          Possible values:
          - text: Clean terminal view (default)
          - md:   Markdown, ready to paste into a wrap-up doc or case study
          - json: The `SummaryReport` structure as JSON for tooling
          
          [default: text]

      --offline
          Hard-disable every outbound network call for this run (sets VULKRO_OFFLINE=1). Blocks the CVE feed, the license heartbeat, the update check, webhooks, and any cloud AI endpoint; a loopback model (http://127.0.0.1, http://localhost) is still allowed. Equivalent to exporting VULKRO_OFFLINE=1, and the flag wins when both are set

      --top <TOP>
          How many top risk-ranked issues to include in the "what to fix first" list
          
          [default: 5]

      --all-confidence
          Report every finding instead of the set `vulkro scan` shows by default. The report labels the number so the two surfaces never disagree silently

  -o, --output <FILE>
          Write the report to a file instead of stdout

  -h, --help
          Print help (see a summary with '-h')