package
22.10.0+incompatible
Repository: https://github.com/crazy-max/docker-cli.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

AddPlatformFlag adds `platform` to a set of flags for API version 1.32 and later.
AddTrustSigningFlags adds "signing" flags to the provided flagset.
AddTrustVerificationFlags adds content trust flags to the provided flagset.
BuildKitEnabled returns whether buildkit is enabled either through a daemon setting or otherwise the client-side DOCKER_BUILDKIT environment variable.
ConfigureAuth handles prompting of user's username and password if needed.
CopyToFile writes the content of the reader to the specified file.
DefaultContextStoreConfig returns a new store.Config with the default set of endpoints configured.
ElectAuthServer returns the default registry to use (by asking the daemon).
EncodeAuthToBase64 serializes the auth configuration as JSON base64 payload.
GetDefaultAuthConfig gets the default auth config given a serverAddress If credentials for given serverAddress exists in the credential store, the configuration will be populated with values in it.
GetDockerContext extracts metadata from stored context metadata.
GetStackOrchestrator checks DOCKER_STACK_ORCHESTRATOR environment variable and configuration file orchestrator value and returns user defined Orchestrator.
InitEventHandler initializes and returns an EventHandler.
NewAPIClientFromFlags creates a new APIClient from command line flags.
NewDockerCli returns a DockerCli instance with all operators applied on it.
NormalizeOrchestrator parses an orchestrator value and checks if it is valid.
PrettyPrint outputs arbitrary data for human formatted output by uppercasing the first letter.
PromptForConfirmation requests and checks confirmation from user.
PruneFilters returns consolidated prune filters obtained from config.json and cli.
RegisterDefaultStoreEndpoints registers a new named endpoint metadata type with the default context store config, so that endpoint will be supported by stores using the config returned by DefaultContextStoreConfig.
RegistryAuthenticationPrivilegedFunc returns a RequestPrivilegeFunc from the specified registry index info for the given command.
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.
ResolveDefaultContext creates a Metadata for the current CLI invocation parameters.
RetrieveAuthTokenFromImage retrieves an encoded auth token given a complete image.
ShowHelp shows the command help.
StringSliceReplaceAt replaces the sub-slice old, with the sub-slice new, in the string slice s, returning a new slice and a boolean indicating if the replacement happened.
UserAgent returns the user agent string used for making API requests.
ValidateOutputPath validates the output paths of the `export` and `save` commands.
ValidateOutputPathFileMode validates the output paths of the `cp` command and serves as a helper to `ValidateOutputPath`.
WithCombinedStreams uses the same stream for the output and error streams.
WithContentTrust enables content trust on a cli.
WithContentTrustFromEnv enables content trust on a cli from environment variable DOCKER_CONTENT_TRUST value.
WithContextEndpointType add support for an additional typed endpoint in the context store Plugins should use this to store additional endpoints configuration in the context store.
WithErrorStream sets a cli error stream.
WithInitializeClient is passed to DockerCli.Initialize by callers who wish to set a particular API Client for use by the CLI.
WithInputStream sets a cli input stream.
WithOutputStream sets a cli output stream.
WithStandardStreams sets a cli in, out and err streams with the standard streams.

# Constants

DefaultContextName is the name reserved for the default context (config & env based).
OrchestratorAll orchestrator.
OrchestratorKubernetes orchestrator.
OrchestratorSwarm orchestrator.

# Variables

NewInStream returns a new InStream object from a ReadCloser Deprecated: Use github.com/crazy-max/docker-cli/cli/streams.NewIn instead.
NewOutStream returns a new OutStream object from a Writer Deprecated: Use github.com/crazy-max/docker-cli/cli/streams.NewOut instead.

# Structs

ClientInfo stores details about the supported features of the client.
ContextStoreWithDefault implements the store.Store interface with a support for the default context.
DefaultContext contains the default context data for all endpoints.
DockerCli is an instance the docker command line client.
DockerContext is a typed representation of what we put in Context metadata.
ServerInfo stores details about the supported features and platform of the server.

# Interfaces

Cli represents the docker command line client.
EndpointDefaultResolver is implemented by any EndpointMeta object which wants to be able to populate the store with whatever their default is.
EventHandler is abstract interface for user to customize own handle functions of each type of events.
Streams is an interface which exposes the standard input and output streams.

# Type aliases

DefaultContextResolver is a function which resolves the default context base on the configuration and the env variables.
DockerCliOption applies a modification on a DockerCli.
InitializeOpt is the type of the functional options passed to DockerCli.Initialize.
InStream is an input stream used by the DockerCli to read user input Deprecated: Use github.com/crazy-max/docker-cli/cli/streams.In instead.
Orchestrator type acts as an enum describing supported orchestrators.
OutStream is an output stream used by the DockerCli to write normal program output.