Moby Client

https://pkg.go.dev/github.com/moby/moby/client
Admin
A Go client for interacting with the Docker Engine API, providing programmatic access to Docker...
Tokens:37,881
Snippets:471
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### PluginInstall

Source: https://pkg.go.dev/github.com/moby/moby/client

Installs a plugin.

```APIDOC
## func (*Client) PluginInstall

### Description
PluginInstall installs a plugin.

### Signature
`func (cli *Client) PluginInstall(ctx context.Context, name string, options PluginInstallOptions) (_ PluginInstallResult, retErr error)`
```

--------------------------------

### Empty output example

Source: https://pkg.go.dev/github.com/moby/moby/client

Placeholder for output examples.

```text
Output:
```

--------------------------------

### ExecStartOptions struct

Source: https://pkg.go.dev/github.com/moby/moby/client

Options for starting a container exec.

```go
type ExecStartOptions struct {
	// ExecStart will first check if it's detached
	Detach bool
	// Check if there's a tty
	TTY bool
	// Terminal size [height, width], unused if TTY == false
	ConsoleSize ConsoleSize
}
```

--------------------------------

### Start a container

Source: https://pkg.go.dev/github.com/moby/moby/client

Sends a request to the docker daemon to start a container.

```go
func (cli *Client) ContainerStart(ctx context.Context, containerID string, options ContainerStartOptions) (ContainerStartResult, error)
```

--------------------------------

### Define ContainerStartOptions

Source: https://pkg.go.dev/github.com/moby/moby/client

Configuration for starting a container, supporting checkpoint restoration.

```go
type ContainerStartOptions struct {
	CheckpointID  string
	CheckpointDir string
}
```

--------------------------------

### Get System Info

Source: https://pkg.go.dev/github.com/moby/moby/client

Returns information about the Docker server.

```go
func (cli *Client) Info(ctx context.Context, options InfoOptions) (SystemInfoResult, error)
```

--------------------------------

### PluginList

Source: https://pkg.go.dev/github.com/moby/moby/client

Returns the installed plugins.

```APIDOC
## func (*Client) PluginList

### Description
PluginList returns the installed plugins.

### Signature
`func (cli *Client) PluginList(ctx context.Context, options PluginListOptions) (PluginListResult, error)`
```

--------------------------------

### func (*Client) ContainerStart

Source: https://pkg.go.dev/github.com/moby/moby/client

Sends a request to the docker daemon to start a container.

```APIDOC
## func (*Client) ContainerStart

### Description
Sends a request to the docker daemon to start a container.

### Signature
`func (cli *Client) ContainerStart(ctx context.Context, containerID string, options ContainerStartOptions) (ContainerStartResult, error)`
```

--------------------------------

### Diff container filesystem

Source: https://pkg.go.dev/github.com/moby/moby/client

Shows changes in the container filesystem since it was started.

```go
func (cli *Client) ContainerDiff(ctx context.Context, containerID string, options ContainerDiffOptions) (ContainerDiffResult, error)
```

--------------------------------

### ExecStartResult struct

Source: https://pkg.go.dev/github.com/moby/moby/client

Result of starting a container exec.

```go
type ExecStartResult struct{}
```

--------------------------------

### Get container process info

Source: https://pkg.go.dev/github.com/moby/moby/client

Shows process information from within a container.

```go
func (cli *Client) ContainerTop(ctx context.Context, containerID string, options ContainerTopOptions) (ContainerTopResult, error)
```

--------------------------------

### Define ContainerStartResult

Source: https://pkg.go.dev/github.com/moby/moby/client

Empty result structure for container start operations.

```go
type ContainerStartResult struct {
}
```

--------------------------------

### ContainerDiff

Source: https://pkg.go.dev/github.com/moby/moby/client

Shows differences in a container filesystem since it was started.

```APIDOC
## func (*Client) ContainerDiff

### Description
Shows differences in a container filesystem since it was started.

### Signature
`func (cli *Client) ContainerDiff(ctx context.Context, containerID string, options ContainerDiffOptions) (ContainerDiffResult, error)`
```

--------------------------------

### ParseTimestamps Function Signature and Usage

Source: https://pkg.go.dev/github.com/moby/moby/client/internal/timestamp

Displays the function signature and an example of how to parse a timestamp string into seconds and nanoseconds.

```go
func ParseTimestamps(value string, defaultSeconds int64) (seconds int64, nanoseconds int64, _ error)
```

```go
seconds, nanoseconds, _ := ParseTimestamp("1136073600.000000001",0)
since := time.Unix(seconds, nanoseconds)
```

--------------------------------

### Get client API version

Source: https://pkg.go.dev/github.com/moby/moby/client

Returns the API version currently in use by the client instance.

```go
func (cli *Client) ClientVersion() string
```

--------------------------------

### Plugin Management Methods

Source: https://pkg.go.dev/github.com/moby/moby/client

Methods for managing Docker plugins, including creating, disabling, enabling, inspecting, installing, listing, pushing, removing, setting, and upgrading.

```APIDOC
## Plugin Management

### Methods
- `PluginCreate(ctx context.Context, createContext io.Reader, ...)`
- `PluginDisable(ctx context.Context, name string, options PluginDisableOptions) (PluginDisableResult, error)`
- `PluginEnable(ctx context.Context, name string, options PluginEnableOptions) (PluginEnableResult, error)`
- `PluginInspect(ctx context.Context, name string, options PluginInspectOptions) (PluginInspectResult, error)`
- `PluginInstall(ctx context.Context, name string, options PluginInstallOptions) (_ PluginInstallResult, retErr error)`
- `PluginList(ctx context.Context, options PluginListOptions) (PluginListResult, error)`
- `PluginPush(ctx context.Context, name string, options PluginPushOptions) (PluginPushResult, error)`
- `PluginRemove(ctx context.Context, name string, options PluginRemoveOptions) (PluginRemoveResult, error)`
- `PluginSet(ctx context.Context, name string, options PluginSetOptions) (PluginSetResult, error)`
- `PluginUpgrade(ctx context.Context, name string, options PluginUpgradeOptions) (PluginUpgradeResult, error)`
```

--------------------------------

### Restart a container

Source: https://pkg.go.dev/github.com/moby/moby/client

Stops and starts a container again, waiting for the container to be up for a specific timeout.

```go
func (cli *Client) ContainerRestart(ctx context.Context, containerID string, options ContainerRestartOptions) (ContainerRestartResult, error)
```

--------------------------------

### Container Management Methods

