moby--moby/client
Tobias Pfandzelter 963e5afc04 Update documentation to reflect deprecation of "NewEnvClient"
As `NewEnvClient` is deprecated in favor of `NewClientWithOpts`, the main package documentation should reflect this. This is also the text that appears on godoc.org so it's quite important that it is correct (for newbies like me)

Signed-off-by: Tobias Pfandzelter <pfandzelter@campus.tu-berlin.de>
2020-10-03 15:12:30 +02:00
..
testdata
README.md
build_cancel.go
build_prune.go
checkpoint_create.go
checkpoint_create_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
checkpoint_delete.go
checkpoint_delete_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
checkpoint_list.go
checkpoint_list_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
client.go Update documentation to reflect deprecation of "NewEnvClient" 2020-10-03 15:12:30 +02:00
client_deprecated.go
client_mock_test.go
client_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
client_unix.go Enable client on netbsd and dragonfly 2020-06-20 01:32:35 +02:00
client_windows.go
config_create.go
config_create_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
config_inspect.go
config_inspect_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
config_list.go
config_list_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
config_remove.go
config_remove_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
config_update.go
config_update_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
container_attach.go
container_commit.go
container_commit_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
container_copy.go
container_copy_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
container_create.go Accept platform spec on container create 2020-03-20 16:10:36 -07:00
container_create_test.go Accept platform spec on container create 2020-03-20 16:10:36 -07:00
container_diff.go
container_diff_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
container_exec.go
container_exec_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
container_export.go
container_export_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
container_inspect.go
container_inspect_test.go TestContainerInspectNode: document test as being for classic swarm 2020-01-06 12:25:00 +01:00
container_kill.go
container_kill_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
container_list.go fix nolint comments for SA1019: filters.ToParamWithVersion is deprecated 2019-10-18 00:45:33 +02:00
container_list_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
container_logs.go
container_logs_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
container_pause.go
container_pause_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
container_prune.go
container_prune_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
container_remove.go
container_remove_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
container_rename.go
container_rename_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
container_resize.go
container_resize_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
container_restart.go
container_restart_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
container_start.go
container_start_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
container_stats.go Add stats options to not prime the stats 2020-02-28 09:54:37 -08:00
container_stats_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
container_stop.go
container_stop_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
container_top.go
container_top_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
container_unpause.go
container_unpause_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
container_update.go
container_update_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
container_wait.go
container_wait_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
disk_usage.go
disk_usage_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
distribution_inspect.go
distribution_inspect_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
errors.go Replace errors.Cause() with errors.Is() / errors.As() 2020-04-29 00:28:41 +02:00
events.go fix nolint comments for SA1019: filters.ToParamWithVersion is deprecated 2019-10-18 00:45:33 +02:00
events_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
hijack.go fix nolint comments for SA1019: filters.ToParamWithVersion is deprecated 2019-10-18 00:45:33 +02:00
hijack_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
image_build.go
image_build_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
image_create.go
image_create_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
image_history.go
image_history_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
image_import.go client: normalize comment formatting 2019-11-27 15:44:49 +01:00
image_import_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
image_inspect.go
image_inspect_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
image_list.go fix nolint comments for SA1019: filters.ToParamWithVersion is deprecated 2019-10-18 00:45:33 +02:00
image_list_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
image_load.go
image_load_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
image_prune.go
image_prune_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
image_pull.go
image_pull_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
image_push.go client.ImagePush(): default to ":latest" instead of "all tags" 2019-12-10 12:24:14 +01:00
image_push_test.go client.ImagePush(): default to ":latest" instead of "all tags" 2019-12-10 12:24:14 +01:00
image_remove.go
image_remove_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
image_save.go
image_save_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
image_search.go
image_search_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
image_tag.go
image_tag_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
info.go
info_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
interface.go Merge pull request #40725 from cpuguy83/check_img_platform 2020-05-21 11:33:27 -07:00
interface_experimental.go
interface_stable.go
login.go
network_connect.go
network_connect_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
network_create.go
network_create_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
network_disconnect.go
network_disconnect_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
network_inspect.go
network_inspect_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
network_list.go fix nolint comments for SA1019: filters.ToParamWithVersion is deprecated 2019-10-18 00:45:33 +02:00
network_list_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
network_prune.go
network_prune_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
network_remove.go
network_remove_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
node_inspect.go
node_inspect_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
node_list.go
node_list_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
node_remove.go
node_remove_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
node_update.go
node_update_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
options.go
options_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
ping.go remove extra space in code comment in ping.go 2020-01-20 00:04:53 -05:00
ping_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
plugin_create.go
plugin_disable.go
plugin_disable_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
plugin_enable.go
plugin_enable_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
plugin_inspect.go
plugin_inspect_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
plugin_install.go
plugin_list.go fix nolint comments for SA1019: filters.ToParamWithVersion is deprecated 2019-10-18 00:45:33 +02:00
plugin_list_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
plugin_push.go
plugin_push_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
plugin_remove.go
plugin_remove_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
plugin_set.go
plugin_set_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
plugin_upgrade.go
request.go Check for context error that is wrapped in url.Error 2020-08-03 15:59:22 +03:00
request_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
secret_create.go
secret_create_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
secret_inspect.go
secret_inspect_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
secret_list.go
secret_list_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
secret_remove.go
secret_remove_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
secret_update.go
secret_update_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
service_create.go extract logic for resolving image/plugin digest and platform 2020-04-16 21:30:57 +02:00
service_create_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
service_inspect.go
service_inspect_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
service_list.go Add support for sending down service Running and Desired task counts 2019-10-14 10:43:00 -05:00
service_list_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
service_logs.go
service_logs_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
service_remove.go
service_remove_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
service_update.go extract logic for resolving image/plugin digest and platform 2020-04-16 21:30:57 +02:00
service_update_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
swarm_get_unlock_key.go
swarm_get_unlock_key_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
swarm_init.go
swarm_init_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
swarm_inspect.go
swarm_inspect_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
swarm_join.go
swarm_join_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
swarm_leave.go
swarm_leave_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
swarm_unlock.go
swarm_unlock_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
swarm_update.go
swarm_update_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
task_inspect.go
task_inspect_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
task_list.go
task_list_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
task_logs.go
transport.go
utils.go
version.go
volume_create.go
volume_create_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00
volume_inspect.go
volume_inspect_test.go bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
volume_list.go fix nolint comments for SA1019: filters.ToParamWithVersion is deprecated 2019-10-18 00:45:33 +02:00
volume_list_test.go client: reduce string-matching in tests 2019-10-13 17:00:40 +02:00
volume_prune.go
volume_remove.go
volume_remove_test.go Merge pull request #40080 from thaJeztah/client_string_matching 2019-10-17 11:38:00 -07:00

README.md

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.NewClientWithOpts(client.FromEnv)
	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.