cli

Documentation

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 RequiresMinMaxArgs(min int, max int) cobra.PositionalArgs
• func Subcmd(name string, synopses []string, description string, exitOnError bool) *flag.FlagSet
• type Cli
  • func New(handlers ...Handler) *Cli
  • func (cli *Cli) CmdHelp(args ...string) error
  • func (cli *Cli) Command(name string) func(...string) error
  • func (cli *Cli) Run(args ...string) error
• type Command
• type Handler
• type Initializer
• type StatusError
  • func (e StatusError) Error() string

Variables

var DockerCommandUsage = []Command{
	{"commit", "Create a new image from a container's changes"},
	{"cp", "Copy files/folders between a container and the local filesystem"},
	{"exec", "Run a command in a running container"},
	{"info", "Display system-wide information"},
	{"inspect", "Return low-level information on a container or image"},
	{"load", "Load an image from a tar archive or STDIN"},
	{"login", "Log in to a Docker registry"},
	{"logout", "Log out from a Docker registry"},
	{"ps", "List containers"},
	{"pull", "Pull an image or a repository from a registry"},
	{"push", "Push an image or a repository to a registry"},
	{"save", "Save one or more images to a tar archive"},
	{"update", "Update configuration of one or more containers"},
}

DockerCommandUsage lists the top level docker commands and their short usage

var DockerCommands = make(map[string]Command)

DockerCommands stores all the docker command

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 messages which matches the format of the docker/docker/cli error messages

func NoArgs

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

NoArgs validate 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 RequiresMinMaxArgs

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

RequiresMinMaxArgs 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

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

type Command struct {
	Name        string
	Description string
}

Command is the struct containing the command name and description

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