command

Documentation

Index

• func AddTrustedFlags(fs *pflag.FlagSet, verify bool)
• func ConfigureAuth(cli *DockerCli, flUser, flPassword, serverAddress string, ...) (types.AuthConfig, error)
• func CopyToFile(outfile string, r io.Reader) error
• func ElectAuthServer(ctx context.Context, cli *DockerCli) string
• func EncodeAuthToBase64(authConfig types.AuthConfig) (string, error)
• func IsTrusted() bool
• func LoadDefaultConfigFile(err io.Writer) *configfile.ConfigFile
• func NewAPIClientFromFlags(opts *cliflags.CommonOptions, configFile *configfile.ConfigFile) (client.APIClient, error)
• func PrettyPrint(i interface{}) string
• func PromptForConfirmation(ins *InStream, outs *OutStream, message string) bool
• func RegistryAuthenticationPrivilegedFunc(cli *DockerCli, index *registrytypes.IndexInfo, cmdName string) types.RequestPrivilegeFunc
• func ResolveAuthConfig(ctx context.Context, cli *DockerCli, index *registrytypes.IndexInfo) types.AuthConfig
• func RetrieveAuthTokenFromImage(ctx context.Context, cli *DockerCli, image string) (string, error)
• func UserAgent() string
• type DockerCli
  • func NewDockerCli(in io.ReadCloser, out, err io.Writer) *DockerCli
  • func (cli *DockerCli) Client() client.APIClient
  • func (cli *DockerCli) ConfigFile() *configfile.ConfigFile
  • func (cli *DockerCli) CredentialsStore() credentials.Store
  • func (cli *DockerCli) Err() io.Writer
  • func (cli *DockerCli) HasExperimental() bool
  • func (cli *DockerCli) In() *InStream
  • func (cli *DockerCli) Initialize(opts *cliflags.ClientOptions) error
  • func (cli *DockerCli) Out() *OutStream
• type EventHandler
  • func InitEventHandler() EventHandler
• type InStream
  • func NewInStream(in io.ReadCloser) *InStream
  • func (i *InStream) CheckTty(attachStdin, ttyMode bool) error
  • func (i *InStream) Close() error
  • func (i *InStream) FD() uintptr
  • func (i *InStream) IsTerminal() bool
  • func (i *InStream) Read(p []byte) (int, error)
  • func (i *InStream) RestoreTerminal()
  • func (i *InStream) SetRawTerminal() (err error)
• type OutStream
  • func NewOutStream(out io.Writer) *OutStream
  • func (o *OutStream) FD() uintptr
  • func (o *OutStream) GetTtySize() (uint, uint)
  • func (o *OutStream) IsTerminal() bool
  • func (o *OutStream) RestoreTerminal()
  • func (o *OutStream) SetRawTerminal() (err error)
  • func (o *OutStream) Write(p []byte) (int, error)
• type Streams

Functions

func AddTrustedFlags

func AddTrustedFlags(fs *pflag.FlagSet, verify bool)

AddTrustedFlags adds content trust flags to the current command flagset

func ConfigureAuth

func ConfigureAuth(cli *DockerCli, flUser, flPassword, serverAddress string, isDefaultRegistry bool) (types.AuthConfig, error)

ConfigureAuth returns an AuthConfig from the specified user, password and server.

func CopyToFile

func CopyToFile(outfile string, r io.Reader) error

CopyToFile writes the content of the reader to the specified file

func ElectAuthServer

func ElectAuthServer(ctx context.Context, cli *DockerCli) string

ElectAuthServer returns the default registry to use (by asking the daemon)

func EncodeAuthToBase64

func EncodeAuthToBase64(authConfig types.AuthConfig) (string, error)

EncodeAuthToBase64 serializes the auth configuration as JSON base64 payload

func IsTrusted

func IsTrusted() bool

IsTrusted returns true if content trust is enabled

func LoadDefaultConfigFile

func LoadDefaultConfigFile(err io.Writer) *configfile.ConfigFile

LoadDefaultConfigFile attempts to load the default config file and returns an initialized ConfigFile struct if none is found.

func NewAPIClientFromFlags

func NewAPIClientFromFlags(opts *cliflags.CommonOptions, configFile *configfile.ConfigFile) (client.APIClient, error)

NewAPIClientFromFlags creates a new APIClient from command line flags

func PrettyPrint

func PrettyPrint(i interface{}) string

PrettyPrint outputs arbitrary data for human formatted output by uppercasing the first letter.

func PromptForConfirmation

func PromptForConfirmation(ins *InStream, outs *OutStream, message string) bool

PromptForConfirmation requests and checks confirmation from user. This will display the provided message followed by ' y/N '. If the user input 'y' or 'Y' it returns true other false. If no message is provided "Are you sure you want to proceed? y/N " will be used instead.

func RegistryAuthenticationPrivilegedFunc