Source: https://pkg.go.dev/github.com/moby/moby/client

Methods for managing container lifecycles, including inspect, kill, list, logs, pause, remove, rename, resize, restart, start, stats, stop, top, unpause, update, and wait.

```APIDOC
## func (cli *Client) ContainerInspect(ctx context.Context, containerID string, options ContainerInspectOptions) (ContainerInspectResult, error)
## func (cli *Client) ContainerKill(ctx context.Context, containerID string, options ContainerKillOptions) (ContainerKillResult, error)
## func (cli *Client) ContainerList(ctx context.Context, options ContainerListOptions) (ContainerListResult, error)
## func (cli *Client) ContainerLogs(ctx context.Context, containerID string, options ContainerLogsOptions) (ContainerLogsResult, error)
## func (cli *Client) ContainerPause(ctx context.Context, containerID string, options ContainerPauseOptions) (ContainerPauseResult, error)
## func (cli *Client) ContainerPrune(ctx context.Context, opts ContainerPruneOptions) (ContainerPruneResult, error)
## func (cli *Client) ContainerRemove(ctx context.Context, containerID string, options ContainerRemoveOptions) (ContainerRemoveResult, error)
## func (cli *Client) ContainerRename(ctx context.Context, containerID string, options ContainerRenameOptions) (ContainerRenameResult, error)
## func (cli *Client) ContainerResize(ctx context.Context, containerID string, options ContainerResizeOptions) (ContainerResizeResult, error)
## func (cli *Client) ContainerRestart(ctx context.Context, containerID string, options ContainerRestartOptions) (ContainerRestartResult, error)
## func (cli *Client) ContainerStart(ctx context.Context, containerID string, options ContainerStartOptions) (ContainerStartResult, error)
## func (cli *Client) ContainerStatPath(ctx context.Context, containerID string, options ContainerStatPathOptions) (ContainerStatPathResult, error)
## func (cli *Client) ContainerStats(ctx context.Context, containerID string, options ContainerStatsOptions) (ContainerStatsResult, error)
## func (cli *Client) ContainerStop(ctx context.Context, containerID string, options ContainerStopOptions) (ContainerStopResult, error)
## func (cli *Client) ContainerTop(ctx context.Context, containerID string, options ContainerTopOptions) (ContainerTopResult, error)
## func (cli *Client) ContainerUnpause(ctx context.Context, containerID string, options ContainerUnpauseOptions) (ContainerUnpauseResult, error)
## func (cli *Client) ContainerUpdate(ctx context.Context, containerID string, options ContainerUpdateOptions) (ContainerUpdateResult, error)
## func (cli *Client) ContainerWait(ctx context.Context, containerID string, options ContainerWaitOptions) ContainerWaitResult
```

--------------------------------

### Initialize client with options (deprecated)

Source: https://pkg.go.dev/github.com/moby/moby/client

Legacy method for initializing a client. Use New instead.

```go
func NewClientWithOpts(ops ...Opt) (*Client, error)
```

--------------------------------

### List configurations

Source: https://pkg.go.dev/github.com/moby/moby/client

Returns a list of available configurations.

```go
func (cli *Client) ConfigList(ctx context.Context, options ConfigListOptions) (ConfigListResult, error)
```

--------------------------------

### Create configuration

Source: https://pkg.go.dev/github.com/moby/moby/client

Creates a new configuration object.

```go
func (cli *Client) ConfigCreate(ctx context.Context, options ConfigCreateOptions) (ConfigCreateResult, error)
```

--------------------------------

### func (*Client) ContainerRestart

Source: https://pkg.go.dev/github.com/moby/moby/client

Stops, and starts a container again.

```APIDOC
## func (*Client) ContainerRestart

### Description
Stops, and starts a container again. It makes the daemon wait for the container to be up again for a specific amount of time, given the timeout.

### Signature
`func (cli *Client) ContainerRestart(ctx context.Context, containerID string, options ContainerRestartOptions) (ContainerRestartResult, error)`
```

--------------------------------

### Initialize a new API client

Source: https://pkg.go.dev/github.com/moby/moby/client

Creates a new client instance. Use functional options to configure behavior, such as loading settings from environment variables.

```go
func New(ops ...Opt) (*Client, error)
```

```go
cli, err := client.New(client.FromEnv)
```

--------------------------------

### List all containers using the Docker Engine API client

Source: https://pkg.go.dev/github.com/moby/moby/client

Initializes a Docker client using environment variables and lists all containers, equivalent to running 'docker ps --all'.

```go
package main

import (
	"context"
	"fmt"

	"github.com/moby/moby/client"
)

func main() {
	// Create a new client with "client.FromEnv" (configuring the client
	// from commonly used environment variables such as DOCKER_HOST and
	// DOCKER_API_VERSION) and set a custom User-Agent.
	//
	// API-version negotiation is enabled by default to allow downgrading
	// the API version when connecting with an older daemon version.
	apiClient, err := client.New(
		client.FromEnv,
		client.WithUserAgent("my-application/1.0.0"),
	)
	if err != nil {
		panic(err)
	}
	defer apiClient.Close()

	// List all containers (both stopped and running).
	result, err := apiClient.ContainerList(context.Background(), client.ContainerListOptions{
		All: true,
	})
	if err != nil {
		panic(err)
	}

	// Print each container's ID, status and the image it was created from.
	fmt.Printf("%s  %-22s  %s\n", "ID", "STATUS", "IMAGE")
	for _, ctr := range result.Items {
		fmt.Printf("%s  %-22s  %s\n", ctr.ID, ctr.Status, ctr.Image)
	}
}
```

--------------------------------

### client.New

Source: https://pkg.go.dev/github.com/moby/moby/client

Initializes a new Docker API client using environment variables and optional configuration modifiers.

```APIDOC
## client.New

### Description
Creates a new Docker API client instance. It typically uses `client.FromEnv` to configure the client based on environment variables like DOCKER_HOST and DOCKER_API_VERSION.

### Signature
`func New(ops ...Opt) (*Client, error)`

### Parameters
- **ops** (...Opt) - Optional - A variadic list of client options, such as `client.FromEnv` or `client.WithUserAgent`.
```

--------------------------------

### List Containers with Docker Engine API

Source: https://pkg.go.dev/github.com/moby/moby/client

Initializes a client using environment variables and lists all containers, similar to the 'docker ps -a' command.

