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>
51 lines
1.0 KiB
Markdown
51 lines
1.0 KiB
Markdown
---
|
|
title: "port"
|
|
description: "The port command description and usage"
|
|
keywords: "port, mapping, container"
|
|
---
|
|
|
|
# port
|
|
|
|
```markdown
|
|
Usage: docker port CONTAINER [PRIVATE_PORT[/PROTO]]
|
|
|
|
List port mappings or a specific mapping for the container
|
|
|
|
Aliases:
|
|
docker container port, docker port
|
|
|
|
Options:
|
|
--help Print usage
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Show all mapped ports
|
|
|
|
You can find out all the ports mapped by not specifying a `PRIVATE_PORT`, or
|
|
just a specific mapping:
|
|
|
|
```console
|
|
$ docker ps
|
|
|
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
|
b650456536c7 busybox:latest top 54 minutes ago Up 54 minutes 0.0.0.0:1234->9876/tcp, 0.0.0.0:4321->7890/tcp test
|
|
|
|
$ docker port test
|
|
|
|
7890/tcp -> 0.0.0.0:4321
|
|
9876/tcp -> 0.0.0.0:1234
|
|
|
|
$ docker port test 7890/tcp
|
|
|
|
0.0.0.0:4321
|
|
|
|
$ docker port test 7890/udp
|
|
|
|
2014/06/24 11:53:36 Error: No public port '7890/udp' published for test
|
|
|
|
$ docker port test 7890
|
|
|
|
0.0.0.0:4321
|
|
```
|