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>
66 lines
1.9 KiB
Markdown
66 lines
1.9 KiB
Markdown
---
|
|
title: "load"
|
|
description: "The load command description and usage"
|
|
keywords: "stdin, tarred, repository"
|
|
---
|
|
|
|
# load
|
|
|
|
```markdown
|
|
Usage: docker load [OPTIONS]
|
|
|
|
Load an image or repository from a tar archive (even if compressed with gzip,
|
|
bzip2, or xz) from a file or STDIN.
|
|
|
|
Aliases:
|
|
docker image load, docker load
|
|
|
|
Options:
|
|
--help Print usage
|
|
-i, --input string Read from tar archive file, instead of STDIN.
|
|
The tarball may be compressed with gzip, bzip, or xz
|
|
-q, --quiet Suppress the load output but still outputs the imported images
|
|
```
|
|
|
|
## Description
|
|
|
|
Load an image or repository from a tar archive (even if compressed with gzip,
|
|
bzip2, or xz) from a file or STDIN. It restores both images and tags.
|
|
|
|
## Examples
|
|
|
|
```console
|
|
$ docker image ls
|
|
|
|
REPOSITORY TAG IMAGE ID CREATED SIZE
|
|
```
|
|
|
|
### Load images from STDIN
|
|
|
|
```console
|
|
$ docker load < busybox.tar.gz
|
|
|
|
Loaded image: busybox:latest
|
|
$ docker images
|
|
REPOSITORY TAG IMAGE ID CREATED SIZE
|
|
busybox latest 769b9341d937 7 weeks ago 2.489 MB
|
|
```
|
|
|
|
### <a name=input></a> Load images from a file (--input)
|
|
|
|
```console
|
|
$ docker load --input fedora.tar
|
|
|
|
Loaded image: fedora:rawhide
|
|
Loaded image: fedora:20
|
|
|
|
$ docker images
|
|
|
|
REPOSITORY TAG IMAGE ID CREATED SIZE
|
|
busybox latest 769b9341d937 7 weeks ago 2.489 MB
|
|
fedora rawhide 0d20aec6529d 7 weeks ago 387 MB
|
|
fedora 20 58394af37342 7 weeks ago 385.5 MB
|
|
fedora heisenbug 58394af37342 7 weeks ago 385.5 MB
|
|
fedora latest 58394af37342 7 weeks ago 385.5 MB
|
|
```
|