core

Documentation

Overview

Package core orchestrates the NVCheckup diagnostic pipeline.

Run is strictly read-only: it collects, analyzes and redacts, but never changes system state. Anything that modifies the machine lives behind 'nvcheckup fix' in the remediate package.

Index

• func ExitCodeFor(r *types.Report) int
• func Run(cfg types.RunConfig, verbose bool, printFn func(string)) (*types.Report, error)
• func WriteReport(r *types.Report, cfg types.RunConfig) ([]string, error)

Functions

func ExitCodeFor

func ExitCodeFor(r *types.Report) int

ExitCodeFor maps a report's findings to the CLI exit code contract shared by 'run' and 'doctor': 0 clean, 1 warnings, 2 at least one critical finding.

func Run

func Run(cfg types.RunConfig, verbose bool, printFn func(string)) (*types.Report, error)

Run executes the full diagnostic pipeline and returns the completed report. Network probes (ping/traceroute/DNS) run only when cfg.NetworkTest is set, regardless of mode, because they contact external hosts and take 30-60 s.

func WriteReport

func WriteReport(r *types.Report, cfg types.RunConfig) ([]string, error)

WriteReport writes the report to the output directory in all requested formats.