DockerCLI/docs/reference/commandline/index.md

13 KiB

title description keywords identifier
Docker commands Docker's CLI command description and usage Docker, Docker documentation, CLI, command line smn_cli_guide

The Docker commands

This section contains reference information on using Docker's command line client. Each command has a reference page along with samples. If you are unfamiliar with the command line, you should start by reading about how to Use the Docker command line.

You start the Docker daemon with the command line. How you start the daemon affects your Docker containers. For that reason you should also make sure to read the dockerd reference page.

Commands by object

Docker management commands

Command Description
dockerd Launch the Docker daemon
info Display system-wide information
inspect Return low-level information on a container or image
version Show the Docker version information

Image commands

Command Description
build Build an image from a Dockerfile
commit Create a new image from a container's changes
history Show the history of an image
images List images
import Import the contents from a tarball to create a filesystem image
load Load an image from a tar archive or STDIN
image prune Remove unused images
rmi Remove one or more images
save Save images to a tar archive
tag Tag an image into a repository

Container commands

Command Description
attach Attach to a running container
container prune Remove all stopped containers
cp Copy files/folders from a container to a HOSTDIR or to STDOUT
create Create a new container
diff Inspect changes on a container's filesystem
events Get real time events from the server
exec Run a command in a running container
export Export a container's filesystem as a tar archive
kill Kill a running container
logs Fetch the logs of a container
pause Pause all processes within a container
port List port mappings or a specific mapping for the container
ps List containers
rename Rename a container
restart Restart a running container
rm Remove one or more containers
run Run a command in a new container
start Start one or more stopped containers
stats Display a live stream of container(s) resource usage statistics
stop Stop a running container
top Display the running processes of a container
unpause Unpause all processes within a container
update Update configuration of one or more containers
wait Block until a container stops, then print its exit code

Hub and registry commands

Command Description
login Register or log in to a Docker registry
logout Log out from a Docker registry
pull Pull an image or a repository from a Docker registry
push Push an image or a repository to a Docker registry
search Search Docker Hub for images

Network and connectivity commands

Command Description
network connect Connect a container to a network
network create Create a new network
network disconnect Disconnect a container from a network
network inspect Display information about a network
network ls Lists all the networks the Engine daemon knows about
network prune Remove all unused networks
network rm Removes one or more networks

Shared data volume commands

Command Description
volume create Creates a new volume where containers can consume and store data
volume inspect Display information about a volume
volume ls Lists all the volumes Docker knows about
volume prune Remove all unused local volumes
volume rm Remove one or more volumes

Swarm node commands

Command Description
node demote Demotes an existing manager so that it is no longer a manager
node inspect Inspect a node in the swarm
node ls List nodes in the swarm
node promote Promote a node that is pending a promotion to manager
node ps List tasks running on one or more nodes
node rm Remove one or more nodes from the swarm
node update Update attributes for a node

Swarm management commands

Command Description
swarm init Initialize a swarm
swarm join Join a swarm as a manager node or worker node
swarm leave Remove the current node from the swarm
swarm join-token Display or rotate join tokens
swarm unlock Unlock swarm
swarm unlock-key Manage the unlock key
swarm update Update attributes of a swarm

Swarm service commands

Command Description
service create Create a new service
service inspect Inspect a service
service logs Fetch the logs of a service or task
service ls List services in the swarm
service ps List the tasks of a service
service rm Remove a service from the swarm
service scale Set the number of replicas for the desired state of the service
service update Update the attributes of a service

Swarm secret commands

Command Description
secret create Create a secret from a file or STDIN as content
secret inspect Inspect the specified secret
secret ls List secrets in the swarm
secret rm Remove the specified secrets from the swarm

Swarm stack commands

Command Description
stack deploy Deploy a new stack or update an existing stack
stack ls List stacks in the swarm
stack ps List the tasks in the stack
stack rm Remove the stack from the swarm
stack services List the services in the stack

Plugin commands

Command Description
plugin create Create a plugin from a rootfs and configuration
plugin disable Disable a plugin
plugin enable Enable a plugin
plugin inspect Display detailed information on a plugin
plugin install Install a plugin
plugin ls List plugins
plugin push Push a plugin to a registry
plugin rm Remove a plugin
plugin set Change settings for a plugin

Context commands

Command Description
context create Create a context
context export Export a context
context import Import a context
context ls List contexts
context rm Remove one or more contexts
context update Update a context
context use Set the current docker context
context inspect Inspect one or more contexts