package cli

import "github.com/docker/cli/components/cli/cli"

Index ¶

• Variables
• func ExactArgs(number int) cobra.PositionalArgs
• func FlagErrorFunc(cmd *cobra.Command, err error) error
• func NoArgs(cmd *cobra.Command, args []string) error
• func RequiresMaxArgs(max int) cobra.PositionalArgs
• func RequiresMinArgs(min int) cobra.PositionalArgs
• func RequiresRangeArgs(min int, max int) cobra.PositionalArgs
• func SetupRootCommand(rootCmd *cobra.Command)
• func UseLine(cmd *cobra.Command) string
• type Errors
• func (errList Errors) Error() string
• type StatusError
• func (e StatusError) Error() string

Variables ¶

var (
	PlatformName = ""
	Version      = "unknown-version"
	GitCommit    = "unknown-commit"
	BuildTime    = "unknown-buildtime"
)

Default build-time variable. These values are overriding via ldflags

Functions ¶

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 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 SetupRootCommand ¶

func SetupRootCommand(rootCmd *cobra.Command)

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

func UseLine ¶

func UseLine(cmd *cobra.Command) string

UseLine returns the usage line for a command. This implementation is different from the default Command.UseLine in that it does not add a `[flags]` to the end of the line.

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

Source Files ¶

cobra.go error.go required.go version.go

Directories ¶