cli

package
v24.0.0-beta.2+incompa... Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 14, 2023 License: Apache-2.0 Imports: 17 Imported by: 2,998

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DisableFlagsInUseLine 

func DisableFlagsInUseLine(cmd *cobra.Command)

DisableFlagsInUseLine sets the DisableFlagsInUseLine flag on all commands within the tree rooted at cmd.

func ExactArgs 

func ExactArgs(number int) cobra.PositionalArgs

ExactArgs returns an error if there is not the exact number of args

func FlagErrorFunc 

func FlagErrorFunc(cmd *cobra.Command, err error) error

FlagErrorFunc prints an error message which matches the format of the docker/cli/cli error messages

func HasCompletionArg 

func HasCompletionArg(args []string) bool

HasCompletionArg returns true if a cobra completion arg request is found.

func NoArgs 

func NoArgs(cmd *cobra.Command, args []string) error

NoArgs validates args and returns an error if there are any args

func RequiresMaxArgs 

func RequiresMaxArgs(max int) cobra.PositionalArgs

RequiresMaxArgs returns an error if there is not at most max args

func RequiresMinArgs 

func RequiresMinArgs(min int) cobra.PositionalArgs

RequiresMinArgs returns an error if there is not at least min args

func RequiresRangeArgs 

func RequiresRangeArgs(min int, max int) cobra.PositionalArgs

RequiresRangeArgs returns an error if there is not at least min args and at most max args

func SetupPluginRootCommand 

func SetupPluginRootCommand(rootCmd *cobra.Command) (*cliflags.ClientOptions, *pflag.FlagSet)

SetupPluginRootCommand sets default usage, help and error handling for a plugin root command.

func SetupRootCommand 

func SetupRootCommand(rootCmd *cobra.Command) (*cliflags.ClientOptions, *pflag.FlagSet, *cobra.Command)

SetupRootCommand sets default usage, help, and error handling for the root command.

func VisitAll 

func VisitAll(root *cobra.Command, fn func(*cobra.Command))

VisitAll will traverse all commands from the root. This is different from the VisitAll of cobra.Command where only parents are checked.

Types

type Errors 

type Errors []error

Errors is a list of errors. Useful in a loop if you don't want to return the error right away and you want to display after the loop, all the errors that happened during the loop.

func (Errors) Error 

func (errList Errors) Error() string

type StatusError 

type StatusError struct {
	Status     string
	StatusCode int
}

StatusError reports an unsuccessful exit by a command.

func (StatusError) Error 

func (e StatusError) Error() string

type TopLevelCommand 

type TopLevelCommand struct {
	// contains filtered or unexported fields
}

TopLevelCommand encapsulates a top-level cobra command (either docker CLI or a plugin) and global flag handling logic necessary for plugins.

func NewTopLevelCommand 

func NewTopLevelCommand(cmd *cobra.Command, dockerCli *