cli

Documentation

Overview

Package cli assembles the kubesplaining cobra commands that drive the collect → analyze → report pipeline and its supporting utilities.

Index

• func NewCreateExclusionsCmd() *cobra.Command
• func NewDownloadCmd(build BuildInfo) *cobra.Command
• func NewReportCmd() *cobra.Command
• func NewRootCmd(build BuildInfo) *cobra.Command
• func NewScanCmd(build BuildInfo) *cobra.Command
• func NewScanResourceCmd() *cobra.Command
• func NewVersionCmd(build BuildInfo) *cobra.Command
• type BuildInfo

Functions

func NewCreateExclusionsCmd

func NewCreateExclusionsCmd() *cobra.Command

NewCreateExclusionsCmd returns the "create-exclusions-file" subcommand, which emits a starter exclusions YAML from a preset and can pre-populate system namespaces discovered in an existing snapshot.

func NewDownloadCmd

func NewDownloadCmd(build BuildInfo) *cobra.Command

NewDownloadCmd returns the "download" subcommand, which collects a live cluster snapshot and writes it to a JSON file for later offline analysis.

func NewReportCmd

func NewReportCmd() *cobra.Command

NewReportCmd returns the "report" subcommand, which regenerates HTML/JSON/CSV/SARIF artifacts from a previously produced findings JSON file without re-running analysis.

func NewRootCmd

func NewRootCmd(build BuildInfo) *cobra.Command

NewRootCmd builds the top-level kubesplaining command with all subcommands attached.

func NewScanCmd

func NewScanCmd(build BuildInfo) *cobra.Command

NewScanCmd returns the "scan" subcommand, which runs the full analyzer pipeline against either a live cluster or a previously collected snapshot and emits reports.

func NewScanResourceCmd

func NewScanResourceCmd() *cobra.Command

NewScanResourceCmd returns the "scan-resource" subcommand, which analyzes a single Kubernetes manifest file offline without requiring cluster access.

func NewVersionCmd

func NewVersionCmd(build BuildInfo) *cobra.Command

NewVersionCmd returns a command that prints embedded build information and exits.

Types

type BuildInfo

type BuildInfo struct {
	Version string
	Commit  string
	Date    string
}

BuildInfo carries the binary's version, git commit, and build date for the version and help output.