dockercli

Oct 11, 2025

Changes in this version

type Client

+ func (c *Client) NetworkSummaries(ctx context.Context) ([]NetworkSummary, error)

+ func (c *Client) PauseContainer(ctx context.Context, name string) error

+ func (c *Client) PsJSON(ctx context.Context, all bool, filters []string) ([]PsJSONRow, error)

+ func (c *Client) RunInHelperImage(ctx context.Context, script string) (string, error)

+ func (c *Client) RunVolumeScript(ctx context.Context, volumeName, targetPath, script string, env []string) (VolumeScriptResult, error)

+ func (c *Client) StreamContainerLogs(ctx context.Context, name string, tail int, since string, w io.Writer) error

+ func (c *Client) VolumeSummaries(ctx context.Context) ([]VolumeSummary, error)

type ComposeService

+ ContainerName string

+ Networks ComposeServiceNetworks

+ Volumes []ComposeServiceVolume

+ type ComposeServiceNetworks []string

+ func (c *ComposeServiceNetworks) UnmarshalJSON(data []byte) error

+ type ComposeServiceVolume struct

+ Source string

+ Target string

+ Type string

type Exec

+ RunDetailed func(ctx context.Context, opts Options, args ...string) (Result, error)

+ type NetworkSummary struct

+ Driver string

+ Name string

+ type PsJSONRow struct

+ ID string

+ Image string

+ Labels string

+ Names string

+ State string

+ Status string

+ func (r PsJSONRow) LabelValue(key string) string

type VolumeDetails

+ Mountpoint string

+ Name string

+ type VolumeScriptResult struct

+ Stderr string

+ Stdout string

+ type VolumeSummary struct

+ Driver string

+ Mountpoint string

+ Name string

Oct 4, 2025

Changes in this version

type Client

+ func (c *Client) ComposeConfigHashes(ctx context.Context, workingDir string, files, profiles, envFiles []string, ...) (map[string]string, error)

Oct 3, 2025

Changes in this version

type Client

+ func (c *Client) ComposeVersion(ctx context.Context) (string, error)

+ func (c *Client) ContextHost(ctx context.Context) (string, error)

+ func (c *Client) ImageExists(ctx context.Context, imageRef string) (bool, error)

+ func (c *Client) ServerVersion(ctx context.Context) (string, error)

Sep 21, 2025

Changes in this version

type Client

+ func (c *Client) ClearVolume(ctx context.Context, volumeName string) error

+ func (c *Client) ComposeConfigRaw(ctx context.Context, workingDir string, files, profiles, envFiles []string, ...) (string, error)

+ func (c *Client) ExtractZstdTarToVolume(ctx context.Context, volumeName string, r io.Reader) error

+ func (c *Client) InspectNetwork(ctx context.Context, name string) (NetworkInspect, error)

+ func (c *Client) InspectVolume(ctx context.Context, name string) (VolumeDetails, error)

+ func (c *Client) IsVolumeEmpty(ctx context.Context, volumeName string) (bool, error)

+ func (c *Client) ListContainersUsingVolume(ctx context.Context, volumeName string) ([]string, error)

+ func (c *Client) ListRunningContainersUsingVolume(ctx context.Context, volumeName string) ([]string, error)

+ func (c *Client) StartContainers(ctx context.Context, names []string) error

+ func (c *Client) StopContainers(ctx context.Context, names []string) error

+ func (c *Client) StreamTarFromVolume(ctx context.Context, volumeName string, w io.Writer) error

+ func (c *Client) StreamTarZstdFromVolume(ctx context.Context, volumeName string, w io.Writer) error

+ func (c *Client) TarStatsFromVolume(ctx context.Context, volumeName string) (int64, int64, error)

type Exec

+ RunWithStdout func(ctx context.Context, stdout io.Writer, args ...string) error

+ type NetworkCreateOpts struct

+ Attachable bool

+ AuxAddresses map[string]string

+ Driver string

+ Gateway string

+ IPRange string

+ IPv6 bool

+ Internal bool

+ Options map[string]string

+ Subnet string

+ type NetworkInspect struct

+ Attachable bool

+ Containers map[string]struct{ ... }

+ Driver string

+ EnableIPv6 bool

+ IPAM NetworkInspectIPAM

+ Internal bool

+ Name string

+ Options map[string]string

+ type NetworkInspectIPAM struct

+ Config []NetworkInspectIPAMConfig

+ Driver string

+ type NetworkInspectIPAMConfig struct

+ AuxAddresses map[string]string

+ Gateway string

+ IPRange string

+ Subnet string

type SystemExec

+ func (s SystemExec) RunWithStdout(ctx context.Context, stdout io.Writer, args ...string) error

+ type VolumeDetails struct

+ Driver string

+ Labels map[string]string

+ Options map[string]string

Sep 7, 2025

Changes in this version

+ const HelperImage

+ type Client struct

