cli

package
v1.12.2-rc3 Latest Latest
Warning

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

Go to latest
Published: Oct 6, 2016 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var DockerCommandUsage = []Command{
	{"exec", "Run a command in a running container"},
	{"info", "Display system-wide information"},
	{"inspect", "Return low-level information on a container, image or task"},
	{"update", "Update configuration of one or more containers"},
}

DockerCommandUsage lists the top level docker commands and their short usage

View Source
var DockerCommands = make(map[string]Command)

DockerCommands stores all the docker command

Functions

func ExactArgs added in v1.12.0

func ExactArgs(number int) cobra.PositionalArgs

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

func FlagErrorFunc added in v1.12.0

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

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

func NoArgs added in v1.12.0

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

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

func RequiresMaxArgs added in v1.12.0

func RequiresMaxArgs(max int) cobra.PositionalArgs

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

func RequiresMinArgs added in v1.12.0

func RequiresMinArgs(min int) cobra.PositionalArgs

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

func RequiresRangeArgs added in v1.12.0

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 Subcmd

func Subcmd(name string, synopses []string, description string, exitOnError bool) *flag.FlagSet

Subcmd is a subcommand of the main "docker" command. A subcommand represents an action that can be performed from the Docker command line client.

To see all available subcommands, run "docker --help".

Types

type Cli

type Cli struct {
	Stderr io.Writer

	Usage func()
	// contains filtered or unexported fields
}

Cli represents a command line interface.

func New

func New(handlers ...Handler) *Cli

New instantiates a ready-to-use Cli.

func (*Cli) CmdHelp

func (cli *Cli) CmdHelp(args ...string) error

CmdHelp displays information on a Docker command.

If more than one command is specified, information is only shown for the first command.

Usage: docker help COMMAND or docker COMMAND --help

func (*Cli) Command added in v1.12.0

func (cli *Cli) Command(name string) func(...string) error

Command returns a command handler, or nil if the command does not exist

func (*Cli) Run

func (cli *Cli) Run(args ...string) error

Run executes the specified command.

type Command added in v1.9.0

type Command struct {
	Name        string
	Description string
}

Command is the struct containing the command name and description

type Errors added in v1.12.0

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 added in v1.12.0

func (errList Errors) Error() string

type Handler

type Handler interface {
	Command(name string) func(...string) error
}

Handler holds the different commands Cli will call It should have methods with names starting with `Cmd` like:

func (h myHandler) CmdFoo(args ...string) error

type Initializer

type Initializer interface {
	Initialize() error
}

Initializer can be optionally implemented by a Handler to initialize before each call to one of its commands.

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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL