Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Refactor `docker inspect` to work on all types 

Signed-off-by: Arnaud Porterie (icecrime) <arnaud.porterie@docker.com>
This commit is contained in:
Arnaud Porterie (icecrime) 2016-06-15 21:41:54 -07:00 committed by Tibor Vass
parent cfb8a110b4
commit a2b443d1df
2 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/reference/commandline/inspect.md
View File

@ -11,15 +11,16 @@ parent = "smn_cli"
# inspect
```markdown
Usage: docker inspect [OPTIONS] CONTAINER|IMAGE|TASK [CONTAINER|IMAGE|TASK...]
Usage: docker inspect [OPTIONS] NAME|ID [NAME|ID...]
Return low-level information on a container, image or task
Return low-level information on one or multiple containers, images, volumes,
networks, nodes, services, or tasks identified by name or ID.
-f, --format Format the output using the given go template
--help Print usage
-s, --size Display total file sizes if the type is container
values are "image" or "container" or "task
--type Return JSON for specified type, (e.g image, container or task)
--type Return JSON for specified type
```
By default, this will render all results in a JSON array. If the container and

21
man/docker-inspect.1.md
View File

@ -2,23 +2,23 @@
% Docker Community
% JUNE 2014
# NAME
docker-inspect - Return low-level information on a container or image
docker-inspect - Return low-level information on docker objects
# SYNOPSIS
**docker inspect**
[**--help**]
[**-f**|**--format**[=*FORMAT*]]
[**-s**|**--size**]
[**--type**=*container*|*image*]
CONTAINER|IMAGE [CONTAINER|IMAGE...]
[**--type**=*container*|*image*|*network*|*node*|*service*|*task*|*volume*]
NAME|ID [NAME|ID...]
# DESCRIPTION
This displays all the information available in Docker for a given
container or image. By default, this will render all results in a JSON
array. If the container and image have the same name, this will return
container JSON for unspecified type. If a format is specified, the given
template will be executed for each result.
This displays all the information available in Docker for one or multiple given
containers, images, volumes, networks, nodes, services, or tasks. By default,
this will render all results in a JSON array. If the container and image have
the same name, this will return container JSON for unspecified type. If a format
is specified, the given template will be executed for each result.
# OPTIONS
**--help**
@ -30,8 +30,9 @@ template will be executed for each result.
**-s**, **--size**
Display total file sizes if the type is container.
**--type**="*container*|*image*"
Return JSON for specified type, permissible values are "image" or "container"
**--type**=*container*|*image*|*network*|*node*|*service*|*task*|*volume*
Return JSON for specified type, permissible values are "image", "container",
"network", "node", "service", "task", and "volume".
# EXAMPLES