mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
a2b529ead2
--help and help are successful commands so output should not go to error.
QE teams have requested this change, also users doing docker help | less
or docker run --help | less would expect this to work.
Usage statement should only be printed when the user asks for it.
Errors should print error message and then suggest the docker COMMAND --help
command to see usage information.
The current behaviour causes the user to have to search for the error message
and sometimes scrolls right off the screen. For example a error on a
"docker run" command is very difficult to diagnose.
Finally erros should always exit with a non 0 exit code, if the user
makes a CLI error.
Docker-DCO-1.1-Signed-off-by: Dan Walsh <dwalsh@redhat.com> (github: rhatdan)
75 lines
2.3 KiB
Markdown
75 lines
2.3 KiB
Markdown
% DOCKER(1) Docker User Manuals
|
|
% Docker Community
|
|
% JUNE 2014
|
|
# NAME
|
|
docker-images - List images
|
|
|
|
# SYNOPSIS
|
|
**docker images**
|
|
[**--help**]
|
|
[**-a**|**--all**[=*false*]]
|
|
[**-f**|**--filter**[=*[]*]]
|
|
[**--no-trunc**[=*false*]]
|
|
[**-q**|**--quiet**[=*false*]]
|
|
[REPOSITORY]
|
|
|
|
# DESCRIPTION
|
|
This command lists the images stored in the local Docker repository.
|
|
|
|
By default, intermediate images, used during builds, are not listed. Some of the
|
|
output, e.g., image ID, is truncated, for space reasons. However the truncated
|
|
image ID, and often the first few characters, are enough to be used in other
|
|
Docker commands that use the image ID. The output includes repository, tag, image
|
|
ID, date created and the virtual size.
|
|
|
|
The title REPOSITORY for the first title may seem confusing. It is essentially
|
|
the image name. However, because you can tag a specific image, and multiple tags
|
|
(image instances) can be associated with a single name, the name is really a
|
|
repository for all tagged images of the same name. For example consider an image
|
|
called fedora. It may be tagged with 18, 19, or 20, etc. to manage different
|
|
versions.
|
|
|
|
# OPTIONS
|
|
**-a**, **--all**=*true*|*false*
|
|
Show all images (by default filter out the intermediate image layers). The default is *false*.
|
|
|
|
**-f**, **--filter**=[]
|
|
Provide filter values (i.e. 'dangling=true')
|
|
|
|
**--help**
|
|
Print usage statement
|
|
|
|
**--no-trunc**=*true*|*false*
|
|
Don't truncate output. The default is *false*.
|
|
|
|
**-q**, **--quiet**=*true*|*false*
|
|
Only show numeric IDs. The default is *false*.
|
|
|
|
# EXAMPLES
|
|
|
|
## Listing the images
|
|
|
|
To list the images in a local repository (not the registry) run:
|
|
|
|
docker images
|
|
|
|
The list will contain the image repository name, a tag for the image, and an
|
|
image ID, when it was created and its virtual size. Columns: REPOSITORY, TAG,
|
|
IMAGE ID, CREATED, and VIRTUAL SIZE.
|
|
|
|
To get a verbose list of images which contains all the intermediate images
|
|
used in builds use **-a**:
|
|
|
|
docker images -a
|
|
|
|
## Listing only the shortened image IDs
|
|
|
|
Listing just the shortened image IDs. This can be useful for some automated
|
|
tools.
|
|
|
|
docker images -q
|
|
|
|
# HISTORY
|
|
April 2014, Originally compiled by William Henry (whenry at redhat dot com)
|
|
based on docker.com source material and internal work.
|
|
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|