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>
65 lines
1.3 KiB
Markdown
65 lines
1.3 KiB
Markdown
---
|
|
title: "save"
|
|
description: "The save command description and usage"
|
|
keywords: "tarred, repository, backup"
|
|
---
|
|
|
|
# save
|
|
|
|
```markdown
|
|
Usage: docker save [OPTIONS] IMAGE [IMAGE...]
|
|
|
|
Save one or more images to a tar archive (streamed to STDOUT by default)
|
|
|
|
Aliases:
|
|
docker image save, docker save
|
|
|
|
Options:
|
|
--help Print usage
|
|
-o, --output string Write to a file, instead of STDOUT
|
|
```
|
|
|
|
## Description
|
|
|
|
Produces a tarred repository to the standard output stream.
|
|
Contains all parent layers, and all tags + versions, or specified `repo:tag`, for
|
|
each argument provided.
|
|
|
|
## Examples
|
|
|
|
### Create a backup that can then be used with `docker load`.
|
|
|
|
```console
|
|
$ docker save busybox > busybox.tar
|
|
|
|
$ ls -sh busybox.tar
|
|
|
|
2.7M busybox.tar
|
|
|
|
$ docker save --output busybox.tar busybox
|
|
|
|
$ ls -sh busybox.tar
|
|
|
|
2.7M busybox.tar
|
|
|
|
$ docker save -o fedora-all.tar fedora
|
|
|
|
$ docker save -o fedora-latest.tar fedora:latest
|
|
```
|
|
|
|
### Save an image to a tar.gz file using gzip
|
|
|
|
You can use gzip to save the image file and make the backup smaller.
|
|
|
|
```console
|
|
$ docker save myimage:latest | gzip > myimage_latest.tar.gz
|
|
```
|
|
|
|
### Cherry-pick particular tags
|
|
|
|
You can even cherry-pick particular tags of an image repository.
|
|
|
|
```console
|
|
$ docker save -o ubuntu.tar ubuntu:lucid ubuntu:saucy
|
|
```
|