80b1285fec
Cobra allows for aliases to be defined for a command, but only allows these
to be defined at the same level (for example, `docker image ls` as alias for
`docker image list`). Our CLI has some commands that are available both as a
top-level shorthand as well as `docker <object> <verb>` subcommands. For example,
`docker ps` is a shorthand for `docker container ps` / `docker container ls`.
This patch introduces a custom "aliases" annotation that can be used to print
all available aliases for a command. While this requires these aliases to be
defined manually, in practice the list of aliases rarely changes, so maintenance
should be minimal.
As a convention, we could consider the first command in this list to be the
canonical command, so that we can use this information to add redirects in
our documentation in future.
Before this patch:
docker images --help
Usage: docker images [OPTIONS] [REPOSITORY[:TAG]]
List images
Options:
-a, --all Show all images (default hides intermediate images)
...
With this patch:
docker images --help
Usage: docker images [OPTIONS] [REPOSITORY[:TAG]]
List images
Aliases:
docker image ls, docker image list, docker images
Options:
-a, --all Show all images (default hides intermediate images)
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
3.0 KiB
title, description, keywords
| title | description | keywords |
|---|---|---|
| rm | The rm command description and usage | remove, Docker, container |
rm
Usage: docker rm [OPTIONS] CONTAINER [CONTAINER...]
Remove one or more containers
Aliases:
docker container rm, docker rm
Options:
-f, --force Force the removal of a running container (uses SIGKILL)
--help Print usage
-l, --link Remove the specified link
-v, --volumes Remove anonymous volumes associated with the container
Examples
Remove a container
This removes the container referenced under the link /redis.
$ docker rm /redis
/redis
Remove a link specified with --link on the default bridge network (--link)
This removes the underlying link between /webapp and the /redis
containers on the default bridge network, removing all network communication
between the two containers. This does not apply when --link is used with
user-specified networks.
$ docker rm --link /webapp/redis
/webapp/redis
Force-remove a running container (--force)
This command force-removes a running container.
$ docker rm --force redis
redis
The main process inside the container referenced under the link redis will receive
SIGKILL, then the container will be removed.
Remove all stopped containers
Use the docker container prune command to remove all
stopped containers, or refer to the docker system prune
command to remove unused containers in addition to other Docker resources, such
as (unused) images and networks.
Alternatively, you can use the docker ps with the -q / --quiet option to
generate a list of container IDs to remove, and use that list as argument for
the docker rm command.
Combining commands can be more flexible, but is less portable as it depends on features provided by the shell, and the exact syntax may differ depending on what shell is used. To use this approach on Windows, consider using PowerShell or Bash.
The example below uses docker ps -q to print the IDs of all containers that
have exited (--filter status=exited), and removes those containers with
the docker rm command:
$ docker rm $(docker ps --filter status=exited -q)
Or, using the xargs Linux utility;
$ docker ps --filter status=exited -q | xargs docker rm
Remove a container and its volumes (-v, --volumes)
$ docker rm --volumes redis
redis
This command removes the container and any volumes associated with it. Note that if a volume was specified with a name, it will not be removed.
Remove a container and selectively remove volumes
$ docker create -v awesome:/foo -v /bar --name hello redis
hello
$ docker rm -v hello
In this example, the volume for /foo remains intact, but the volume for
/bar is removed. The same behavior holds for volumes inherited with
--volumes-from.