+ func New(contextName string) *Client

+ func (c *Client) CheckDaemon(ctx context.Context) error

+ func (c *Client) ComposeConfigFull(ctx context.Context, workingDir string, files, profiles, envFiles []string, ...) (ComposeConfigDoc, error)

+ func (c *Client) ComposeConfigHash(ctx context.Context, workingDir string, files, profiles, envFiles []string, ...) (string, error)

+ func (c *Client) ComposeConfigServices(ctx context.Context, workingDir string, files, profiles, envFiles []string, ...) ([]string, error)

+ func (c *Client) ComposePs(ctx context.Context, workingDir string, files, profiles, envFiles []string, ...) ([]ComposePsItem, error)

+ func (c *Client) ComposeUp(ctx context.Context, workingDir string, files, profiles, envFiles []string, ...) (string, error)

+ func (c *Client) CreateNetwork(ctx context.Context, name string, labels map[string]string) error

+ func (c *Client) CreateVolume(ctx context.Context, name string, labels map[string]string) error

+ func (c *Client) ExtractTarToVolume(ctx context.Context, volumeName, targetPath string, r io.Reader) error

+ func (c *Client) InspectContainerLabels(ctx context.Context, containerName string, keys []string) (map[string]string, error)

+ func (c *Client) InspectMultipleContainerLabels(ctx context.Context, containerNames []string, keys []string) (map[string]map[string]string, error)

+ func (c *Client) ListComposeContainersAll(ctx context.Context) ([]PsBrief, error)

+ func (c *Client) ListNetworks(ctx context.Context) ([]string, error)

+ func (c *Client) ListVolumes(ctx context.Context) ([]string, error)

+ func (c *Client) ReadFileFromVolume(ctx context.Context, volumeName, targetPath, relFile string) (string, error)

+ func (c *Client) RemoveContainer(ctx context.Context, name string, force bool) error

+ func (c *Client) RemoveNetwork(ctx context.Context, name string) error

+ func (c *Client) RemovePathsFromVolume(ctx context.Context, volumeName, targetPath string, relPaths []string) error

+ func (c *Client) RemoveVolume(ctx context.Context, name string) error

+ func (c *Client) RestartContainer(ctx context.Context, name string) error

+ func (c *Client) SyncDirToVolume(ctx context.Context, volumeName, targetPath, localDir string) error

+ func (c *Client) UpdateContainerLabels(ctx context.Context, containerName string, labels map[string]string) error

+ func (c *Client) VolumeExists(ctx context.Context, name string) (bool, error)

+ func (c *Client) WithIdentifier(id string) *Client

+ func (c *Client) WriteFileToVolume(ctx context.Context, volumeName, targetPath, relFile, content string) error

+ type ComposeConfigDoc struct

+ Services map[string]ComposeService

+ type ComposePort struct

+ Protocol string

+ Published interface{}

+ Target int

+ type ComposePsItem struct

+ Image string

+ Name string

+ Project string

+ Publishers []ComposePublisher

+ Service string

+ State string

+ type ComposePublisher struct

+ Protocol string

+ PublishedPort int

+ TargetPort int

+ URL string

+ type ComposeService struct

+ Image string

+ Ports []ComposePort

+ type Exec interface

+ Run func(ctx context.Context, args ...string) (string, error)

+ RunInDir func(ctx context.Context, dir string, args ...string) (string, error)

+ RunInDirWithEnv func(ctx context.Context, dir string, extraEnv []string, args ...string) (string, error)

+ RunWithStdin func(ctx context.Context, stdin io.Reader, args ...string) (string, error)

+ type ExecEvent struct

+ Args []string

+ Dir string

+ Duration time.Duration

+ Err error

+ ExitCode int

+ Phase string

+ type LoggerHook func(event ExecEvent)

+ type Options struct

+ Dir string

+ Env []string

+ Stdin io.Reader

+ Timeout time.Duration

+ type PsBrief struct

+ Name string

+ Project string

+ Service string

+ type Result struct

+ Duration time.Duration

+ ExitCode int

+ Stderr string

+ Stdout string

+ type SystemExec struct

+ ContextName string

+ DefaultTimeout time.Duration

+ Logger LoggerHook

+ func (s *SystemExec) WithDefaultTimeout(d time.Duration) *SystemExec

+ func (s *SystemExec) WithLogger(h LoggerHook) *SystemExec

+ func (s SystemExec) Run(ctx context.Context, args ...string) (string, error)

+ func (s SystemExec) RunDetailed(ctx context.Context, opts Options, args ...string) (Result, error)

+ func (s SystemExec) RunInDir(ctx context.Context, dir string, args ...string) (string, error)

+ func (s SystemExec) RunInDirWithEnv(ctx context.Context, dir string, extraEnv []string, args ...string) (string, error)

+ func (s SystemExec) RunWithStdin(ctx context.Context, stdin io.Reader, args ...string) (string, error)