Section 1: user commands and tools
NAME docker-export – Export the contents of a container’s filesystem as a tar archive SYNOPSIS docker export [–help] [-o|–output[=""]] CONTAINER DESCRIPTION Export the contents of a container’s filesystem using the full or shortened container ID or container name. The output is exported to STDOUT and can be redirected to a tar file. Stream to a…
NAME docker-exec – Run a command in a running container SYNOPSIS docker exec [-d|–detach] [–detach-keys[=[]]] [–help] [-i|–interactive] [–privileged] [-t|–tty] [-u|–user[=USER]] CONTAINER COMMAND [ARG…] DESCRIPTION Run a process in a running container. The command started using docker exec will only run while the container’s primary process (PID 1) is running, and will not be restarted if…
NAME docker-events – Get real time events from the server SYNOPSIS docker events [–help] [-f|–filter[=[]]] [–since[=SINCE]] [–until[=UNTIL]] DESCRIPTION Get event information from the Docker daemon. Information can include historical information and real-time information. Docker containers will report the following events: attach, commit, copy, create, destroy, detach, die, exec_create, exec_detach, exec_start, export, kill, oom, pause, rename,…
NAME docker-diff – Inspect changes on a container’s filesystem SYNOPSIS docker diff [–help] CONTAINER DESCRIPTION Inspect changes on a container’s filesystem. You can use the full or shortened container ID or the container name set using docker run –name option. OPTIONS –help Print usage statement EXAMPLES Inspect the changes to on a nginx container: #…
NAME docker-create – Create a new container SYNOPSIS docker create [-a|–attach[=[]]] [–add-host[=[]]] [–blkio-weight[=[BLKIO-WEIGHT]]] [–blkio-weight-device[=[]]] [–cpu-shares[=0]] [–cap-add[=[]]] [–cap-drop[=[]]] [–cgroup-parent[=CGROUP-PATH]] [–cidfile[=CIDFILE]] [–cpu-period[=0]] [–cpu-quota[=0]] [–cpuset-cpus[=CPUSET-CPUS]] [–cpuset-mems[=CPUSET-MEMS]] [–device[=[]]] [–device-read-bps[=[]]] [–device-read-iops[=[]]] [–device-write-bps[=[]]] [–device-write-iops[=[]]] [–dns[=[]]] [–dns-search[=[]]] [–dns-opt[=[]]] [-e|–env[=[]]] [–entrypoint[=ENTRYPOINT]] [–env-file[=[]]] [–expose[=[]]] [–group-add[=[]]] [-h|–hostname[=HOSTNAME]] [–help] [-i|–interactive] [–ip[=IPv4-ADDRESS]] [–ip6[=IPv6-ADDRESS]] [–ipc[=IPC]] [–isolation[=default]] [–kernel-memory[=KERNEL-MEMORY]] [-l|–label[=[]]] [–label-file[=[]]] [–link[=[]]] [–link-local-ip[=[]]] [–log-driver[=[]]] [–log-opt[=[]]] [-m|–memory[=MEMORY]] [–mac-address[=MAC-ADDRESS]] [–memory-reservation[=MEMORY-RESERVATION]] [–memory-swap[=LIMIT]] [–memory-swappiness[=MEMORY-SWAPPINESS]]…
NAME docker-cp – Copy files/folders between a container and the local filesystem. SYNOPSIS docker cp [–help] CONTAINER:SRC_PATH DEST_PATH|- docker cp [–help] SRC_PATH|- CONTAINER:DEST_PATH DESCRIPTION The docker cp utility copies the contents of SRC_PATH to the DEST_PATH. You can copy from the container’s file system to the local machine or the reverse, from the local filesystem…
NAME docker-commit – Create a new image from a container’s changes SYNOPSIS docker commit [-a|–author[=AUTHOR]] [-c|–change[=[DOCKERFILE INSTRUCTIONS]]] [–help] [-m|–message[=MESSAGE]] [-p|–pause[=true]] CONTAINER [REPOSITORY[:TAG]] DESCRIPTION Create a new image from an existing container specified by name or container ID. The new image will contain the contents of the container filesystem, excluding any data volumes. Refer to docker-tag(1)…
NAME docker-build – Build a new image from the source code at PATH SYNOPSIS docker build [–build-arg[=[]]] [–cpu-shares[=0]] [–cgroup-parent[=CGROUP-PARENT]] [–help] [-f|–file[=PATH/Dockerfile]] [–force-rm] [–isolation[=default]] [–label[=[]]] [–no-cache] [–pull] [-q|–quiet] [–rm[=true]] [-t|–tag[=[]]] [-m|–memory[=MEMORY]] [–memory-swap[=LIMIT]] [–shm-size[=SHM-SIZE]] [–cpu-period[=0]] [–cpu-quota[=0]] [–cpuset-cpus[=CPUSET-CPUS]] [–cpuset-mems[=CPUSET-MEMS]] [–ulimit[=[]]] [-v|–volume[=[]]] PATH | URL | – DESCRIPTION This will read the Dockerfile from the directory specified in PATH….
NAME docker-attach – Attach to a running container SYNOPSIS docker attach [–detach-keys[=[]]] [–help] [–no-stdin] [–sig-proxy[=true]] CONTAINER DESCRIPTION The docker attach command allows you to attach to a running container using the container’s ID or name, either to view its ongoing output or to control it interactively. You can attach to the same contained process multiple…
NAME docker-kill – Kill one or more running containers SYNOPSIS docker kill [OPTIONS] CONTAINER [CONTAINER…] DESCRIPTION Alias for docker container kill. OPTIONS -h, –help[=false] help for kill -s, –signal="KILL" Signal to send to the container SEE ALSO docker(1) Index
NAME docker-inspect – Return low-level information on Docker objects SYNOPSIS docker inspect [OPTIONS] NAME|ID [NAME|ID…] DESCRIPTION This displays the low-level information on Docker object(s) (e.g. container, image, volume,network, node, service, or task) identified by name or ID. By default, this will render all results in a JSON array. If the container and image have the…
NAME docker-info – Display system-wide information SYNOPSIS docker info [OPTIONS] DESCRIPTION Alias for docker system info. OPTIONS -f, –format="" Format the output using the given Go template -h, –help[=false] help for info SEE ALSO docker(1) Index
NAME docker-import – Import the contents from a tarball to create a filesystem image SYNOPSIS docker import [OPTIONS] file|URL|- [REPOSITORY[:TAG]] DESCRIPTION Alias for docker image import. OPTIONS -c, –change= Apply Dockerfile instruction to the created image -h, –help[=false] help for import -m, –message="" Set commit message for imported image –platform="" Set platform if server is…
NAME docker-images – List images SYNOPSIS docker images [OPTIONS] [REPOSITORY[:TAG]] DESCRIPTION Alias for docker image ls. OPTIONS -a, –all[=false] Show all images (default hides intermediate images) –digests[=false] Show digests -f, –filter= Filter output based on conditions provided –format="" Pretty-print images using a Go template -h, –help[=false] help for images –no-trunc[=false] Don’t truncate output -q, –quiet[=false]…
NAME docker-image – Manage images SYNOPSIS docker image DESCRIPTION Manage images OPTIONS -h, –help[=false] help for image SEE ALSO docker(1), docker-image-build(1), docker-image-history(1), docker-image-import(1), docker-image-inspect(1), docker-image-load(1), docker-image-ls(1), docker-image-prune(1), docker-image-pull(1), docker-image-push(1), docker-image-rm(1), docker-image-save(1), docker-image-tag(1) Index
NAME docker-image-tag – Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE SYNOPSIS docker image tag SOURCE_IMAGE[:TAG] TARGET_IMAGE[:TAG] DESCRIPTION Assigns a new alias to an image in a registry. An alias refers to the entire image name including the optional TAG after the ‘:’. OPTIONS NAME The image name which is made up of slash-separated name…
NAME docker-image-save – Save one or more images to a tar archive (streamed to STDOUT by default) SYNOPSIS docker image save [OPTIONS] IMAGE [IMAGE…] DESCRIPTION Produces a tarred repository to the standard output stream. Contains all parent layers, and all tags + versions, or specified repo:tag. Stream to a file instead of STDOUT by using…
NAME docker-image-rm – Remove one or more images SYNOPSIS docker image rm [OPTIONS] IMAGE [IMAGE…] DESCRIPTION Removes (and un-tags) one or more images from the host node. If an image has multiple tags, using this command with the tag as a parameter only removes the tag. If the tag is the only one for the…
NAME docker-image-push – Push an image or a repository to a registry SYNOPSIS docker image push [OPTIONS] NAME[:TAG] DESCRIPTION Use docker image push to share your images to the Docker Hub <https://hub.docker.com> registry or to a self-hosted one. Refer to docker-image-tag(1) for more information about valid image and tag names. Killing the docker image push…
NAME docker-image-pull – Pull an image or a repository from a registry SYNOPSIS docker image pull [OPTIONS] NAME[:TAG|@DIGEST] DESCRIPTION This command pulls down an image or a repository from a registry. If there is more than one image for a repository (e.g., fedora) then all images for that repository name can be pulled down including…