```go
package main

import (
	"context"
	"fmt"
	"log"

	"github.com/moby/moby/client"
)

func main() {
	// Create a new client that handles common environment variables
	// for configuration (DOCKER_HOST, DOCKER_API_VERSION), and does
	// API-version negotiation to allow downgrading the API version
	// when connecting with an older daemon version.
	apiClient, err := client.New(client.FromEnv)
	if err != nil {
		log.Fatal(err)
	}

	// List all containers (both stopped and running).
	result, err := apiClient.ContainerList(context.Background(), client.ContainerListOptions{
		All: true,
	})
	if err != nil {
		log.Fatal(err)
	}

	// Print each container's ID, status and the image it was created from.
	fmt.Printf("%s  %-22s  %s\n", "ID", "STATUS", "IMAGE")
	for _, ctr := range result.Items {
		fmt.Printf("%s  %-22s  %s\n", ctr.ID, ctr.Status, ctr.Image)
	}
}
```

--------------------------------

### Inspect configuration

Source: https://pkg.go.dev/github.com/moby/moby/client

Retrieves configuration information including raw data.

```go
func (cli *Client) ConfigInspect(ctx context.Context, id string, options ConfigInspectOptions) (ConfigInspectResult, error)
```

--------------------------------

### func (*Client) CopyFromContainer

Source: https://pkg.go.dev/github.com/moby/moby/client

Gets the content from the container and returns it as a Reader for a TAR archive.

```APIDOC
## func (*Client) CopyFromContainer

### Description
Gets the content from the container and returns it as a Reader for a TAR archive to manipulate it in the host. It's up to the caller to close the reader.

### Signature
`func (cli *Client) CopyFromContainer(ctx context.Context, containerID string, options CopyFromContainerOptions) (CopyFromContainerResult, error)`
```

--------------------------------

### Define ServerVersionOptions

Source: https://pkg.go.dev/github.com/moby/moby/client

Options for requesting the server version.

```go
type ServerVersionOptions struct {
}
```

--------------------------------

### Define InfoOptions

Source: https://pkg.go.dev/github.com/moby/moby/client

Options for retrieving system information.

```go
type InfoOptions struct {
}
```

--------------------------------

### Copy from container

Source: https://pkg.go.dev/github.com/moby/moby/client

Gets content from a container as a TAR archive reader. The caller is responsible for closing the reader.

```go
func (cli *Client) CopyFromContainer(ctx context.Context, containerID string, options CopyFromContainerOptions) (CopyFromContainerResult, error)
```

--------------------------------

### Create a container

Source: https://pkg.go.dev/github.com/moby/moby/client

Creates a new container based on the provided configuration.

```go
func (cli *Client) ContainerCreate(ctx context.Context, options ContainerCreateOptions) (ContainerCreateResult, error)
```

--------------------------------

### Import Image

Source: https://pkg.go.dev/github.com/moby/moby/client

Creates a new image based on the provided source options.

```go
func (cli *Client) ImageImport(ctx context.Context, source ImageImportSource, ref string, options ImageImportOptions) (ImageImportResult, error)
```

--------------------------------

### Configure TLS from Environment

Source: https://pkg.go.dev/github.com/moby/moby/client

Configures the client for TLS using DOCKER_CERT_PATH and DOCKER_TLS_VERIFY environment variables.

```go
func WithTLSClientConfigFromEnv() Opt
```

--------------------------------

### Define NetworkCreateOptions struct

Source: https://pkg.go.dev/github.com/moby/moby/client

Holds configuration options for creating a new network, including driver, scope, and IPAM settings.

```go
type NetworkCreateOptions struct {
	Driver     string            // Driver is the driver-name used to create the network (e.g. `bridge`, `overlay`)
	Scope      string            // Scope describes the level at which the network exists (e.g. `swarm` for cluster-wide or `local` for machine level).
	EnableIPv4 *bool             // EnableIPv4 represents whether to enable IPv4.
	EnableIPv6 *bool             // EnableIPv6 represents whether to enable IPv6.
	IPAM       *network.IPAM     // IPAM is the network's IP Address Management.
	Internal   bool              // Internal represents if the network is used internal only.
	Attachable bool              // Attachable represents if the global scope is manually attachable by regular containers from workers in swarm mode.
	Ingress    bool              // Ingress indicates the network is providing the routing-mesh for the swarm cluster.
	ConfigOnly bool              // ConfigOnly creates a config-only network. Config-only networks are place-holder networks for network configurations to be used by other networks. ConfigOnly networks cannot be used directly to run containers or services.
	ConfigFrom string            // ConfigFrom specifies the source which will provide the configuration for this network. The specified network must be a config-only network; see [CreateOptions.ConfigOnly].
	Options    map[string]string // Options specifies the network-specific options to use for when creating the network.
	Labels     map[string]string // Labels holds metadata specific to the network being created.
}
```

--------------------------------

### Configure Client Version (Deprecated)

Source: https://pkg.go.dev/github.com/moby/moby/client

Overrides the client version. Use WithAPIVersion instead.

```go
func WithVersion(version string) Opt
```

--------------------------------

### func (*Client) ConfigCreate

Source: https://pkg.go.dev/github.com/moby/moby/client

Creates a new config.

```APIDOC
## func (*Client) ConfigCreate(ctx context.Context, options ConfigCreateOptions) (ConfigCreateResult, error)

### Description
Creates a new config.
```

--------------------------------

### client.New

Source: https://pkg.go.dev/github.com/moby/moby/client

Initializes a new Docker Engine API client. It accepts optional configuration functions to set up the client, such as FromEnv for environment-based configuration.

```APIDOC
## func New(ops ...Opt) (*Client, error)

### Description
Creates a new Docker Engine API client. The client can be configured using various options, such as FromEnv, which reads configuration from environment variables like DOCKER_HOST and DOCKER_API_VERSION.

### Parameters
- **ops** (...Opt) - Optional - A variadic list of configuration options to apply to the client.
```

--------------------------------

### Configuration Data Structures

Source: https://pkg.go.dev/github.com/moby/moby/client

Structures used for creating, inspecting, listing, removing, and updating configurations.

```go
type ConfigCreateOptions struct {
	Spec swarm.ConfigSpec
}
```

```go
type ConfigCreateResult struct {
	ID string
}
```

```go
type ConfigInspectOptions struct {
}
```

```go
type ConfigInspectResult struct {
	Config swarm.Config
	Raw    json.RawMessage
}
```

```go
type ConfigListOptions struct {
	Filters Filters
}
```

```go
type ConfigListResult struct {
	Items []swarm.Config
}
```

```go
type ConfigRemoveOptions struct {
}
```

```go
type ConfigRemoveResult struct {
}
```

