mirror of
https://github.com/docker/cli.git
synced 2025-08-27 13:42:00 +03:00
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>
111 lines
3.8 KiB
Markdown
111 lines
3.8 KiB
Markdown
---
|
|
title: "rmi"
|
|
description: "The rmi command description and usage"
|
|
keywords: "remove, image, Docker"
|
|
---
|
|
|
|
# rmi
|
|
|
|
```markdown
|
|
Usage: docker rmi [OPTIONS] IMAGE [IMAGE...]
|
|
|
|
Remove one or more images
|
|
|
|
Aliases:
|
|
docker image rm, docker rmi
|
|
|
|
Options:
|
|
-f, --force Force removal of the image
|
|
--help Print usage
|
|
--no-prune Do not delete untagged parents
|
|
```
|
|
|
|
## 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 image, both the image and the tag are
|
|
removed.
|
|
|
|
This does not remove images from a registry. You cannot remove an image of a
|
|
running container unless you use the `-f` option. To see all images on a host
|
|
use the [`docker image ls`](images.md) command.
|
|
|
|
## Examples
|
|
|
|
You can remove an image using its short or long ID, its tag, or its digest. If
|
|
an image has one or more tags referencing it, you must remove all of them before
|
|
the image is removed. Digest references are removed automatically when an image
|
|
is removed by tag.
|
|
|
|
```console
|
|
$ docker images
|
|
|
|
REPOSITORY TAG IMAGE ID CREATED SIZE
|
|
test1 latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB)
|
|
test latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB)
|
|
test2 latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB)
|
|
|
|
$ docker rmi fd484f19954f
|
|
|
|
Error: Conflict, cannot delete image fd484f19954f because it is tagged in multiple repositories, use -f to force
|
|
2013/12/11 05:47:16 Error: failed to remove one or more images
|
|
|
|
$ docker rmi test1:latest
|
|
|
|
Untagged: test1:latest
|
|
|
|
$ docker rmi test2:latest
|
|
|
|
Untagged: test2:latest
|
|
|
|
|
|
$ docker images
|
|
|
|
REPOSITORY TAG IMAGE ID CREATED SIZE
|
|
test latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB)
|
|
|
|
$ docker rmi test:latest
|
|
|
|
Untagged: test:latest
|
|
Deleted: fd484f19954f4920da7ff372b5067f5b7ddb2fd3830cecd17b96ea9e286ba5b8
|
|
```
|
|
|
|
If you use the `-f` flag and specify the image's short or long ID, then this
|
|
command untags and removes all images that match the specified ID.
|
|
|
|
```console
|
|
$ docker images
|
|
|
|
REPOSITORY TAG IMAGE ID CREATED SIZE
|
|
test1 latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB)
|
|
test latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB)
|
|
test2 latest fd484f19954f 23 seconds ago 7 B (virtual 4.964 MB)
|
|
|
|
$ docker rmi -f fd484f19954f
|
|
|
|
Untagged: test1:latest
|
|
Untagged: test:latest
|
|
Untagged: test2:latest
|
|
Deleted: fd484f19954f4920da7ff372b5067f5b7ddb2fd3830cecd17b96ea9e286ba5b8
|
|
```
|
|
|
|
An image pulled by digest has no tag associated with it:
|
|
|
|
```console
|
|
$ docker images --digests
|
|
|
|
REPOSITORY TAG DIGEST IMAGE ID CREATED SIZE
|
|
localhost:5000/test/busybox <none> sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf 4986bf8c1536 9 weeks ago 2.43 MB
|
|
```
|
|
|
|
To remove an image using its digest:
|
|
|
|
```console
|
|
$ docker rmi localhost:5000/test/busybox@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf
|
|
Untagged: localhost:5000/test/busybox@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf
|
|
Deleted: 4986bf8c15363d1c5d15512d5266f8777bfba4974ac56e3270e7760f6f0a8125
|
|
Deleted: ea13149945cb6b1e746bf28032f02e9b5a793523481a0a18645fc77ad53c4ea2
|
|
Deleted: df7546f9f060a2268024c8a230d8639878585defcc1bc6f79d2728a13957871b
|
|
```
|