Documentation
¶
Overview ¶
Package cli contains the cobra command tree for the compliancekit binary. Each subcommand lives in its own file (version.go, doctor.go, scan.go, ...).
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type BigQueryArgs ¶ added in v1.17.0
type BigQueryArgs struct{ Project, Dataset, Location string }
Per-target argument structs let runWarehouseLoad route to the right Loader without ballooning the function signature.
type BuildInfo ¶
BuildInfo carries values injected via -ldflags at build time. It's passed in from main rather than read from package-level vars so the CLI package stays testable in isolation.
type ExitCodeError ¶
ExitCodeError wraps an error that should produce a specific process exit code in main(). Used for outcomes that are not "the tool failed" but still warrant non-zero exit -- e.g. a scan that ran successfully but produced findings at or above the configured fail-on severity.
main.go checks errors.As(err, *ExitCodeError) and uses Code; cobra just sees a normal error and propagates it up.
func NewExitCode ¶
func NewExitCode(code int, format string, args ...any) *ExitCodeError
NewExitCode returns an ExitCodeError with the given exit code and a formatted message.
func (*ExitCodeError) ExitCode ¶
func (e *ExitCodeError) ExitCode() int
ExitCode returns the intended process exit code.
type RedshiftArgs ¶ added in v1.17.0
type RedshiftArgs struct{ Cluster, Database, SecretARN, StageS3URI string }
type SnowflakeArgs ¶ added in v1.17.0
type SnowflakeArgs struct{ Account, Warehouse, Database, Schema, User, Password string }
Source Files
¶
- baseline.go
- checks.go
- checks_new.go
- demo_seed.go
- diff.go
- doctor.go
- doctor_probes.go
- evidence.go
- exit.go
- ingest.go
- mapping.go
- motd.go
- notify.go
- plugins.go
- policy.go
- push.go
- remediate.go
- render.go
- root.go
- scan.go
- scan_ingest.go
- scan_waivers.go
- serve.go
- serve_audit.go
- serve_oidc.go
- serve_saml.go
- serve_users.go
- style.go
- tui.go
- usage.go
- version.go
- waivers.go
- warehouse.go