```go
type ConfigUpdateOptions struct {
	Version swarm.Version
	Spec    swarm.ConfigSpec
}
```

```go
type ConfigUpdateResult struct{}
```

--------------------------------

### Define ServiceCreateOptions struct

Source: https://pkg.go.dev/github.com/moby/moby/client

Contains options for creating a service.

```go
type ServiceCreateOptions struct {
	Spec swarm.ServiceSpec

	// EncodedRegistryAuth is the encoded registry authorization credentials to
	// use when updating the service.
	//
	// This field follows the format of the X-Registry-Auth header.
	EncodedRegistryAuth string

	// QueryRegistry indicates whether the service update requires
	// contacting a registry. A registry may be contacted to retrieve
	// the image digest and manifest, which in turn can be used to update
	// platform or other information about the service.
	QueryRegistry bool
}
```

--------------------------------

### ExecInspectOptions struct

Source: https://pkg.go.dev/github.com/moby/moby/client

Options for inspecting a container exec.

```go
type ExecInspectOptions struct{}
```

--------------------------------

### Define SwarmInitOptions

Source: https://pkg.go.dev/github.com/moby/moby/client

Configuration options for initializing a new swarm cluster.

```go
type SwarmInitOptions struct {
	ListenAddr       string
	AdvertiseAddr    string
	DataPathAddr     string
	DataPathPort     uint32
	ForceNewCluster  bool
	Spec             swarm.Spec
	AutoLockManagers bool
	Availability     swarm.NodeAvailability
	DefaultAddrPool  []netip.Prefix
	SubnetSize       uint32
}
```

--------------------------------

### List Images

Source: https://pkg.go.dev/github.com/moby/moby/client

Returns a list of images available on the Docker host.

```go
func (cli *Client) ImageList(ctx context.Context, options ImageListOptions) (ImageListResult, error)
```

--------------------------------

### Compare version less than or equal to

Source: https://pkg.go.dev/github.com/moby/moby/client/pkg/versions

Checks if the first version string is less than or equal to the second.

```go
func LessThanOrEqualTo(v, other string) bool
```

--------------------------------

### Compare version less than

Source: https://pkg.go.dev/github.com/moby/moby/client/pkg/versions

Checks if the first version string is less than the second.

```go
func LessThan(v, other string) bool
```

--------------------------------

### System and Registry Methods

Source: https://pkg.go.dev/github.com/moby/moby/client

General system information, versioning, ping, and registry authentication methods.

```APIDOC
## System and Registry

### Methods
- `Info(ctx context.Context, options InfoOptions) (SystemInfoResult, error)`
- `Ping(ctx context.Context, options PingOptions) (PingResult, error)`
- `RegistryLogin(ctx context.Context, options RegistryLoginOptions) (RegistryLoginResult, error)`
- `ServerVersion(ctx context.Context, _ ServerVersionOptions) (ServerVersionResult, error)`
```

--------------------------------

### Create a standard progress output formatter

Source: https://pkg.go.dev/github.com/moby/moby/client/pkg/streamformatter

Returns a progress.Output object suitable for use with progress.NewProgressReader.

```go
func NewProgressOutput(out io.Writer) progress.Output
```

--------------------------------

### Create Network

Source: https://pkg.go.dev/github.com/moby/moby/client

Creates a new network on the Docker host.

```go
func (cli *Client) NetworkCreate(ctx context.Context, name string, options NetworkCreateOptions) (NetworkCreateResult, error)
```

--------------------------------

### Define ServiceListOptions struct

Source: https://pkg.go.dev/github.com/moby/moby/client

Holds parameters to list services.

```go
type ServiceListOptions struct {
	Filters Filters

	// Status indicates whether the server should include the service task
	// count of running and desired tasks.
	Status bool
}
```

--------------------------------

### Define DistributionInspectOptions

Source: https://pkg.go.dev/github.com/moby/moby/client

Options for inspecting registry distribution.

```go
type DistributionInspectOptions struct {
	EncodedRegistryAuth string
}
```

--------------------------------

### Output interface

Source: https://pkg.go.dev/github.com/moby/moby/client/pkg/progress

Interface for writing progress information.

```go
type Output interface {
	WriteProgress(Progress) error
}
```

--------------------------------

### func New

Source: https://pkg.go.dev/github.com/moby/moby/client

Initializes a new API client with a default HTTPClient, API host, and version. It accepts optional functional arguments to modify defaults.

```APIDOC
## func New(ops ...Opt) (*Client, error)

### Description
Initializes a new API client with a default HTTPClient, and default API host and version. It also initializes the custom HTTP headers to add to each request.

### Parameters
- **ops** (...Opt) - Optional - A list of functional arguments to configure the client.
```

--------------------------------

### Inspect a container

Source: https://pkg.go.dev/github.com/moby/moby/client

Returns detailed information about a specific container.

```go
func (cli *Client) ContainerInspect(ctx context.Context, containerID string, options ContainerInspectOptions) (ContainerInspectResult, error)
```

--------------------------------

### Transport and Connection Options

Source: https://pkg.go.dev/github.com/moby/moby/client

Options for configuring the underlying network transport and HTTP client.

```go
func WithDialContext(dialContext func(ctx context.Context, network, addr string) (net.Conn, error)) Opt
```

```go
func WithHTTPClient(client *http.Client) Opt
```

```go
func WithHTTPHeaders(headers map[string]string) Opt
```

```go
func WithHost(host string) Opt
```

```go
func WithHostFromEnv() Opt
```

```go
func WithScheme(scheme string) Opt
```

--------------------------------

### Define ContainerWaitOptions

Source: https://pkg.go.dev/github.com/moby/moby/client

Configuration for waiting on a container state change.

```go
type ContainerWaitOptions struct {
	Condition container.WaitCondition
}
```

--------------------------------

### Compare version greater than or equal to

Source: https://pkg.go.dev/github.com/moby/moby/client/pkg/versions

Checks if the first version string is greater than or equal to the second.

```go
func GreaterThanOrEqualTo(v, other string) bool
```

--------------------------------

### Define ImageBuildOptions struct

Source: https://pkg.go.dev/github.com/moby/moby/client

Holds configuration parameters for building container images.