func RegistryAuthenticationPrivilegedFunc(cli *DockerCli, index *registrytypes.IndexInfo, cmdName string) types.RequestPrivilegeFunc

RegistryAuthenticationPrivilegedFunc returns a RequestPrivilegeFunc from the specified registry index info for the given command.

func ResolveAuthConfig

func ResolveAuthConfig(ctx context.Context, cli *DockerCli, index *registrytypes.IndexInfo) types.AuthConfig

ResolveAuthConfig is like registry.ResolveAuthConfig, but if using the default index, it uses the default index name for the daemon's platform, not the client's platform.

func RetrieveAuthTokenFromImage

func RetrieveAuthTokenFromImage(ctx context.Context, cli *DockerCli, image string) (string, error)

RetrieveAuthTokenFromImage retrieves an encoded auth token given a complete image

func UserAgent

func UserAgent() string

UserAgent returns the user agent string used for making API requests

Types

type DockerCli

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

DockerCli represents the docker command line client. Instances of the client can be returned from NewDockerCli.

func NewDockerCli

func NewDockerCli(in io.ReadCloser, out, err io.Writer) *DockerCli

NewDockerCli returns a DockerCli instance with IO output and error streams set by in, out and err.

func (*DockerCli) Client

func (cli *DockerCli) Client() client.APIClient

Client returns the APIClient

func (*DockerCli) ConfigFile

func (cli *DockerCli) ConfigFile() *configfile.ConfigFile

ConfigFile returns the ConfigFile

func (*DockerCli) CredentialsStore

func (cli *DockerCli) CredentialsStore() credentials.Store

CredentialsStore returns a new credentials store based on the settings provided in the configuration file.

func (*DockerCli) Err

func (cli *DockerCli) Err() io.Writer

Err returns the writer used for stderr

func (*DockerCli) HasExperimental

func (cli *DockerCli) HasExperimental() bool

HasExperimental returns true if experimental features are accessible

func (*DockerCli) In

func (cli *DockerCli) In() *InStream

In returns the reader used for stdin

func (*DockerCli) Initialize

func (cli *DockerCli) Initialize(opts *cliflags.ClientOptions) error

Initialize the dockerCli runs initialization that must happen after command line flags are parsed.

func (*DockerCli) Out

func (cli *DockerCli) Out() *OutStream

Out returns the writer used for stdout

type EventHandler

type EventHandler interface {
	Handle(action string, h func(eventtypes.Message))
	Watch(c <-chan eventtypes.Message)
}

EventHandler is abstract interface for user to customize own handle functions of each type of events

func InitEventHandler

func InitEventHandler() EventHandler

InitEventHandler initializes and returns an EventHandler

type InStream

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

InStream is an input stream used by the DockerCli to read user input

func NewInStream

func NewInStream(in io.ReadCloser) *InStream

NewInStream returns a new InStream object from a ReadCloser

func (*InStream) CheckTty

func (i *InStream) CheckTty(attachStdin, ttyMode bool) error

CheckTty checks if we are trying to attach to a container tty from a non-tty client input stream, and if so, returns an error.

func (*InStream) Close

func (i *InStream) Close() error

Close implements the Closer interface

func (*InStream) FD

func (i *InStream) FD() uintptr

FD returns the file descriptor number for this stream

func (*InStream) IsTerminal

func (i *InStream) IsTerminal() bool

IsTerminal returns true if this stream is connected to a terminal

func (*InStream) Read

func (i *InStream) Read(p []byte) (int, error)

func (*InStream) RestoreTerminal

func (i *InStream) RestoreTerminal()

RestoreTerminal restores normal mode to the terminal

func (*InStream) SetRawTerminal

func (i *InStream) SetRawTerminal() (err error)

SetRawTerminal sets raw mode on the input terminal

type OutStream

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

OutStream is an output stream used by the DockerCli to write normal program output.

func NewOutStream

func NewOutStream(out io.Writer) *OutStream

NewOutStream returns a new OutStream object from a Writer

func (*OutStream) FD

func (o *OutStream) FD() uintptr

FD returns the file descriptor number for this stream

func (*OutStream) GetTtySize

func (o *OutStream) GetTtySize() (uint, uint)

GetTtySize returns the height and width in characters of the tty

func (*OutStream) IsTerminal

func (o *OutStream) IsTerminal() bool

IsTerminal returns true if this stream is connected to a terminal

func (*OutStream) RestoreTerminal

func (o *OutStream) RestoreTerminal()

RestoreTerminal restores normal mode to the terminal

func (*OutStream) SetRawTerminal

func (o *OutStream) SetRawTerminal() (err error)

SetRawTerminal sets raw mode on the output terminal

func (*OutStream) Write

func (o *OutStream) Write(p []byte) (int, error)

type Streams

type Streams interface {
	In() *InStream
	Out() *OutStream
	Err() io.Writer
}

Streams is an interface which exposes the standard input and output streams