mirror of
https://github.com/docker/cli.git
synced 2025-08-27 13:42:00 +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>
55 lines
982 B
Markdown
55 lines
982 B
Markdown
---
|
|
title: "wait"
|
|
description: "The wait command description and usage"
|
|
keywords: "container, stop, wait"
|
|
---
|
|
|
|
# wait
|
|
|
|
```markdown
|
|
Usage: docker wait CONTAINER [CONTAINER...]
|
|
|
|
Block until one or more containers stop, then print their exit codes
|
|
|
|
Aliases:
|
|
docker container wait, docker wait
|
|
|
|
Options:
|
|
--help Print usage
|
|
```
|
|
|
|
> **Note**
|
|
>
|
|
> `docker wait` returns `0` when run against a container which had already
|
|
> exited before the `docker wait` command was run.
|
|
|
|
## Examples
|
|
|
|
Start a container in the background.
|
|
|
|
```console
|
|
$ docker run -dit --name=my_container ubuntu bash
|
|
```
|
|
|
|
Run `docker wait`, which should block until the container exits.
|
|
|
|
```console
|
|
$ docker wait my_container
|
|
```
|
|
|
|
In another terminal, stop the first container. The `docker wait` command above
|
|
returns the exit code.
|
|
|
|
```console
|
|
$ docker stop my_container
|
|
```
|
|
|
|
This is the same `docker wait` command from above, but it now exits, returning
|
|
`0`.
|
|
|
|
```console
|
|
$ docker wait my_container
|
|
|
|
0
|
|
```
|