▽

Package cli

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) (opts *cliflags.ClientOptions, helpCmd *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.

type Errors ¶

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.

type Errors []error

func (Errors) Error ¶

func (errList Errors) Error() string

type StatusError ¶

StatusError reports an unsuccessful exit by a command.

type StatusError struct {
    Status     string
    StatusCode int
}

func (StatusError) Error ¶

func (e StatusError) Error() string

type TopLevelCommand ¶

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

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

func NewTopLevelCommand ¶

func NewTopLevelCommand(cmd *cobra.Command, dockerCli *command.DockerCli, opts *cliflags.ClientOptions, flags *pflag.FlagSet) *TopLevelCommand

NewTopLevelCommand returns a new TopLevelCommand object

func (*TopLevelCommand) HandleGlobalFlags ¶

func (tcmd *TopLevelCommand) HandleGlobalFlags() (*cobra.Command, []string, error)

HandleGlobalFlags takes care of parsing global flags defined on the command, it returns the underlying cobra command and the args it will be called with (or an error).

On success the caller is responsible for calling Initialize() before calling `Execute` on the returned command.

func (*TopLevelCommand) Initialize ¶

func (tcmd *TopLevelCommand) Initialize(ops ...command.CLIOption) error

Initialize finalises global option parsing and initializes the docker client.

func (*TopLevelCommand) SetArgs ¶

func (tcmd *TopLevelCommand) SetArgs(args []string)

SetArgs sets the args (default os.Args[:1] used to invoke the command

func (*TopLevelCommand) SetFlag ¶

func (tcmd *TopLevelCommand) SetFlag(name, value string)

SetFlag sets a flag in the local flag set of the top-level command

Subdirectories