```go
type ImageBuildOptions struct {
	Tags           []string
	SuppressOutput bool
	RemoteContext  string
	NoCache        bool
	Remove         bool
	ForceRemove    bool
	PullParent     bool
	Isolation      container.Isolation
	CPUSetCPUs     string
	CPUSetMems     string
	CPUShares      int64
	CPUQuota       int64
	CPUPeriod      int64
	Memory         int64
	MemorySwap     int64
	CgroupParent   string
	NetworkMode    string
	ShmSize        int64
	Dockerfile     string
	Ulimits        []*container.Ulimit
	// BuildArgs needs to be a *string instead of just a string so that
	// we can tell the difference between "" (empty string) and no value
	// at all (nil). See the parsing of buildArgs in
	// api/server/router/build/build_routes.go for even more info.
	BuildArgs   map[string]*string
	AuthConfigs map[string]registry.AuthConfig
	Context     io.Reader
	Labels      map[string]string
	// squash the resulting image's layers to the parent
	// preserves the original image and creates a new one from the parent with all
	// the changes applied to a single layer
	Squash bool
	// CacheFrom specifies images that are used for matching cache. Images
	// specified here do not need to have a valid parent chain to match cache.
	CacheFrom   []string
	SecurityOpt []string
	ExtraHosts  []string // List of extra hosts
	Target      string
	SessionID   string
	// Platforms selects the platforms to build the image for. Multiple platforms
	// can be provided if the daemon supports multi-platform builds.
	Platforms []ocispec.Platform
	// Version specifies the version of the underlying builder to use
	Version build.BuilderVersion
	// BuildID is an optional identifier that can be passed together with the
	// build request. The same identifier can be used to gracefully cancel the
	// build with the cancel request.
	BuildID string
	// Outputs defines configurations for exporting build results. Only supported
	// in BuildKit mode
	Outputs []ImageBuildOutput
}
```

--------------------------------

### List containers

Source: https://pkg.go.dev/github.com/moby/moby/client

Returns a list of containers present on the docker host.

```go
func (cli *Client) ContainerList(ctx context.Context, options ContainerListOptions) (ContainerListResult, error)
```

--------------------------------

### Define ContainerTopOptions

Source: https://pkg.go.dev/github.com/moby/moby/client

Configuration for container top operations.

```go
type ContainerTopOptions struct {
	Arguments []string
}
```

--------------------------------

### Manage Docker Volumes

Source: https://pkg.go.dev/github.com/moby/moby/client

Methods for creating, inspecting, listing, pruning, removing, and updating volumes on the Docker host.

```go
func (cli *Client) VolumeCreate(ctx context.Context, options VolumeCreateOptions) (VolumeCreateResult, error)
```

```go
func (cli *Client) VolumeInspect(ctx context.Context, volumeID string, options VolumeInspectOptions) (VolumeInspectResult, error)
```

```go
func (cli *Client) VolumeList(ctx context.Context, options VolumeListOptions) (VolumeListResult, error)
```

```go
func (cli *Client) VolumePrune(ctx context.Context, options VolumePruneOptions) (VolumePruneResult, error)
```

```go
func (cli *Client) VolumeRemove(ctx context.Context, volumeID string, options VolumeRemoveOptions) (VolumeRemoveResult, error)
```

```go
func (cli *Client) VolumeUpdate(ctx context.Context, volumeID string, options VolumeUpdateOptions) (VolumeUpdateResult, error)
```

--------------------------------

### Create a JSON progress output formatter

Source: https://pkg.go.dev/github.com/moby/moby/client/pkg/streamformatter

Returns a progress.Output that formats output using JSON objects.

```go
func NewJSONProgressOutput(out io.Writer, newLines bool) progress.Output
```

--------------------------------

### Define Image Pushing Options and Response

Source: https://pkg.go.dev/github.com/moby/moby/client

Configuration for pushing images and the interface for handling the response stream.

```go
type ImagePushOptions struct {
	All          bool
	RegistryAuth string // RegistryAuth is the base64 encoded credentials for the registry

	// PrivilegeFunc is a function that clients can supply to retry operations
	// after getting an authorization error. This function returns the registry
	// authentication header value in base64 encoded format, or an error if the
	// privilege request fails.
	//
	// For details, refer to [github.com/moby/moby/api/types/registry.RequestAuthConfig].
	PrivilegeFunc func(context.Context) (string, error)

	// Platform is an optional field that selects a specific platform to push
	// when the image is a multi-platform image.
	// Using this will only push a single platform-specific manifest.
	Platform *ocispec.Platform `json:",omitempty"`
}
```

```go
type ImagePushResponse interface {
	io.ReadCloser
	JSONMessages(ctx context.Context) iter.Seq2[jsonstream.Message, error]
	Wait(ctx context.Context) error
}
```

--------------------------------

### Define ContainerListOptions

Source: https://pkg.go.dev/github.com/moby/moby/client

Holds parameters to list containers. Note that Latest, Since, and Before are deprecated or non-functional.

```go
type ContainerListOptions struct {
	Size    bool
	All     bool
	Limit   int
	Filters Filters

	// Latest is non-functional and should not be used. Use Limit: 1 instead.
	//
	// Deprecated: the Latest option is non-functional and should not be used. Use Limit: 1 instead.
	Latest bool

	// Since is no longer supported. Use the "since" filter instead.
	//
	// Deprecated: the Since option is no longer supported since docker 1.12 (API 1.24). Use the "since" filter instead.
	Since string

	// Before is no longer supported. Use the "since" filter instead.
	//
	// Deprecated: the Before option is no longer supported since docker 1.12 (API 1.24). Use the "before" filter instead.
	Before string
}
```

--------------------------------

### API Version Configuration Options

Source: https://pkg.go.dev/github.com/moby/moby/client

Options for managing the API version used by the client.

```go
func WithAPIVersion(version string) Opt
```

```go
func WithAPIVersionFromEnv() Opt
```

```go
func WithAPIVersionNegotiation() Opt
```

--------------------------------

### Info

Source: https://pkg.go.dev/github.com/moby/moby/client

Returns information about the docker server.

```APIDOC
## func (*Client) Info

### Description
Info returns information about the docker server.

### Signature
`func (cli *Client) Info(ctx context.Context, options InfoOptions) (SystemInfoResult, error)`
```

--------------------------------

### Platform Information Structure

Source: https://pkg.go.dev/github.com/moby/moby/client

Holds information about the server platform product name.

```go
type PlatformInfo struct {
	// Name is the name of the platform (for example, "Docker Engine - Community",
	// or "Docker Desktop 4.49.0 (208003)")
	Name string
}
```

--------------------------------

### ImageBuildAPIClient Methods

Source: https://pkg.go.dev/github.com/moby/moby/client

Methods for building and managing image build processes.

