cli

package
v27.3.1-patch2+incompa... Latest Latest
Warning

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

 Go to latest Published: Oct 12, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

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(maxArgs int) cobra.PositionalArgs

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

func RequiresMinArgs 

func RequiresMinArgs(minArgs int) cobra.PositionalArgs

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

func RequiresRangeArgs 

func RequiresRangeArgs(minArgs int, maxArgs 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.

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 *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

Source Files

View all Source files

Directories

Path Synopsis
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
builder
checkpoint
commands
completion
config
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
container
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
context
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
formatter
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
formatter/tabwriter
idresolver
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
image
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
image/build
inspect
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
manifest
network
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
node
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
plugin
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
registry
secret
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
service
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
service/progress
stack
stack/formatter
stack/loader
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
stack/options
stack/swarm
swarm
swarm/progress
system
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
task
trust
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
volume
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
compose
convert
interpolation
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
loader
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
schema
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
schema/data
template
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
types
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
configfile
credentials
types
Package connhelper provides helpers for connecting to a remote daemon host with custom logic.
 Package connhelper provides helpers for connecting to a remote daemon host with custom logic.
commandconn
Package commandconn provides a net.Conn implementation that can be used for proxying (or emulating) stream via a custom command.
 Package commandconn provides a net.Conn implementation that can be used for proxying (or emulating) stream via a custom command.
ssh
Package ssh provides the connection helper for ssh:// URL.
 Package ssh provides the connection helper for ssh:// URL.
docker
store
Package store provides a generic way to store credentials to connect to virtually any kind of remote system.
 Package store provides a generic way to store credentials to connect to virtually any kind of remote system.
internal
oauth
oauth/api
FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
 FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
oauth/manager
manifest
store
types
registry
client
Package winresources is used to embed Windows resources into docker.exe.
 Package winresources is used to embed Windows resources into docker.exe.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.