report

Documentation

Overview

Package report renders scan results as a human-readable table.

Index

• Variables
• func PrintBanner(version string, dbRecords int)
• func PrintCSV(res *scanner.Result)
• func PrintCycloneDX(toolVersion string, res *scanner.Result)
• func PrintHTML(res *scanner.Result)
• func PrintJSONL(res *scanner.Result)
• func PrintJUnit(version string, res *scanner.Result)
• func PrintMarkdown(res *scanner.Result)
• func PrintSARIF(version string, res *scanner.Result)
• func PrintSummary(res *scanner.Result)
• func PrintTable(res *scanner.Result, verbose bool, minSeverity string)
• func WriteCSV(w io.Writer, res *scanner.Result) error
• func WriteHTML(w io.Writer, res *scanner.Result) error
• func WriteJUnit(w io.Writer, version string, res *scanner.Result) error
• func WriteMarkdown(w io.Writer, res *scanner.Result)

Variables

var NoColor bool

NoColor forces plain output without ANSI codes even when stdout is a terminal (used by --format cli-no-colour).

Functions

func PrintBanner

func PrintBanner(version string, dbRecords int)

PrintBanner prints the startup banner (nuclei-style MOTD).

func PrintCSV

func PrintCSV(res *scanner.Result)

PrintCSV writes res as CSV to stdout.

func PrintCycloneDX

func PrintCycloneDX(toolVersion string, res *scanner.Result)

PrintCycloneDX writes res as a CycloneDX 1.5 JSON BOM to stdout: one application component per detected plugin/theme, ordered by slug then type, with onyx:type properties. Target-controlled strings are stripped of control characters and length-capped before embedding so a hostile target cannot corrupt the document.

func PrintHTML

func PrintHTML(res *scanner.Result)

PrintHTML prints the result as a standalone HTML page to stdout.

func PrintJSONL

func PrintJSONL(res *scanner.Result)

PrintJSONL prints res as JSON Lines: one compact JSON object per finding.

func PrintJUnit

func PrintJUnit(version string, res *scanner.Result)

PrintJUnit prints the result as JUnit XML to stdout.

func PrintMarkdown

func PrintMarkdown(res *scanner.Result)

PrintMarkdown prints the result as Markdown to stdout.

func PrintSARIF

func PrintSARIF(version string, res *scanner.Result)

PrintSARIF writes res as a minimal SARIF 2.1.0 report: a single run whose tool driver is "onyx" and whose results are the scan findings.

func PrintSummary

func PrintSummary(res *scanner.Result)

PrintSummary prints the scan summary section (table formats).

func PrintTable

func PrintTable(res *scanner.Result, verbose bool, minSeverity string)

PrintTable prints res to stdout. Default is a compact per-component summary; pass verbose=true for the full one-line-per-finding listing. minSeverity filters findings below the given rating ("critical", "high", "medium", "low").

func WriteCSV

func WriteCSV(w io.Writer, res *scanner.Result) error

func WriteHTML

func WriteHTML(w io.Writer, res *scanner.Result) error

WriteHTML renders res as a standalone HTML page with inline CSS — no external assets. Every target-derived string is HTML-escaped.

func WriteJUnit

func WriteJUnit(w io.Writer, version string, res *scanner.Result) error

WriteJUnit writes res as JUnit XML: one failing testcase per recorded vulnerability, grouped into one testsuite per vulnerable component. A clean scan produces a single passing testcase so CI systems always see a structurally valid report. encoding/xml escapes every field.

func WriteMarkdown

func WriteMarkdown(w io.Writer, res *scanner.Result)

WriteMarkdown renders res as a self-contained Markdown document.