```APIDOC
## ImageBuildAPIClient Methods

### ImageBuild
Builds an image from a build context.

### BuildCachePrune
Prunes the build cache.

### BuildCancel
Cancels an ongoing build operation.
```

--------------------------------

### Retrieve module version

Source: https://pkg.go.dev/github.com/moby/moby/client/internal/mod

Returns a best-effort version string for a specified module path. Returns an empty string if the module is replaced or lacks version information.

```go
func Version(name string) string
```

```text
<base>+<revision>[+meta...][+dirty]
```

--------------------------------

### Define RegistryLoginOptions and Result

Source: https://pkg.go.dev/github.com/moby/moby/client

Structures for registry login credentials and the resulting authentication response.

```go
type RegistryLoginOptions struct {
	Username      string
	Password      string
	ServerAddress string
	IdentityToken string
	RegistryToken string
}
```

```go
type RegistryLoginResult struct {
	Auth registry.AuthResponse
}
```

--------------------------------

### Configure Trace Options

Source: https://pkg.go.dev/github.com/moby/moby/client

Sets tracing span options for the client.

```go
func WithTraceOptions(opts ...otelhttp.Option) Opt
```

--------------------------------

### Configure Trace Provider

Source: https://pkg.go.dev/github.com/moby/moby/client

Sets the trace provider for the client, defaulting to the global provider if unset.

```go
func WithTraceProvider(provider trace.TracerProvider) Opt
```

--------------------------------

### WithTLSClientConfig(caFile, certFile, keyFile string) Opt

Source: https://pkg.go.dev/github.com/moby/moby/client

Configures the client's HTTP transport to use TLS with optional client certificate authentication.

```APIDOC
## func WithTLSClientConfig(caFile, certFile, keyFile string) Opt

### Description
Configures the client's existing HTTP transport to use TLS. The minimum TLS version is TLS 1.2.

### Parameters
- **caFile** (string) - Optional - Path to the CA certificate file for server verification.
- **certFile** (string) - Optional - Path to the client certificate file.
- **keyFile** (string) - Optional - Path to the client private key file.
```

--------------------------------

### Compare version greater than

Source: https://pkg.go.dev/github.com/moby/moby/client/pkg/versions

Checks if the first version string is greater than the second.

```go
func GreaterThan(v, other string) bool
```

--------------------------------

### Define NodeListOptions struct

Source: https://pkg.go.dev/github.com/moby/moby/client

Parameters to list nodes.

```go
type NodeListOptions struct {
	Filters Filters
}
```

--------------------------------

### Client Configuration Type

Source: https://pkg.go.dev/github.com/moby/moby/client

The functional option type used to initialize the client.

```go
type Opt func(*clientConfig) error
```

--------------------------------

### ConfigAPIClient Interface

Source: https://pkg.go.dev/github.com/moby/moby/client

Defines the API client methods for managing configurations.

```go
type ConfigAPIClient interface {
	ConfigCreate(ctx context.Context, options ConfigCreateOptions) (ConfigCreateResult, error)
	ConfigInspect(ctx context.Context, id string, options ConfigInspectOptions) (ConfigInspectResult, error)
	ConfigList(ctx context.Context, options ConfigListOptions) (ConfigListResult, error)
	ConfigUpdate(ctx context.Context, id string, options ConfigUpdateOptions) (ConfigUpdateResult, error)
	ConfigRemove(ctx context.Context, id string, options ConfigRemoveOptions) (ConfigRemoveResult, error)
}
```

--------------------------------

### func (*Client) ConfigInspect

Source: https://pkg.go.dev/github.com/moby/moby/client

Returns the config information with raw data.

```APIDOC
## func (*Client) ConfigInspect(ctx context.Context, id string, options ConfigInspectOptions) (ConfigInspectResult, error)

### Description
Returns the config information with raw data.
```

--------------------------------

### Define ImageImportOptions struct

Source: https://pkg.go.dev/github.com/moby/moby/client

Holds information to import images from the client host.

```go
type ImageImportOptions struct {
	Tag      string           // Tag is the name to tag this image with. This attribute is deprecated.
	Message  string           // Message is the message to tag the image with
	Changes  []string         // Changes are the raw changes to apply to this image
	Platform ocispec.Platform // Platform is the target platform of the image
}
```

--------------------------------

### NetworkCreate

Source: https://pkg.go.dev/github.com/moby/moby/client

Creates a new network in the docker host.

```APIDOC
## func (*Client) NetworkCreate

### Description
NetworkCreate creates a new network in the docker host.

### Signature
`func (cli *Client) NetworkCreate(ctx context.Context, name string, options NetworkCreateOptions) (NetworkCreateResult, error)`
```

--------------------------------

### func (*Client) ConfigList

Source: https://pkg.go.dev/github.com/moby/moby/client

Returns the list of configs.

```APIDOC
## func (*Client) ConfigList(ctx context.Context, options ConfigListOptions) (ConfigListResult, error)

### Description
Returns the list of configs.
```

--------------------------------

### Configure User-Agent

Source: https://pkg.go.dev/github.com/moby/moby/client

Sets the User-Agent header for HTTP requests, overriding any existing header.

```go
func WithUserAgent(ua string) Opt
```

--------------------------------

### Define ContainerLogsOptions

Source: https://pkg.go.dev/github.com/moby/moby/client

Holds parameters to filter logs.

```go
type ContainerLogsOptions struct {
	ShowStdout bool
	ShowStderr bool
	Since      string
	Until      string
	Timestamps bool
	Follow     bool
	Tail       string
	Details    bool
}
```

--------------------------------

### Configure Image Inspection Options

Source: https://pkg.go.dev/github.com/moby/moby/client

Functional options for customizing image inspection behavior.

```go
func ImageInspectWithPlatform(platform *ocispec.Platform) ImageInspectOption
```

```go
func ImageInspectWithRawResponse(raw *bytes.Buffer) ImageInspectOption
```

--------------------------------

### ContainerCreate

Source: https://pkg.go.dev/github.com/moby/moby/client

Creates a new container based on the provided configuration options.

```APIDOC
## ContainerCreate(ctx context.Context, options ContainerCreateOptions) (ContainerCreateResult, error)

### Description
Creates a new container using the specified configuration, host settings, and networking options.

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **options** (ContainerCreateOptions) - Required - Configuration options including Config, HostConfig, and Name.
```

--------------------------------

### WithHost(host string) Opt

Source: https://pkg.go.dev/github.com/moby/moby/client

Overrides the client host with the specified string.

