Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
DockerCLI/docs/reference/commandline/load.md

61 lines
1.9 KiB
Markdown
Raw Normal View History

Splitting out the cli command into parts. Signed-off-by: Mary Anthony <mary@docker.com>
2015-06-21 16:41:38 -04:00
# load
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
<!---MARKER_GEN_START-->
Load an image from a tar archive or STDIN
Splitting out the cli command into parts. Signed-off-by: Mary Anthony <mary@docker.com>
2015-06-21 16:41:38 -04:00
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
### Aliases
`docker image load`, `docker load`
### Options
| Name | Type | Default | Description |
|:------------------------------------|:---------|:--------|:---------------------------------------------|
| [`-i`](#input), [`--input`](#input) | `string` | | Read from tar archive file, instead of STDIN |
| `-q`, `--quiet` | | | Suppress the load output |
Splitting out the cli command into parts. Signed-off-by: Mary Anthony <mary@docker.com>
2015-06-21 16:41:38 -04:00
cli: use custom annotation for aliases 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>
2022-06-28 04:52:25 -04:00
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
<!---MARKER_GEN_END-->
docs: use "console" code-hint for shell examples This replaces the use of bash where suitable, to allow easier copy/pasting of shell examples without copying the prompt or process output. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-21 08:54:14 -04:00
docs: added support for CLI yaml file generation Signed-off-by: French Ben <frenchben@docker.com> Signed-off-by: Tibor Vass <tibor@docker.com>
2017-01-27 19:47:41 -05:00
## Description
Splitting out the cli command into parts. Signed-off-by: Mary Anthony <mary@docker.com>
2015-06-21 16:41:38 -04:00
docker load supports tar and tar.gz files Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2018-01-05 16:49:16 -05:00
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.
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-02-07 18:42:48 -05:00
## Examples
docs: use "console" code-hint for shell examples This replaces the use of bash where suitable, to allow easier copy/pasting of shell examples without copying the prompt or process output. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-21 08:54:14 -04:00
```console
docker load: Typofix in examples Remove the double "docker docker" from example Signed-off-by: Henry Ne <henrynmail-github@yahoo.de>
2018-04-16 10:01:53 -04:00
$ docker image ls
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-02-07 18:42:48 -05:00
REPOSITORY TAG IMAGE ID CREATED SIZE
docs: add anchor-tags for flags This will generate "details_url" for options, so that the options table on the pages at docs.docker.com link to the section describing the option. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-03-30 09:05:29 -04:00
```
### Load images from STDIN
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-02-07 18:42:48 -05:00
docs: add anchor-tags for flags This will generate "details_url" for options, so that the options table on the pages at docs.docker.com link to the section describing the option. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-03-30 09:05:29 -04:00
```console
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-02-07 18:42:48 -05:00
$ 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
docs: add anchor-tags for flags This will generate "details_url" for options, so that the options table on the pages at docs.docker.com link to the section describing the option. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-03-30 09:05:29 -04:00
```
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-02-07 18:42:48 -05:00
docs: fix anchors Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:28:29 -05:00
### <a name="input"></a> Load images from a file (--input)
docs: add anchor-tags for flags This will generate "details_url" for options, so that the options table on the pages at docs.docker.com link to the section describing the option. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-03-30 09:05:29 -04:00
```console
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-02-07 18:42:48 -05:00
$ 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
```