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>
62 lines
1.3 KiB
Markdown
62 lines
1.3 KiB
Markdown
---
|
||
title: "diff"
|
||
description: "The diff command description and usage"
|
||
keywords: "list, changed, files, container"
|
||
---
|
||
|
||
# diff
|
||
|
||
```markdown
|
||
Usage: docker diff CONTAINER
|
||
|
||
Inspect changes to files or directories on a container's filesystem
|
||
|
||
Aliases:
|
||
docker container diff, docker diff
|
||
|
||
Options:
|
||
--help Print usage
|
||
```
|
||
|
||
## Description
|
||
|
||
List the changed files and directories in a container᾿s filesystem since the
|
||
container was created. Three different types of change are tracked:
|
||
|
||
| Symbol | Description |
|
||
|--------|---------------------------------|
|
||
| `A` | A file or directory was added |
|
||
| `D` | A file or directory was deleted |
|
||
| `C` | A file or directory was changed |
|
||
|
||
You can use the full or shortened container ID or the container name set using
|
||
`docker run --name` option.
|
||
|
||
## Examples
|
||
|
||
Inspect the changes to an `nginx` container:
|
||
|
||
```console
|
||
$ docker diff 1fdfd1f54c1b
|
||
|
||
C /dev
|
||
C /dev/console
|
||
C /dev/core
|
||
C /dev/stdout
|
||
C /dev/fd
|
||
C /dev/ptmx
|
||
C /dev/stderr
|
||
C /dev/stdin
|
||
C /run
|
||
A /run/nginx.pid
|
||
C /var/lib/nginx/tmp
|
||
A /var/lib/nginx/tmp/client_body
|
||
A /var/lib/nginx/tmp/fastcgi
|
||
A /var/lib/nginx/tmp/proxy
|
||
A /var/lib/nginx/tmp/scgi
|
||
A /var/lib/nginx/tmp/uwsgi
|
||
C /var/log/nginx
|
||
A /var/log/nginx/access.log
|
||
A /var/log/nginx/error.log
|
||
```
|