```APIDOC
## func WithHost(host string) Opt

### Description
Overrides the client host with the specified one.

### Parameters
- **host** (string) - Required - The host address to connect to.
```

--------------------------------

### Define ImageBuildAPIClient interface

Source: https://pkg.go.dev/github.com/moby/moby/client

Interface defining methods for building images and managing build cache.

```go
type ImageBuildAPIClient interface {
	ImageBuild(ctx context.Context, context io.Reader, options ImageBuildOptions) (ImageBuildResult, error)
	BuildCachePrune(ctx context.Context, opts BuildCachePruneOptions) (BuildCachePruneResult, error)
	BuildCancel(ctx context.Context, id string, opts BuildCancelOptions) (BuildCancelResult, error)
}
```

--------------------------------

### Define ImageBuildOutput struct

Source: https://pkg.go.dev/github.com/moby/moby/client

Defines configuration for exporting a build result.

```go
type ImageBuildOutput struct {
	Type  string
	Attrs map[string]string
}
```

--------------------------------

### Configure Client Version from Environment (Deprecated)

Source: https://pkg.go.dev/github.com/moby/moby/client

Overrides the client version using the DOCKER_API_VERSION environment variable. Use WithAPIVersionFromEnv instead.

```go
func WithVersionFromEnv() Opt
```

--------------------------------

### Load Image

Source: https://pkg.go.dev/github.com/moby/moby/client

Loads an image into the Docker host from the client host.

```go
func (cli *Client) ImageLoad(ctx context.Context, input io.Reader, loadOpts ...ImageLoadOption) (ImageLoadResult, error)
```

--------------------------------

### Create container checkpoint

Source: https://pkg.go.dev/github.com/moby/moby/client

Creates a checkpoint from a specified container.

```go
func (cli *Client) CheckpointCreate(ctx context.Context, containerID string, options CheckpointCreateOptions) (CheckpointCreateResult, error)
```

--------------------------------

### ContainerCreate

Source: https://pkg.go.dev/github.com/moby/moby/client

Creates a new container based on the given configuration.

```APIDOC
## func (*Client) ContainerCreate

### Description
Creates a new container based on the given configuration. It can be associated with a name, but it's not mandatory.

### Signature
`func (cli *Client) ContainerCreate(ctx context.Context, options ContainerCreateOptions) (ContainerCreateResult, error)`
```

--------------------------------

### ExecResizeOptions struct

Source: https://pkg.go.dev/github.com/moby/moby/client

Options for resizing a container exec TTY.

```go
type ExecResizeOptions ContainerResizeOptions
```

--------------------------------

### Compare version equality

Source: https://pkg.go.dev/github.com/moby/moby/client/pkg/versions

Checks if two version strings are equal.

```go
func Equal(v, other string) bool
```

--------------------------------

### Volume API Client Interface

Source: https://pkg.go.dev/github.com/moby/moby/client

Interface for volume lifecycle management including creation, inspection, listing, updating, removal, and pruning.

```go
type VolumeAPIClient interface {
	VolumeCreate(ctx context.Context, options VolumeCreateOptions) (VolumeCreateResult, error)
	VolumeInspect(ctx context.Context, volumeID string, options VolumeInspectOptions) (VolumeInspectResult, error)
	VolumeList(ctx context.Context, options VolumeListOptions) (VolumeListResult, error)
	VolumeUpdate(ctx context.Context, volumeID string, options VolumeUpdateOptions) (VolumeUpdateResult, error)
	VolumeRemove(ctx context.Context, volumeID string, options VolumeRemoveOptions) (VolumeRemoveResult, error)
	VolumePrune(ctx context.Context, options VolumePruneOptions) (VolumePruneResult, error)
}
```

```go
type VolumeCreateOptions struct {
	Name              string
	Driver            string
	DriverOpts        map[string]string
	Labels            map[string]string
	ClusterVolumeSpec *volume.ClusterVolumeSpec
}
```

```go
type VolumeCreateResult struct {
	Volume volume.Volume
}
```

```go
type VolumeInspectOptions struct {
}
```

```go
type VolumeInspectResult struct {
	Volume volume.Volume
	Raw    json.RawMessage
}
```

```go
type VolumeListOptions struct {
	Filters Filters
}
```

```go
type VolumeListResult struct {
	// List of volumes.
	Items []volume.Volume

	// Warnings that occurred when fetching the list of volumes.
	Warnings []string
}
```

```go
type VolumePruneOptions struct {
	// All controls whether named volumes should also be pruned. By
	// default, only anonymous volumes are pruned.
	All bool

	// Filters to apply when pruning.
	Filters Filters
}
```

```go
type VolumePruneResult struct {
	Report volume.PruneReport
}
```

--------------------------------

### ExecAttachOptions struct

Source: https://pkg.go.dev/github.com/moby/moby/client

Defines options for attaching to a container exec, including TTY and console size settings.

```go
type ExecAttachOptions struct {
	// Check if there's a tty
	TTY bool
	// Terminal size [height, width], unused if TTY == false
	ConsoleSize ConsoleSize `json:",omitzero"`
}
```

--------------------------------

### func (*Client) ContainerTop

Source: https://pkg.go.dev/github.com/moby/moby/client

Shows process information from within a container.

```APIDOC
## func (*Client) ContainerTop

### Description
Shows process information from within a container.

### Signature
`func (cli *Client) ContainerTop(ctx context.Context, containerID string, options ContainerTopOptions) (ContainerTopResult, error)`
```

--------------------------------

### Define DiskUsageOptions

Source: https://pkg.go.dev/github.com/moby/moby/client

Parameters to specify which disk usage metrics to compute.

```go
type DiskUsageOptions struct {
	// Containers controls whether container disk usage should be computed.
	Containers bool

	// Images controls whether image disk usage should be computed.
	Images bool

	// BuildCache controls whether build cache disk usage should be computed.
	BuildCache bool

	// Volumes controls whether volume disk usage should be computed.
	Volumes bool

	// Verbose enables more detailed disk usage information.
	Verbose bool
}
```

--------------------------------

### Plugin Configuration and Result Structures

Source: https://pkg.go.dev/github.com/moby/moby/client

Data structures used for configuring plugin operations and representing their results.

```go
type PluginCreateOptions struct {
	RepoName string
}
```

```go
type PluginCreateResult struct {
}
```

```go
type PluginDisableOptions struct {
	Force bool
}
```

```go
type PluginDisableResult struct {
}
```

```go
type PluginEnableOptions struct {
	Timeout int
}
```

