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>
43 lines
1.0 KiB
Markdown
43 lines
1.0 KiB
Markdown
---
|
|
title: "export"
|
|
description: "The export command description and usage"
|
|
keywords: "export, file, system, container"
|
|
---
|
|
|
|
# export
|
|
|
|
```markdown
|
|
Usage: docker export [OPTIONS] CONTAINER
|
|
|
|
Export a container's filesystem as a tar archive
|
|
|
|
Aliases:
|
|
docker container export, docker export
|
|
|
|
Options:
|
|
--help Print usage
|
|
-o, --output string Write to a file, instead of STDOUT
|
|
```
|
|
|
|
## Description
|
|
|
|
The `docker export` command does not export the contents of volumes associated
|
|
with the container. If a volume is mounted on top of an existing directory in
|
|
the container, `docker export` will export the contents of the *underlying*
|
|
directory, not the contents of the volume.
|
|
|
|
Refer to [Backup, restore, or migrate data volumes](https://docs.docker.com/storage/volumes/#backup-restore-or-migrate-data-volumes)
|
|
in the user guide for examples on exporting data in a volume.
|
|
|
|
## Examples
|
|
|
|
Each of these commands has the same result.
|
|
|
|
```console
|
|
$ docker export red_panda > latest.tar
|
|
```
|
|
|
|
```console
|
|
$ docker export --output="latest.tar" red_panda
|
|
```
|