# README

Go client for the Docker Engine API

The docker command uses this package to communicate with the daemon. It can also be used by your own Go applications to do anything the command-line interface does – running containers, pulling images, managing swarms, etc.

For example, to list running containers (the equivalent of docker ps):

package main

import (
	"context"
	"fmt"

	"github.com/docker/docker/api/types"
	"github.com/docker/docker/client"
)

func main() {
	cli, err := client.NewEnvClient()
	if err != nil {
		panic(err)
	}

	containers, err := cli.ContainerList(context.Background(), types.ContainerListOptions{})
	if err != nil {
		panic(err)
	}

	for _, container := range containers {
		fmt.Printf("%s %s\n", container.ID[:10], container.Image)
	}
}

Full documentation is available on GoDoc.

# Functions

CheckRedirect

CheckRedirect specifies the policy for dealing with redirect responses: If the request is non-GET return `ErrRedirect`.

ErrorConnectionFailed

ErrorConnectionFailed returns an error with host in the error message when connection to docker daemon failed.

IsErrConnectionFailed

IsErrConnectionFailed returns true if the error is caused by connection failed.

IsErrNotFound

IsErrNotFound returns true if the error is a NotFound error, which is returned by the API when some object is not found.

IsErrNotImplemented

IsErrNotImplemented returns true if the error is a NotImplemented error.

IsErrPluginPermissionDenied

IsErrPluginPermissionDenied returns true if the error is caused when a user denies a plugin's permissions.

IsErrUnauthorized

IsErrUnauthorized returns true if the error is caused when a remote registry authentication fails.

NewClient

NewClient initializes a new API client for the given host and API version.

NewEnvClient

NewEnvClient initializes a new API client based on environment variables.

ParseHost

ParseHost parses a url string, validates the strings is a host url, and returns the parsed host as: protocol, address, and base path Deprecated: use ParseHostURL.

ParseHostURL

ParseHostURL parses a url string, validates the string is a host url, and returns the parsed URL.