Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

cmd

package

Go to main page

Versions in this module

v1

v1.4.0

Apr 3, 2026

v1.3.0

Mar 23, 2026

Changes in this version

+ func ValidDeviceTypes(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

v1.2.2

Feb 12, 2026

Changes in this version

+ const DiffFormatHTML

+ const DiffModeSideBySide

+ const DiffModeUnified

+ func ValidDiffModes(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

v1.2.0

Feb 11, 2026

Changes in this version

+ const DiffFormatJSON

+ const DiffFormatMarkdown

+ const DiffFormatTerminal

+ const SanitizeModeAggressive

+ const SanitizeModeMinimal

+ const SanitizeModeModerate

+ var ErrInvalidSanitizeMode = errors.New("invalid sanitize mode")

+ func ValidDiffFormats(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

+ func ValidDiffSections(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

+ func ValidSanitizeModes(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

v1.1.0

Feb 3, 2026

Changes in this version

+ const ExitConfigValidationError

+ const ExitFileError

+ const ExitGeneralError

+ const ExitParseError

+ const ExitSuccess

+ const ExitValidationError

+ const FormatJSON

+ const FormatMarkdown

+ const FormatYAML

+ const MaxWrapWidth

+ const MinWrapWidth

+ var ErrUnsupportedOutputFormat = errors.New("unsupported output format")

+ func DetermineExitCode(err error) int

+ func ExitWithCode(code int)

+ func FormatExamples(examples string) string

+ func GetFlagObjectsByCategory(cmd *cobra.Command) map[string][]*pflag.Flag

+ func GetSuggestions(cmd *cobra.Command, arg string) []string

+ func InitHelp(cmd *cobra.Command)

+ func JSONSuccess(message, file string)

+ func OutputJSONError(err error, file string, exitCode int)

+ func SetCommandContext(cmd *cobra.Command, cmdCtx *CommandContext)

+ func ValidAuditModes(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

+ func ValidAuditPlugins(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

+ func ValidColorModes(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

+ func ValidFormats(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

+ func ValidSections(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

+ func ValidThemes(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

+ func ValidXMLFiles(_ *cobra.Command, _ []string, toComplete string) ([]string, cobra.ShellCompDirective)

+ type CommandContext struct

+ Config *config.Config

+ Logger *log.Logger

+ func GetCommandContext(cmd *cobra.Command) *CommandContext

+ func MustGetCommandContext(cmd *cobra.Command) *CommandContext

+ type ConfigShowOutput struct

+ Values []ConfigValue

+ type ConfigValue struct

+ Key string

+ Source string

+ Value any

+ type JSONError struct

+ Code int

+ Details map[string]any

+ Error string

+ File string

+ Type string

v1.0.0

Aug 4, 2025

Changes in this version

+ var Cfg *config.Config

+ var ErrFailedToEnrichConfig = errors.New("failed to enrich configuration")

+ var ErrOperationCancelled = errors.New("operation cancelled by user")

+ var ErrUnsupportedAuditMode = errors.New("unsupported audit mode")

+ func GetConfig() *config.Config

+ func GetFlagsByCategory(cmd *cobra.Command) map[string][]string

+ func GetLogger() *log.Logger

+ func GetRootCmd() *cobra.Command