mirror of
https://github.com/docker/cli.git
synced 2025-08-31 23:02:07 +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>
83 lines
3.7 KiB
Markdown
83 lines
3.7 KiB
Markdown
---
|
|
title: "history"
|
|
description: "The history command description and usage"
|
|
keywords: "docker, image, history"
|
|
---
|
|
|
|
# history
|
|
|
|
```markdown
|
|
Usage: docker history [OPTIONS] IMAGE
|
|
|
|
Show the history of an image
|
|
|
|
Aliases:
|
|
docker image history, docker history
|
|
|
|
Options:
|
|
--format string Pretty-print images using a Go template
|
|
--help Print usage
|
|
-H, --human Print sizes and dates in human readable format (default true)
|
|
--no-trunc Don't truncate output
|
|
-q, --quiet Only show image IDs
|
|
```
|
|
|
|
|
|
## Examples
|
|
|
|
To see how the `docker:latest` image was built:
|
|
|
|
```console
|
|
$ docker history docker
|
|
|
|
IMAGE CREATED CREATED BY SIZE COMMENT
|
|
3e23a5875458 8 days ago /bin/sh -c #(nop) ENV LC_ALL=C.UTF-8 0 B
|
|
8578938dd170 8 days ago /bin/sh -c dpkg-reconfigure locales && loc 1.245 MB
|
|
be51b77efb42 8 days ago /bin/sh -c apt-get update && apt-get install 338.3 MB
|
|
4b137612be55 6 weeks ago /bin/sh -c #(nop) ADD jessie.tar.xz in / 121 MB
|
|
750d58736b4b 6 weeks ago /bin/sh -c #(nop) MAINTAINER Tianon Gravi <ad 0 B
|
|
511136ea3c5a 9 months ago 0 B Imported from -
|
|
```
|
|
|
|
To see how the `docker:apache` image was added to a container's base image:
|
|
|
|
```console
|
|
$ docker history docker:scm
|
|
IMAGE CREATED CREATED BY SIZE COMMENT
|
|
2ac9d1098bf1 3 months ago /bin/bash 241.4 MB Added Apache to Fedora base image
|
|
88b42ffd1f7c 5 months ago /bin/sh -c #(nop) ADD file:1fd8d7f9f6557cafc7 373.7 MB
|
|
c69cab00d6ef 5 months ago /bin/sh -c #(nop) MAINTAINER Lokesh Mandvekar 0 B
|
|
511136ea3c5a 19 months ago 0 B Imported from -
|
|
```
|
|
|
|
### <a name=format></a> Format the output (--format)
|
|
|
|
The formatting option (`--format`) will pretty-prints history output
|
|
using a Go template.
|
|
|
|
Valid placeholders for the Go template are listed below:
|
|
|
|
| Placeholder | Description |
|
|
|-----------------|-----------------------------------------------------------------------------------------------------------|
|
|
| `.ID` | Image ID |
|
|
| `.CreatedSince` | Elapsed time since the image was created if `--human=true`, otherwise timestamp of when image was created |
|
|
| `.CreatedAt` | Timestamp of when image was created |
|
|
| `.CreatedBy` | Command that was used to create the image |
|
|
| `.Size` | Image disk size |
|
|
| `.Comment` | Comment for image |
|
|
|
|
When using the `--format` option, the `history` command will either
|
|
output the data exactly as the template declares or, when using the
|
|
`table` directive, will include column headers as well.
|
|
|
|
The following example uses a template without headers and outputs the
|
|
`ID` and `CreatedSince` entries separated by a colon (`:`) for the `busybox`
|
|
image:
|
|
|
|
```console
|
|
$ docker history --format "{{.ID}}: {{.CreatedSince}}" busybox
|
|
|
|
f6e427c148a7: 4 weeks ago
|
|
<missing>: 4 weeks ago
|
|
```
|