```go
type PluginEnableResult struct {
}
```

```go
type PluginInspectOptions struct {
}
```

```go
type PluginInspectResult struct {
	Plugin plugin.Plugin
	Raw    json.RawMessage
}
```

```go
type PluginInstallOptions struct {
	Disabled             bool
	AcceptAllPermissions bool
	RegistryAuth         string // RegistryAuth is the base64 encoded credentials for the registry
	RemoteRef            string // RemoteRef is the plugin name on the registry

	// PrivilegeFunc is a function that clients can supply to retry operations
	// after getting an authorization error. This function returns the registry
	// authentication header value in base64 encoded format, or an error if the
	// privilege request fails.
	//
	// For details, refer to [github.com/moby/moby/api/types/registry.RequestAuthConfig].
	PrivilegeFunc         func(context.Context) (string, error)
	AcceptPermissionsFunc func(context.Context, plugin.Privileges) (bool, error)
	Args                  []string
}
```

```go
type PluginInstallResult struct {
	io.ReadCloser
}
```

```go
type PluginListOptions struct {
	Filters Filters
}
```

```go
type PluginListResult struct {
	Items []plugin.Plugin
}
```

```go
type PluginPushOptions struct {
	RegistryAuth string // RegistryAuth is the base64 encoded credentials for the registry
}
```

```go
type PluginPushResult struct {
	io.ReadCloser
}
```

```go
type PluginRemoveOptions struct {
	Force bool
}
```

```go
type PluginRemoveResult struct {
}
```

```go
type PluginSetOptions struct {
	Args []string
}
```

```go
type PluginSetResult struct {
}
```

--------------------------------

### Define ImageTagOptions

Source: https://pkg.go.dev/github.com/moby/moby/client

Options for tagging images.

```go
type ImageTagOptions struct {
	Source string
	Target string
}
```

--------------------------------

### PluginCreate

Source: https://pkg.go.dev/github.com/moby/moby/client

Creates a plugin.

```APIDOC
## func (*Client) PluginCreate

### Description
PluginCreate creates a plugin.

### Signature
`func (cli *Client) PluginCreate(ctx context.Context, createContext io.Reader, createOptions PluginCreateOptions) (PluginCreateResult, error)`
```

--------------------------------

### Define Image Pruning Options and Results

Source: https://pkg.go.dev/github.com/moby/moby/client

Configuration for pruning images and the resulting report.

```go
type ImagePruneOptions struct {
	Filters Filters
}
```

```go
type ImagePruneResult struct {
	Report image.PruneReport
}
```

--------------------------------

### System API Client Interface

Source: https://pkg.go.dev/github.com/moby/moby/client

Interface for system-level API operations including events, info, registry login, disk usage, and ping.

```go
type SystemAPIClient interface {
	Events(ctx context.Context, options EventsListOptions) EventsResult
	Info(ctx context.Context, options InfoOptions) (SystemInfoResult, error)
	RegistryLogin(ctx context.Context, auth RegistryLoginOptions) (RegistryLoginResult, error)
	DiskUsage(ctx context.Context, options DiskUsageOptions) (DiskUsageResult, error)
	Ping(ctx context.Context, options PingOptions) (PingResult, error)
}
```

```go
type SystemInfoResult struct {
	Info system.Info
}
```

--------------------------------

### Define DummyHost constant

Source: https://pkg.go.dev/github.com/moby/moby/client

Hostname used for local communication that should not be resolved.

```go
const DummyHost = "api.moby.localhost"
```

--------------------------------

### Configure Image Loading

Source: https://pkg.go.dev/github.com/moby/moby/client

Functional options and interfaces for image load operations.

```go
type ImageLoadOption interface {
	Apply(*imageLoadOpts) error
}
```

```go
func ImageLoadWithPlatforms(platforms ...ocispec.Platform) ImageLoadOption
```

```go
func ImageLoadWithQuiet(quiet bool) ImageLoadOption
```

```go
type ImageLoadResult interface {
	io.ReadCloser
}
```

--------------------------------

### Volume Management Methods

Source: https://pkg.go.dev/github.com/moby/moby/client

Methods for creating, inspecting, listing, pruning, removing, and updating volumes on the docker host.

```APIDOC
## Volume Management

### VolumeCreate
Creates a volume in the docker host.
`func (cli *Client) VolumeCreate(ctx context.Context, options VolumeCreateOptions) (VolumeCreateResult, error)`

### VolumeInspect
Returns the information about a specific volume in the docker host.
`func (cli *Client) VolumeInspect(ctx context.Context, volumeID string, options VolumeInspectOptions) (VolumeInspectResult, error)`

### VolumeList
Returns the volumes configured in the docker host.
`func (cli *Client) VolumeList(ctx context.Context, options VolumeListOptions) (VolumeListResult, error)`

### VolumePrune
Requests the daemon to delete unused data.
`func (cli *Client) VolumePrune(ctx context.Context, options VolumePruneOptions) (VolumePruneResult, error)`

### VolumeRemove
Removes a volume from the docker host.
`func (cli *Client) VolumeRemove(ctx context.Context, volumeID string, options VolumeRemoveOptions) (VolumeRemoveResult, error)`

### VolumeUpdate
Updates a volume. This only works for Cluster Volumes, and only some fields can be updated.
`func (cli *Client) VolumeUpdate(ctx context.Context, volumeID string, options VolumeUpdateOptions) (VolumeUpdateResult, error)`
```

--------------------------------

### Update configuration

Source: https://pkg.go.dev/github.com/moby/moby/client

Attempts to update an existing configuration.

```go
func (cli *Client) ConfigUpdate(ctx context.Context, id string, options ConfigUpdateOptions) (ConfigUpdateResult, error)
```

--------------------------------

### Define SwarmJoinOptions and Result

Source: https://pkg.go.dev/github.com/moby/moby/client

Structures for joining an existing swarm cluster.

```go
type SwarmJoinOptions struct {
	ListenAddr    string
	AdvertiseAddr string
	DataPathAddr  string
	RemoteAddrs   []string
	JoinToken     string // accept by secret
	Availability  swarm.NodeAvailability
}
```

```go
type SwarmJoinResult struct {
}
```

--------------------------------

### Configure Display Options

Source: https://pkg.go.dev/github.com/moby/moby/client/pkg/jsonmessage

Types and functions for configuring the behavior of display operations.

```go
type DisplayOpt func(*displayOpts) error
```

```go
func WithAuxCallback(fn func(jsonstream.Message)) DisplayOpt
```
Tokens:
Raw