mirror of https://github.com/docker/cli.git
Add --format support to images command
- rename `api/client/ps` to `api/client/formatter` - add a a image formatter Signed-off-by: Vincent Demeester <vincent@sbr.pm>
This commit is contained in:
parent
fbb25d42f0
commit
1e3c5bbe15
|
@ -927,6 +927,9 @@ _docker_images() {
|
||||||
fi
|
fi
|
||||||
return
|
return
|
||||||
;;
|
;;
|
||||||
|
--format)
|
||||||
|
return
|
||||||
|
;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
case "${words[$cword-2]}$prev=" in
|
case "${words[$cword-2]}$prev=" in
|
||||||
|
@ -941,7 +944,7 @@ _docker_images() {
|
||||||
|
|
||||||
case "$cur" in
|
case "$cur" in
|
||||||
-*)
|
-*)
|
||||||
COMPREPLY=( $( compgen -W "--all -a --digests --filter -f --help --no-trunc --quiet -q" -- "$cur" ) )
|
COMPREPLY=( $( compgen -W "--all -a --digests --filter -f --format --help --no-trunc --quiet -q" -- "$cur" ) )
|
||||||
;;
|
;;
|
||||||
=)
|
=)
|
||||||
return
|
return
|
||||||
|
|
|
@ -692,8 +692,9 @@ __docker_subcommand() {
|
||||||
_arguments $(__docker_arguments) \
|
_arguments $(__docker_arguments) \
|
||||||
$opts_help \
|
$opts_help \
|
||||||
"($help -a --all)"{-a,--all}"[Show all images]" \
|
"($help -a --all)"{-a,--all}"[Show all images]" \
|
||||||
"($help)--digest[Show digests]" \
|
"($help)--digests[Show digests]" \
|
||||||
"($help)*"{-f=,--filter=}"[Filter values]:filter: " \
|
"($help)*"{-f=,--filter=}"[Filter values]:filter: " \
|
||||||
|
"($help)--format[Pretty-print containers using a Go template]:format: " \
|
||||||
"($help)--no-trunc[Do not truncate output]" \
|
"($help)--no-trunc[Do not truncate output]" \
|
||||||
"($help -q --quiet)"{-q,--quiet}"[Only show numeric IDs]" \
|
"($help -q --quiet)"{-q,--quiet}"[Only show numeric IDs]" \
|
||||||
"($help -): :__docker_repositories" && ret=0
|
"($help -): :__docker_repositories" && ret=0
|
||||||
|
|
|
@ -103,6 +103,12 @@ Docker's client uses this property. If this property is not set, the client
|
||||||
falls back to the default table format. For a list of supported formatting
|
falls back to the default table format. For a list of supported formatting
|
||||||
directives, see the [**Formatting** section in the `docker ps` documentation](ps.md)
|
directives, see the [**Formatting** section in the `docker ps` documentation](ps.md)
|
||||||
|
|
||||||
|
The property `imagesFormat` specifies the default format for `docker images` output.
|
||||||
|
When the `--format` flag is not provided with the `docker images` command,
|
||||||
|
Docker's client uses this property. If this property is not set, the client
|
||||||
|
falls back to the default table format. For a list of supported formatting
|
||||||
|
directives, see the [**Formatting** section in the `docker images` documentation](images.md)
|
||||||
|
|
||||||
Following is a sample `config.json` file:
|
Following is a sample `config.json` file:
|
||||||
|
|
||||||
{
|
{
|
||||||
|
@ -110,6 +116,7 @@ Following is a sample `config.json` file:
|
||||||
"MyHeader": "MyValue"
|
"MyHeader": "MyValue"
|
||||||
},
|
},
|
||||||
"psFormat": "table {{.ID}}\\t{{.Image}}\\t{{.Command}}\\t{{.Labels}}"
|
"psFormat": "table {{.ID}}\\t{{.Image}}\\t{{.Command}}\\t{{.Labels}}"
|
||||||
|
"imagesFormat": "table {{.ID}}\\t{{.Repository}}\\t{{.Tag}}\\t{{.CreatedAt}}"
|
||||||
}
|
}
|
||||||
|
|
||||||
### Notary
|
### Notary
|
||||||
|
|
|
@ -177,3 +177,53 @@ In this example, with the `0.1` value, it returns an empty set because no matche
|
||||||
|
|
||||||
$ docker images --filter "label=com.example.version=0.1"
|
$ docker images --filter "label=com.example.version=0.1"
|
||||||
REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE
|
REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE
|
||||||
|
|
||||||
|
## Formatting
|
||||||
|
|
||||||
|
The formatting option (`--format`) will pretty print container output
|
||||||
|
using a Go template.
|
||||||
|
|
||||||
|
Valid placeholders for the Go template are listed below:
|
||||||
|
|
||||||
|
Placeholder | Description
|
||||||
|
---- | ----
|
||||||
|
`.ID` | Image ID
|
||||||
|
`.Repository` | Image repository
|
||||||
|
`.Tag` | Image tag
|
||||||
|
`.Digest` | Image digest
|
||||||
|
`.CreatedSince` | Elapsed time since the image was created.
|
||||||
|
`.CreatedAt` | Time when the image was created.
|
||||||
|
`.Size` | Image disk size.
|
||||||
|
|
||||||
|
When using the `--format` option, the `image` 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 `Repository` entries separated by a colon for all images:
|
||||||
|
|
||||||
|
$ docker images --format "{{.ID}}: {{.Repository}}"
|
||||||
|
77af4d6b9913: <none>
|
||||||
|
b6fa739cedf5: committ
|
||||||
|
78a85c484f71: <none>
|
||||||
|
30557a29d5ab: docker
|
||||||
|
5ed6274db6ce: <none>
|
||||||
|
746b819f315e: postgres
|
||||||
|
746b819f315e: postgres
|
||||||
|
746b819f315e: postgres
|
||||||
|
746b819f315e: postgres
|
||||||
|
|
||||||
|
To list all images with their repository and tag in a table format you
|
||||||
|
can use:
|
||||||
|
|
||||||
|
$ docker images --format "table {{.ID}}\t{{.Repository}}\t{{.Tag}}"
|
||||||
|
IMAGE ID REPOSITORY TAG
|
||||||
|
77af4d6b9913 <none> <none>
|
||||||
|
b6fa739cedf5 committ latest
|
||||||
|
78a85c484f71 <none> <none>
|
||||||
|
30557a29d5ab docker latest
|
||||||
|
5ed6274db6ce <none> <none>
|
||||||
|
746b819f315e postgres 9
|
||||||
|
746b819f315e postgres 9.3
|
||||||
|
746b819f315e postgres 9.3.5
|
||||||
|
746b819f315e postgres latest
|
||||||
|
|
|
@ -40,6 +40,17 @@ versions.
|
||||||
**-f**, **--filter**=[]
|
**-f**, **--filter**=[]
|
||||||
Filters the output. The dangling=true filter finds unused images. While label=com.foo=amd64 filters for images with a com.foo value of amd64. The label=com.foo filter finds images with the label com.foo of any value.
|
Filters the output. The dangling=true filter finds unused images. While label=com.foo=amd64 filters for images with a com.foo value of amd64. The label=com.foo filter finds images with the label com.foo of any value.
|
||||||
|
|
||||||
|
**--format**="*TEMPLATE*"
|
||||||
|
Pretty-print containers using a Go template.
|
||||||
|
Valid placeholders:
|
||||||
|
.ID - Image ID
|
||||||
|
.Repository - Image repository
|
||||||
|
.Tag - Image tag
|
||||||
|
.Digest - Image digest
|
||||||
|
.CreatedSince - Elapsed time since the image was created.
|
||||||
|
.CreatedAt - Time when the image was created..
|
||||||
|
.Size - Image disk size.
|
||||||
|
|
||||||
**--help**
|
**--help**
|
||||||
Print usage statement
|
Print usage statement
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue