util

Documentation

Index

• Variables
• func SubCmdRunE(name string) func(*cobra.Command, []string) error
• func ValidateExactArgNumber(args []string, supportedArgs []string) error

Variables

var (
	// AlphaDisclaimer to be places at the end of description of commands in alpha release
	AlphaDisclaimer = `
		Alpha Disclaimer: this command is currently alpha.
	`

	// MacroCommandLongDescription provide a standard description for "macro" commands
	MacroCommandLongDescription = normalizer.LongDesc(`
		This command is not meant to be run on its own. See list of available subcommands.
	`)
)

Functions

func SubCmdRunE

func SubCmdRunE(name string) func(*cobra.Command, []string) error

SubCmdRunE returns a function that handles a case where a subcommand must be specified Without this callback, if a user runs just the command without a subcommand, or with an invalid subcommand, cobra will print usage information, but still exit cleanly. We want to return an error code in these cases so that the user knows that their command was invalid.

func ValidateExactArgNumber

func ValidateExactArgNumber(args []string, supportedArgs []string) error

ValidateExactArgNumber validates that the required top-level arguments are specified