moby--moby/client
Sebastiaan van Stijn 340711db3d
api: add types/volume.ListOptions for a more consistent API
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-08-03 23:30:28 +02:00
..
testdata
README.md
build_cancel.go
build_prune.go
checkpoint_create.go
checkpoint_create_test.go
checkpoint_delete.go
checkpoint_delete_test.go
checkpoint_list.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
checkpoint_list_test.go
client.go gofmt GoDoc comments with go1.19 2022-07-08 19:56:23 +02:00
client_deprecated.go
client_mock_test.go
client_test.go replace deprecated gotest.tools' env.Patch() with t.SetEnv() 2022-05-28 12:12:39 +02:00
client_unix.go client: add const for environment variables, and document them 2022-03-07 12:35:55 +01:00
client_windows.go client: add const for environment variables, and document them 2022-03-07 12:35:55 +01:00
config_create.go
config_create_test.go
config_inspect.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
config_inspect_test.go
config_list.go
config_list_test.go
config_remove.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
config_remove_test.go
config_update.go api/types/swarm: Version: implement stringer interface 2022-05-13 02:40:14 +02:00
config_update_test.go
container_attach.go gofmt GoDoc comments with go1.19 2022-07-08 19:56:23 +02:00
container_commit.go
container_commit_test.go
container_copy.go client: CopyToContainer(), CopyFromContainer(): remove status-code handling 2022-04-19 08:28:20 +02:00
container_copy_test.go client: CopyToContainer(), CopyFromContainer(): remove status-code handling 2022-04-19 08:28:20 +02:00
container_create.go daemon/linux: Set console size on creation 2022-05-19 07:57:27 +02:00
container_create_test.go update uses of container.ContainerCreateCreatedBody to CreateResponse 2022-04-28 22:39:20 +02:00
container_diff.go
container_diff_test.go
container_exec.go container/exec: Support ConsoleSize 2022-06-24 11:54:25 +02:00
container_exec_test.go
container_export.go
container_export_test.go
container_inspect.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
container_inspect_test.go
container_kill.go client: ContainerKill(): don't send signal query-param if none was set 2022-04-19 17:40:33 +02:00
container_kill_test.go
container_list.go client: container ps: don't set "limit" if none was set 2022-03-31 19:59:17 +02:00
container_list_test.go client: container ps: don't set "limit" if none was set 2022-03-31 19:59:17 +02:00
container_logs.go gofmt GoDoc comments with go1.19 2022-07-08 19:56:23 +02:00
container_logs_test.go
container_pause.go
container_pause_test.go
container_prune.go
container_prune_test.go
container_remove.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
container_remove_test.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
container_rename.go
container_rename_test.go
container_resize.go
container_resize_test.go
container_restart.go client: ContainerStop(), ContainerRestart(): support stop-signal 2022-04-20 21:29:34 +02:00
container_restart_test.go client: ContainerStop(), ContainerRestart(): support stop-signal 2022-04-20 21:29:34 +02:00
container_start.go
container_start_test.go
container_stats.go
container_stats_test.go
container_stop.go client: ContainerStop(), ContainerRestart(): support stop-signal 2022-04-20 21:29:34 +02:00
container_stop_test.go client: ContainerStop(), ContainerRestart(): support stop-signal 2022-04-20 21:29:34 +02:00
container_top.go
container_top_test.go
container_unpause.go
container_unpause_test.go
container_update.go
container_update_test.go
container_wait.go api: rename ContainerWaitOKBody to container.WaitResponse 2022-04-28 22:38:20 +02:00
container_wait_test.go api: rename ContainerWaitOKBody to container.WaitResponse 2022-04-28 22:38:20 +02:00
disk_usage.go
disk_usage_test.go
distribution_inspect.go api: add const for 'X-Registry-Auth' 2022-07-29 23:04:34 +02:00
distribution_inspect_test.go
envvars.go client: add const for environment variables, and document them 2022-03-07 12:35:55 +01:00
errors.go client: errors: remove dead code 2022-07-09 00:54:36 +02:00
events.go
events_test.go Merge pull request #42770 from thaJeztah/eventtype_enums 2021-08-28 00:23:56 +09:00
hijack.go Make it explicit raw|multiplexed stream implementation being used 2022-05-12 11:36:31 +02:00
hijack_test.go
image_build.go
image_build_test.go client: use types/registry.AuthConfig 2022-07-29 23:05:15 +02:00
image_create.go api: add const for 'X-Registry-Auth' 2022-07-29 23:04:34 +02:00
image_create_test.go api: add const for 'X-Registry-Auth' 2022-07-29 23:04:34 +02:00
image_history.go
image_history_test.go
image_import.go
image_import_test.go
image_inspect.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
image_inspect_test.go
image_list.go
image_list_test.go
image_load.go
image_load_test.go
image_prune.go
image_prune_test.go
image_pull.go
image_pull_test.go client: linting: fix "invalid auth header" error 2022-07-29 23:05:22 +02:00
image_push.go api: add const for 'X-Registry-Auth' 2022-07-29 23:04:34 +02:00
image_push_test.go client: linting: fix "invalid auth header" error 2022-07-29 23:05:22 +02:00
image_remove.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
image_remove_test.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
image_save.go
image_save_test.go
image_search.go api: add const for 'X-Registry-Auth' 2022-07-29 23:04:34 +02:00
image_search_test.go client: linting: fix "invalid auth header" error 2022-07-29 23:05:22 +02:00
image_tag.go
image_tag_test.go
info.go
info_test.go
interface.go api: add types/volume.ListOptions for a more consistent API 2022-08-03 23:30:28 +02:00
interface_experimental.go
interface_stable.go
login.go client: use types/registry.AuthConfig 2022-07-29 23:05:15 +02:00
network_connect.go
network_connect_test.go
network_create.go
network_create_test.go
network_disconnect.go
network_disconnect_test.go
network_inspect.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
network_inspect_test.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
network_list.go
network_list_test.go
network_prune.go
network_prune_test.go
network_remove.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
network_remove_test.go
node_inspect.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
node_inspect_test.go
node_list.go
node_list_test.go
node_remove.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
node_remove_test.go
node_update.go api/types/swarm: Version: implement stringer interface 2022-05-13 02:40:14 +02:00
node_update_test.go
options.go client: add const for environment variables, and document them 2022-03-07 12:35:55 +01:00
options_test.go replace deprecated gotest.tools' env.Patch() with t.SetEnv() 2022-05-28 12:12:39 +02:00
ping.go client: Ping(): add handling for swarm status headers 2022-03-25 23:57:58 +01:00
ping_test.go client: Ping(): add handling for swarm status headers 2022-03-25 23:57:58 +01:00
plugin_create.go
plugin_disable.go
plugin_disable_test.go
plugin_enable.go
plugin_enable_test.go
plugin_inspect.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
plugin_inspect_test.go
plugin_install.go api: add const for 'X-Registry-Auth' 2022-07-29 23:04:34 +02:00
plugin_list.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
plugin_list_test.go
plugin_push.go api: add const for 'X-Registry-Auth' 2022-07-29 23:04:34 +02:00
plugin_push_test.go client: linting: fix "invalid auth header" error 2022-07-29 23:05:22 +02:00
plugin_remove.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
plugin_remove_test.go
plugin_set.go
plugin_set_test.go
plugin_upgrade.go api: add const for 'X-Registry-Auth' 2022-07-29 23:04:34 +02:00
request.go linting: error strings should not be capitalized (revive) 2022-07-04 10:15:06 +02:00
request_test.go
secret_create.go
secret_create_test.go
secret_inspect.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
secret_inspect_test.go
secret_list.go
secret_list_test.go
secret_remove.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
secret_remove_test.go
secret_update.go api/types/swarm: Version: implement stringer interface 2022-05-13 02:40:14 +02:00
secret_update_test.go
service_create.go api: add const for 'X-Registry-Auth' 2022-07-29 23:04:34 +02:00
service_create_test.go remove unneeded "digest" alias for "go-digest" 2022-03-04 14:49:42 +01:00
service_inspect.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
service_inspect_test.go
service_list.go
service_list_test.go
service_logs.go
service_logs_test.go
service_remove.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
service_remove_test.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
service_update.go api: add const for 'X-Registry-Auth' 2022-07-29 23:04:34 +02:00
service_update_test.go
swarm_get_unlock_key.go
swarm_get_unlock_key_test.go
swarm_init.go
swarm_init_test.go
swarm_inspect.go
swarm_inspect_test.go
swarm_join.go
swarm_join_test.go
swarm_leave.go
swarm_leave_test.go
swarm_unlock.go
swarm_unlock_test.go
swarm_update.go api/types/swarm: Version: implement stringer interface 2022-05-13 02:40:14 +02:00
swarm_update_test.go
task_inspect.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
task_inspect_test.go
task_list.go
task_list_test.go
task_logs.go
transport.go
utils.go
version.go
volume_create.go api: rename volume.VolumeCreateBody to volume.CreateOptions 2022-04-28 22:39:14 +02:00
volume_create_test.go api: rename volume.VolumeCreateBody to volume.CreateOptions 2022-04-28 22:39:14 +02:00
volume_inspect.go api/types: replace uses of deprecated types.Volume with volume.Volume 2022-04-21 19:50:59 +02:00
volume_inspect_test.go imports: remove "volumetypes" aliases for api/types/volume 2022-04-28 22:39:04 +02:00
volume_list.go api: add types/volume.ListOptions for a more consistent API 2022-08-03 23:30:28 +02:00
volume_list_test.go api: add types/volume.ListOptions for a more consistent API 2022-08-03 23:30:28 +02:00
volume_prune.go
volume_remove.go client: remove wrapResponseError() 2022-03-20 19:04:52 +01:00
volume_remove_test.go
volume_update.go api/types/swarm: Version: implement stringer interface 2022-05-13 02:40:14 +02:00
volume_update_test.go Add Swarm cluster volume supports 2022-05-13 00:55:44 +02: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.