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

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>
This commit is contained in:
Kevin Alvarez 2023-01-06 19:04:05 +01:00 committed by Sebastiaan van Stijn
parent 186dcf30b1
commit 79c9e527a3
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
194 changed files with 3410 additions and 2757 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Makefile
View File

@ -90,6 +90,10 @@ authors: ## generate AUTHORS file from git history
manpages: ## generate man pages from go source and markdown manpages: ## generate man pages from go source and markdown
scripts/docs/generate-man.sh scripts/docs/generate-man.sh
.PHONY: mddocs
mddocs: ## generate markdown files from go source
scripts/docs/generate-md.sh
.PHONY: yamldocs .PHONY: yamldocs
yamldocs: ## generate documentation YAML files consumed by docs repo yamldocs: ## generate documentation YAML files consumed by docs repo
scripts/docs/generate-yaml.sh scripts/docs/generate-yaml.sh

4
docker.Makefile
View File

@ -103,6 +103,10 @@ authors: ## generate AUTHORS file from git history
manpages: build_docker_image ## generate man pages from go source and markdown manpages: build_docker_image ## generate man pages from go source and markdown
$(DOCKER_RUN) -it $(DEV_DOCKER_IMAGE_NAME) make manpages $(DOCKER_RUN) -it $(DEV_DOCKER_IMAGE_NAME) make manpages
.PHONY: mddocs
mddocs: build_docker_image ## generate markdown files from go source
$(DOCKER_RUN) -it $(DEV_DOCKER_IMAGE_NAME) make mddocs
.PHONY: yamldocs .PHONY: yamldocs
yamldocs: build_docker_image ## generate documentation YAML files consumed by docs repo yamldocs: build_docker_image ## generate documentation YAML files consumed by docs repo
$(DOCKER_RUN) -it $(DEV_DOCKER_IMAGE_NAME) make yamldocs $(DOCKER_RUN) -it $(DEV_DOCKER_IMAGE_NAME) make yamldocs

28
docs/generate.go
View File

@ -10,8 +10,10 @@ import (
"os" "os"
clidocstool "github.com/docker/cli-docs-tool" clidocstool "github.com/docker/cli-docs-tool"
"github.com/docker/cli/cli"
"github.com/docker/cli/cli/command" "github.com/docker/cli/cli/command"
"github.com/docker/cli/cli/command/commands" "github.com/docker/cli/cli/command/commands"
"github.com/pkg/errors"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"github.com/spf13/pflag" "github.com/spf13/pflag"
) )
@ -21,6 +23,7 @@ const defaultSourcePath = "docs/reference/commandline/"
type options struct { type options struct {
source string source string
target string target string
formats []string
} }
func gen(opts *options) error { func gen(opts *options) error {
@ -34,6 +37,10 @@ func gen(opts *options) error {
Use: "docker [OPTIONS] COMMAND [ARG...]", Use: "docker [OPTIONS] COMMAND [ARG...]",
Short: "The base command for the Docker CLI.", Short: "The base command for the Docker CLI.",
} }
clientOpts, _, _ := cli.SetupRootCommand(cmd)
if err := dockerCLI.Initialize(clientOpts); err != nil {
return err
}
commands.AddCommands(cmd, dockerCLI) commands.AddCommands(cmd, dockerCLI)
c, err := clidocstool.New(clidocstool.Options{ c, err := clidocstool.New(clidocstool.Options{
@ -46,7 +53,22 @@ func gen(opts *options) error {
return err return err
} }
return c.GenYamlTree(cmd) for _, format := range opts.formats {
switch format {
case "md":
if err = c.GenMarkdownTree(cmd); err != nil {
return err
}
case "yaml":
if err = c.GenYamlTree(cmd); err != nil {
return err
}
default:
return errors.Errorf("unknown format %q", format)
}
}
return nil
} }
func run() error { func run() error {
@ -54,9 +76,13 @@ func run() error {
flags := pflag.NewFlagSet(os.Args[0], pflag.ContinueOnError) flags := pflag.NewFlagSet(os.Args[0], pflag.ContinueOnError)
flags.StringVar(&opts.source, "source", defaultSourcePath, "Docs source folder") flags.StringVar(&opts.source, "source", defaultSourcePath, "Docs source folder")
flags.StringVar(&opts.target, "target", defaultSourcePath, "Docs target folder") flags.StringVar(&opts.target, "target", defaultSourcePath, "Docs target folder")
flags.StringSliceVar(&opts.formats, "formats", []string{}, "Format (md, yaml)")
if err := flags.Parse(os.Args[1:]); err != nil { if err := flags.Parse(os.Args[1:]); err != nil {
return err return err
} }
if len(opts.formats) == 0 {
return errors.New("Docs format required")
}
return gen(opts) return gen(opts)
} }

31
docs/reference/commandline/attach.md
View File

@ -1,25 +1,22 @@
---
title: "attach"
description: "The attach command description and usage"
keywords: "attach, running, container"
---
# attach # attach
```markdown <!---MARKER_GEN_START-->
Usage: docker attach [OPTIONS] CONTAINER
Attach local standard input, output, and error streams to a running container Attach local standard input, output, and error streams to a running container
Aliases: ### Aliases
docker container attach, docker attach
Options: `docker container attach`, `docker attach`
--detach-keys string Override the key sequence for detaching a container
--help Print usage ### Options
--no-stdin Do not attach STDIN
--sig-proxy Proxy all received signals to the process (default true) | Name | Type | Default | Description |
``` |:----------------|:---------|:--------|:----------------------------------------------------|
| `--detach-keys` | `string` | | Override the key sequence for detaching a container |
| `--no-stdin` | | | Do not attach STDIN |
| `--sig-proxy` | | | Proxy all received signals to the process |
<!---MARKER_GEN_END-->
## Description ## Description

97
docs/reference/commandline/build.md
View File

@ -1,64 +1,49 @@
---
title: "build"
description: "The build command description and usage"
keywords: "build, docker, image"
---
# build # build
```markdown <!---MARKER_GEN_START-->
Usage: docker build [OPTIONS] PATH | URL | -
Build an image from a Dockerfile Build an image from a Dockerfile
Aliases: ### Aliases
docker image build, docker build, docker buildx build, docker builder build
Options: `docker image build`, `docker build`, `docker buildx build`, `docker builder build`
--add-host value Add a custom host-to-IP mapping (host:ip) (default [])
--build-arg value Set build-time variables (default []) ### Options
--cache-from value Images to consider as cache sources (default [])
--cgroup-parent string Optional parent cgroup for the container | Name | Type | Default | Description |
--compress Compress the build context using gzip |:------------------------------------|:--------------|:----------|:------------------------------------------------------------------|
--cpu-period int Limit the CPU CFS (Completely Fair Scheduler) period | [`--add-host`](#add-host) | `list` | | Add a custom host-to-IP mapping (`host:ip`) |
--cpu-quota int Limit the CPU CFS (Completely Fair Scheduler) quota | [`--build-arg`](#build-arg) | `list` | | Set build-time variables |
-c, --cpu-shares int CPU shares (relative weight) | [`--cache-from`](#cache-from) | `stringSlice` | | Images to consider as cache sources |
--cpuset-cpus string CPUs in which to allow execution (0-3, 0,1) | [`--cgroup-parent`](#cgroup-parent) | `string` | | Optional parent cgroup for the container |
--cpuset-mems string MEMs in which to allow execution (0-3, 0,1) | `--compress` | | | Compress the build context using gzip |
--disable-content-trust Skip image verification (default true) | `--cpu-period` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) period |
-f, --file string Name of the Dockerfile (Default is 'PATH/Dockerfile') | `--cpu-quota` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) quota |
--force-rm Always remove intermediate containers | `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) |
--help Print usage | `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) |
--iidfile string Write the image ID to the file | `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) |
--isolation string Container isolation technology | `--disable-content-trust` | | | Skip image verification |
--label value Set metadata for an image (default []) | [`-f`](#file), [`--file`](#file) | `string` | | Name of the Dockerfile (Default is `PATH/Dockerfile`) |
-m, --memory string Memory limit | `--force-rm` | | | Always remove intermediate containers |
--memory-swap string Swap limit equal to memory plus swap: '-1' to enable unlimited swap | `--iidfile` | `string` | | Write the image ID to the file |
--network string Set the networking mode for the RUN instructions during build | [`--isolation`](#isolation) | `string` | | Container isolation technology |
'bridge': use default Docker bridge | `--label` | `list` | | Set metadata for an image |
'none': no networking | `-m`, `--memory` | `bytes` | `0` | Memory limit |
'container:<name|id>': reuse another container's network stack | `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: -1 to enable unlimited swap |
'host': use the Docker host network stack | `--network` | `string` | `default` | Set the networking mode for the RUN instructions during build |
'<network-name>|<network-id>': connect to a user-defined network | `--no-cache` | | | Do not use cache when building the image |
--no-cache Do not use cache when building the image | `--platform` | `string` | | Set platform if server is multi-platform capable |
-o, --output Output destination (format: type=local,dest=path) | `--pull` | | | Always attempt to pull a newer version of the image |
--pull Always attempt to pull a newer version of the image | `-q`, `--quiet` | | | Suppress the build output and print image ID on success |
--progress Set type of progress output (only if BuildKit enabled) (auto, plain, tty). | `--rm` | | | Remove intermediate containers after a successful build |
Use plain to show container output | [`--security-opt`](#security-opt) | `stringSlice` | | Security options |
-q, --quiet Suppress the build output and print image ID on success | `--shm-size` | `bytes` | `0` | Size of `/dev/shm` |
--rm Remove intermediate containers after a successful build (default true) | [`--squash`](#squash) | | | Squash newly built layers into a single new layer |
--secret Secret file to expose to the build (only if BuildKit enabled): id=mysecret,src=/local/secret" | [`-t`](#tag), [`--tag`](#tag) | `list` | | Name and optionally a tag in the `name:tag` format |
--security-opt value Security Options (default []) | [`--target`](#target) | `string` | | Set the target build stage to build. |
--shm-size bytes Size of /dev/shm | [`--ulimit`](#ulimit) | `ulimit` | | Ulimit options |
The format is `<number><unit>`. `number` must be greater than `0`.
Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes),
or `g` (gigabytes). If you omit the unit, the system uses bytes. <!---MARKER_GEN_END-->
--squash Squash newly built layers into a single new layer (**Experimental Only**)
--ssh SSH agent socket or keys to expose to the build (only if BuildKit enabled) (format: default|<id>[=<socket>|<key>[,<key>]])
-t, --tag value Name and optionally a tag in the 'name:tag' format (default [])
--target string Set the target build stage to build.
--ulimit value Ulimit options (default [])
```
## Description ## Description

16
docs/reference/commandline/builder.md Normal file
View File

@ -0,0 +1,16 @@
# builder
<!---MARKER_GEN_START-->
Manage builds
### Subcommands
| Name | Description |
|:----------------------------|:---------------------------------|
| [`build`](builder_build.md) | Build an image from a Dockerfile |
| [`prune`](builder_prune.md) | Remove build cache |
<!---MARKER_GEN_END-->

50
docs/reference/commandline/builder_build.md Normal file
View File

@ -0,0 +1,50 @@
# builder build
<!---MARKER_GEN_START-->
Build an image from a Dockerfile
### Aliases
`docker image build`, `docker build`, `docker buildx build`, `docker builder build`
### Options
| Name | Type | Default | Description |
|:--------------------------|:--------------|:----------|:------------------------------------------------------------------|
| `--add-host` | `list` | | Add a custom host-to-IP mapping (`host:ip`) |
| `--build-arg` | `list` | | Set build-time variables |
| `--cache-from` | `stringSlice` | | Images to consider as cache sources |
| `--cgroup-parent` | `string` | | Optional parent cgroup for the container |
| `--compress` | | | Compress the build context using gzip |
| `--cpu-period` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) period |
| `--cpu-quota` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) quota |
| `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) |
| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) |
| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) |
| `--disable-content-trust` | | | Skip image verification |
| `-f`, `--file` | `string` | | Name of the Dockerfile (Default is `PATH/Dockerfile`) |
| `--force-rm` | | | Always remove intermediate containers |
| `--iidfile` | `string` | | Write the image ID to the file |
| `--isolation` | `string` | | Container isolation technology |
| `--label` | `list` | | Set metadata for an image |
| `-m`, `--memory` | `bytes` | `0` | Memory limit |
| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: -1 to enable unlimited swap |
| `--network` | `string` | `default` | Set the networking mode for the RUN instructions during build |
| `--no-cache` | | | Do not use cache when building the image |
| `--platform` | `string` | | Set platform if server is multi-platform capable |
| `--pull` | | | Always attempt to pull a newer version of the image |
| `-q`, `--quiet` | | | Suppress the build output and print image ID on success |
| `--rm` | | | Remove intermediate containers after a successful build |
| `--security-opt` | `stringSlice` | | Security options |
| `--shm-size` | `bytes` | `0` | Size of `/dev/shm` |
| `--squash` | | | Squash newly built layers into a single new layer |
| `-t`, `--tag` | `list` | | Name and optionally a tag in the `name:tag` format |
| `--target` | `string` | | Set the target build stage to build. |
| `--ulimit` | `ulimit` | | Ulimit options |
<!---MARKER_GEN_END-->
## Description
See [docker build](build.md) for more information.

16
docs/reference/commandline/builder_prune.md Normal file
View File

@ -0,0 +1,16 @@
# builder prune
<!---MARKER_GEN_START-->
Remove build cache
### Options
| Name | Type | Default | Description |
|:-----------------|:---------|:--------|:------------------------------------------------------|
| `-a`, `--all` | | | Remove all unused build cache, not just dangling ones |
| `--filter` | `filter` | | Provide filter values (e.g. `until=24h`) |
| `-f`, `--force` | | | Do not prompt for confirmation |
| `--keep-storage` | `bytes` | `0` | Amount of disk space to keep for cache |
<!---MARKER_GEN_END-->

22
docs/reference/commandline/checkpoint.md
View File

@ -1,9 +1,19 @@
--- # checkpoint
title: docker checkpoint
description: "The checkpoint command description and usage" <!---MARKER_GEN_START-->
keywords: experimental, checkpoint, restore, criu Manage checkpoints
experimental: true
--- ### Subcommands
| Name | Description |
|:---------------------------------|:---------------------------------------------|
| [`create`](checkpoint_create.md) | Create a checkpoint from a running container |
| [`ls`](checkpoint_ls.md) | List checkpoints for a container |
| [`rm`](checkpoint_rm.md) | Remove a checkpoint |
<!---MARKER_GEN_END-->
## Description ## Description

15
docs/reference/commandline/checkpoint_create.md Normal file
View File

@ -0,0 +1,15 @@
# checkpoint create
<!---MARKER_GEN_START-->
Create a checkpoint from a running container
### Options
| Name | Type | Default | Description |
|:-------------------|:---------|:--------|:---------------------------------------------|
| `--checkpoint-dir` | `string` | | Use a custom checkpoint storage directory |
| `--leave-running` | | | Leave the container running after checkpoint |
<!---MARKER_GEN_END-->

18
docs/reference/commandline/checkpoint_ls.md Normal file
View File

@ -0,0 +1,18 @@
# checkpoint ls
<!---MARKER_GEN_START-->
List checkpoints for a container
### Aliases
`docker checkpoint ls`, `docker checkpoint list`
### Options
| Name | Type | Default | Description |
|:-------------------|:---------|:--------|:------------------------------------------|
| `--checkpoint-dir` | `string` | | Use a custom checkpoint storage directory |
<!---MARKER_GEN_END-->

18
docs/reference/commandline/checkpoint_rm.md Normal file
View File

@ -0,0 +1,18 @@
# checkpoint rm
<!---MARKER_GEN_START-->
Remove a checkpoint
### Aliases
`docker checkpoint rm`, `docker checkpoint remove`
### Options
| Name | Type | Default | Description |
|:-------------------|:---------|:--------|:------------------------------------------|
| `--checkpoint-dir` | `string` | | Use a custom checkpoint storage directory |
<!---MARKER_GEN_END-->

102
docs/reference/commandline/cli.md
View File

@ -24,31 +24,89 @@ redirect_from:
To list available commands, either run `docker` with no parameters To list available commands, either run `docker` with no parameters
or execute `docker help`: or execute `docker help`:
```console <!---MARKER_GEN_START-->
$ docker The base command for the Docker CLI.
Usage: docker [OPTIONS] COMMAND [ARG...]
docker [ --help | -v | --version ]
A self-sufficient runtime for containers. ### Subcommands
Options: | Name | Description |
--config string Location of client config files (default "/root/.docker") |:------------------------------|:------------------------------------------------------------------------------|
-c, --context string Name of the context to use to connect to the daemon (overrides DOCKER_HOST env var and default context set with "docker context use") | [`attach`](attach.md) | Attach local standard input, output, and error streams to a running container |
-D, --debug Enable debug mode | [`build`](build.md) | Build an image from a Dockerfile |
--help Print usage | [`builder`](builder.md) | Manage builds |
-H, --host value Daemon socket(s) to connect to (default []) | [`checkpoint`](checkpoint.md) | Manage checkpoints |
-l, --log-level string Set the logging level ("debug"|"info"|"warn"|"error"|"fatal") (default "info") | [`commit`](commit.md) | Create a new image from a container's changes |
--tls Use TLS; implied by --tlsverify | [`config`](config.md) | Manage Swarm configs |
--tlscacert string Trust certs signed only by this CA (default "/root/.docker/ca.pem") | [`container`](container.md) | Manage containers |
--tlscert string Path to TLS certificate file (default "/root/.docker/cert.pem") | [`context`](context.md) | Manage contexts |
--tlskey string Path to TLS key file (default "/root/.docker/key.pem") | [`cp`](cp.md) | Copy files/folders between a container and the local filesystem |
--tlsverify Use TLS and verify the remote | [`create`](create.md) | Create a new container |
-v, --version Print version information and quit | [`diff`](diff.md) | Inspect changes to files or directories on a container's filesystem |
| [`events`](events.md) | Get real time events from the server |
| [`exec`](exec.md) | Execute a command in a running container |
| [`export`](export.md) | Export a container's filesystem as a tar archive |
| [`history`](history.md) | Show the history of an image |
| [`image`](image.md) | Manage images |
| [`images`](images.md) | List images |
| [`import`](import.md) | Import the contents from a tarball to create a filesystem image |
| [`info`](info.md) | Display system-wide information |
| [`inspect`](inspect.md) | Return low-level information on Docker objects |
| [`kill`](kill.md) | Kill one or more running containers |
| [`load`](load.md) | Load an image from a tar archive or STDIN |
| [`login`](login.md) | Log in to a registry |
| [`logout`](logout.md) | Log out from a registry |
| [`logs`](logs.md) | Fetch the logs of a container |
| [`manifest`](manifest.md) | Manage Docker image manifests and manifest lists |
| [`network`](network.md) | Manage networks |
| [`node`](node.md) | Manage Swarm nodes |
| [`pause`](pause.md) | Pause all processes within one or more containers |
| [`plugin`](plugin.md) | Manage plugins |
| [`port`](port.md) | List port mappings or a specific mapping for the container |
| [`ps`](ps.md) | List containers |
| [`pull`](pull.md) | Download an image from a registry |
| [`push`](push.md) | Upload an image to a registry |
| [`rename`](rename.md) | Rename a container |
| [`restart`](restart.md) | Restart one or more containers |
| [`rm`](rm.md) | Remove one or more containers |
| [`rmi`](rmi.md) | Remove one or more images |
| [`run`](run.md) | Create and run a new container from an image |
| [`save`](save.md) | Save one or more images to a tar archive (streamed to STDOUT by default) |
| [`search`](search.md) | Search Docker Hub for images |
| [`secret`](secret.md) | Manage Swarm secrets |
| [`service`](service.md) | Manage Swarm services |
| [`stack`](stack.md) | Manage Swarm stacks |
| [`start`](start.md) | Start one or more stopped containers |
| [`stats`](stats.md) | Display a live stream of container(s) resource usage statistics |
| [`stop`](stop.md) | Stop one or more running containers |
| [`swarm`](swarm.md) | Manage Swarm |
| [`system`](system.md) | Manage Docker |
| [`tag`](tag.md) | Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE |
| [`top`](top.md) | Display the running processes of a container |
| [`trust`](trust.md) | Manage trust on Docker images |
| [`unpause`](unpause.md) | Unpause all processes within one or more containers |
| [`update`](update.md) | Update configuration of one or more containers |
| [`version`](version.md) | Show the Docker version information |
| [`volume`](volume.md) | Manage volumes |
| [`wait`](wait.md) | Block until one or more containers stop, then print their exit codes |
Commands:
attach Attach to a running container ### Options
# […]
``` | Name | Type | Default | Description |
|:--------------------|:---------|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------|
| `--config` | `string` | `/root/.docker` | Location of client config files |
| `-c`, `--context` | `string` | | Name of the context to use to connect to the daemon (overrides DOCKER_HOST env var and default context set with `docker context use`) |
| `-D`, `--debug` | | | Enable debug mode |
| `-H`, `--host` | `list` | | Daemon socket(s) to connect to |
| `-l`, `--log-level` | `string` | `info` | Set the logging level (`debug`, `info`, `warn`, `error`, `fatal`) |
| `--tls` | | | Use TLS; implied by --tlsverify |
| `--tlscacert` | `string` | `/root/.docker/ca.pem` | Trust certs signed only by this CA |
| `--tlscert` | `string` | `/root/.docker/cert.pem` | Path to TLS certificate file |
| `--tlskey` | `string` | `/root/.docker/key.pem` | Path to TLS key file |
| `--tlsverify` | | | Use TLS and verify the remote |
<!---MARKER_GEN_END-->
## Description ## Description

33
docs/reference/commandline/commit.md
View File

@ -1,26 +1,23 @@
---
title: "commit"
description: "The commit command description and usage"
keywords: "commit, file, changes"
---
# commit # commit
```markdown <!---MARKER_GEN_START-->
Usage: docker commit [OPTIONS] CONTAINER [REPOSITORY[:TAG]]
Create a new image from a container's changes Create a new image from a container's changes
Aliases: ### Aliases
docker container commit, docker commit
Options: `docker container commit`, `docker commit`
-a, --author string Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
-c, --change value Apply Dockerfile instruction to the created image (default []) ### Options
--help Print usage
-m, --message string Commit message | Name | Type | Default | Description |
-p, --pause Pause container during commit (default true) |:---------------------------------------|:---------|:--------|:-----------------------------------------------------------|
``` | `-a`, `--author` | `string` | | Author (e.g., `John Hannibal Smith <hannibal@a-team.com>`) |
| [`-c`](#change), [`--change`](#change) | `list` | | Apply Dockerfile instruction to the created image |
| `-m`, `--message` | `string` | | Commit message |
| `-p`, `--pause` | | | Pause container during commit |
<!---MARKER_GEN_END-->
## Description ## Description

29
docs/reference/commandline/config.md
View File

@ -1,27 +1,20 @@
---
title: "config"
description: "The config command description and usage"
keywords: "config"
---
# config # config
```markdown <!---MARKER_GEN_START-->
Usage: docker config COMMAND
Manage Swarm configs Manage Swarm configs
Options: ### Subcommands
--help Print usage
Commands: | Name | Description |
create Create a config from a file or STDIN |:-------------------------------|:----------------------------------------------------|
inspect Display detailed information on one or more configs | [`create`](config_create.md) | Create a config from a file or STDIN |
ls List configs | [`inspect`](config_inspect.md) | Display detailed information on one or more configs |
rm Remove one or more configs | [`ls`](config_ls.md) | List configs |
| [`rm`](config_rm.md) | Remove one or more configs |
Run 'docker config COMMAND --help' for more information on a command.
```
<!---MARKER_GEN_END-->
## Description ## Description

23
docs/reference/commandline/config_create.md
View File

@ -1,20 +1,17 @@
---
title: "config create"
description: "The config create command description and usage"
keywords: ["config, create"]
---
# config create # config create
```Markdown <!---MARKER_GEN_START-->
Usage: docker config create [OPTIONS] CONFIG [file|-] Create a config from a file or STDIN
Create a config from a file or STDIN as content ### Options
Options: | Name | Type | Default | Description |
-l, --label list Config labels |:------------------------------------|:---------|:--------|:----------------|
--template-driver string Template driver | [`-l`](#label), [`--label`](#label) | `list` | | Config labels |
``` | `--template-driver` | `string` | | Template driver |
<!---MARKER_GEN_END-->
## Description ## Description

27
docs/reference/commandline/config_inspect.md
View File

@ -1,24 +1,17 @@
---
title: "config inspect"
description: "The config inspect command description and usage"
keywords: ["config, inspect"]
---
# config inspect # config inspect
```Markdown <!---MARKER_GEN_START-->
Usage: docker config inspect [OPTIONS] CONFIG [CONFIG...]
Display detailed information on one or more configs Display detailed information on one or more configs
Options: ### Options
-f, --format string Format output using a custom template:
'json': Print in JSON format | Name | Type | Default | Description |
'TEMPLATE': Print output using the given Go template. |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | [`-f`](#format), [`--format`](#format) | `string` | | Format output using a custom template:<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
--pretty Print the information in a human friendly format | `--pretty` | | | Print the information in a human friendly format |
--help Print usage
```
<!---MARKER_GEN_END-->
## Description ## Description

31
docs/reference/commandline/config_ls.md
View File

@ -1,25 +1,22 @@
---
title: "config ls"
description: "The config ls command description and usage"
keywords: ["config, ls"]
---
# config ls # config ls
```Markdown <!---MARKER_GEN_START-->
Usage: docker config ls [OPTIONS]
List configs List configs
Aliases: ### Aliases
ls, list
Options: `docker config ls`, `docker config list`
-f, --filter filter Filter output based on conditions provided
--format string Pretty-print configs using a Go template ### Options
--help Print usage
-q, --quiet Only display IDs | Name | Type | Default | Description |
``` |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided |
| [`--format`](#format) | `string` | | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
| `-q`, `--quiet` | | | Only display IDs |
<!---MARKER_GEN_END-->
## Description ## Description

20
docs/reference/commandline/config_rm.md
View File

@ -1,22 +1,14 @@
---
title: "config rm"
description: "The config rm command description and usage"
keywords: ["config, rm"]
---
# config rm # config rm
```Markdown <!---MARKER_GEN_START-->
Usage: docker config rm CONFIG [CONFIG...]
Remove one or more configs Remove one or more configs
Aliases: ### Aliases
rm, remove
Options: `docker config rm`, `docker config remove`
--help Print usage
```
<!---MARKER_GEN_END-->
## Description ## Description

70
docs/reference/commandline/container.md
View File

@ -1,50 +1,42 @@
---
title: "container"
description: "The container command description and usage"
keywords: "container"
---
# container # container
```markdown <!---MARKER_GEN_START-->
Usage: docker container COMMAND
Manage containers Manage containers
Options: ### Subcommands
--help Print usage
Commands: | Name | Description |
attach Attach to a running container |:----------------------------------|:------------------------------------------------------------------------------|
commit Create a new image from a container's changes | [`attach`](container_attach.md) | Attach local standard input, output, and error streams to a running container |
cp Copy files/folders between a container and the local filesystem | [`commit`](container_commit.md) | Create a new image from a container's changes |
create Create a new container | [`cp`](container_cp.md) | Copy files/folders between a container and the local filesystem |
diff Inspect changes to files or directories on a container's filesystem | [`create`](container_create.md) | Create a new container |
exec Execute a command in a running container | [`diff`](container_diff.md) | Inspect changes to files or directories on a container's filesystem |
export Export a container's filesystem as a tar archive | [`exec`](container_exec.md) | Execute a command in a running container |
inspect Display detailed information on one or more containers | [`export`](container_export.md) | Export a container's filesystem as a tar archive |
kill Kill one or more running containers | [`inspect`](container_inspect.md) | Display detailed information on one or more containers |
logs Fetch the logs of a container | [`kill`](container_kill.md) | Kill one or more running containers |
ls List containers | [`logs`](container_logs.md) | Fetch the logs of a container |
pause Pause all processes within one or more containers | [`ls`](container_ls.md) | List containers |
port List port mappings or a specific mapping for the container | [`pause`](container_pause.md) | Pause all processes within one or more containers |
prune Remove all stopped containers | [`port`](container_port.md) | List port mappings or a specific mapping for the container |
rename Rename a container | [`prune`](container_prune.md) | Remove all stopped containers |
restart Restart one or more containers | [`rename`](container_rename.md) | Rename a container |
rm Remove one or more containers | [`restart`](container_restart.md) | Restart one or more containers |
run Create and run a new container from an image | [`rm`](container_rm.md) | Remove one or more containers |
start Start one or more stopped containers | [`run`](container_run.md) | Create and run a new container from an image |
stats Display a live stream of container(s) resource usage statistics | [`start`](container_start.md) | Start one or more stopped containers |
stop Stop one or more running containers | [`stats`](container_stats.md) | Display a live stream of container(s) resource usage statistics |
top Display the running processes of a container | [`stop`](container_stop.md) | Stop one or more running containers |
unpause Unpause all processes within one or more containers | [`top`](container_top.md) | Display the running processes of a container |
update Update configuration of one or more containers | [`unpause`](container_unpause.md) | Unpause all processes within one or more containers |
wait Block until one or more containers stop, then print their exit codes | [`update`](container_update.md) | Update configuration of one or more containers |
| [`wait`](container_wait.md) | Block until one or more containers stop, then print their exit codes |
Run 'docker container COMMAND --help' for more information on a command.
```
<!---MARKER_GEN_END-->
## Description ## Description

23
docs/reference/commandline/container_attach.md Normal file
View File

@ -0,0 +1,23 @@
# container attach
<!---MARKER_GEN_START-->
Attach local standard input, output, and error streams to a running container
### Aliases
`docker container attach`, `docker attach`
### Options
| Name | Type | Default | Description |
|:----------------|:---------|:--------|:----------------------------------------------------|
| `--detach-keys` | `string` | | Override the key sequence for detaching a container |
| `--no-stdin` | | | Do not attach STDIN |
| `--sig-proxy` | | | Proxy all received signals to the process |
<!---MARKER_GEN_END-->
## Description
See [docker attach](attach.md) for more information.

24
docs/reference/commandline/container_commit.md Normal file
View File

@ -0,0 +1,24 @@
# container commit
<!---MARKER_GEN_START-->
Create a new image from a container's changes
### Aliases
`docker container commit`, `docker commit`
### Options
| Name | Type | Default | Description |
|:------------------|:---------|:--------|:-----------------------------------------------------------|
| `-a`, `--author` | `string` | | Author (e.g., `John Hannibal Smith <hannibal@a-team.com>`) |
| `-c`, `--change` | `list` | | Apply Dockerfile instruction to the created image |
| `-m`, `--message` | `string` | | Commit message |
| `-p`, `--pause` | | | Pause container during commit |
<!---MARKER_GEN_END-->
## Description
See [docker commit](commit.md) for more information.

28
docs/reference/commandline/container_cp.md Normal file
View File

@ -0,0 +1,28 @@
# container cp
<!---MARKER_GEN_START-->
Copy files/folders between a container and the local filesystem
Use '-' as the source to read a tar archive from stdin
and extract it to a directory destination in a container.
Use '-' as the destination to stream a tar archive of a
container source to stdout.
### Aliases
`docker container cp`, `docker cp`
### Options
| Name | Type | Default | Description |
|:----------------------|:-----|:--------|:-------------------------------------------------------------------------------------------------------------|
| `-a`, `--archive` | | | Archive mode (copy all uid/gid information) |
| `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH |
| `-q`, `--quiet` | | | Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached |
<!---MARKER_GEN_END-->
## Description
See [docker cp](cp.md) for more information.

118
docs/reference/commandline/container_create.md Normal file
View File

@ -0,0 +1,118 @@
# container create
<!---MARKER_GEN_START-->
Create a new container
### Aliases
`docker container create`, `docker create`
### Options
| Name | Type | Default | Description |
|:--------------------------|:--------------|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--add-host` | `list` | | Add a custom host-to-IP mapping (host:ip) |
| `-a`, `--attach` | `list` | | Attach to STDIN, STDOUT or STDERR |
| `--blkio-weight` | `uint16` | `0` | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) |
| `--blkio-weight-device` | `list` | | Block IO weight (relative device weight) |
| `--cap-add` | `list` | | Add Linux capabilities |
| `--cap-drop` | `list` | | Drop Linux capabilities |
| `--cgroup-parent` | `string` | | Optional parent cgroup for the container |
| `--cgroupns` | `string` | | Cgroup namespace to use (host\|private)<br>'host': Run the container in the Docker host's cgroup namespace<br>'private': Run the container in its own private cgroup namespace<br>'': Use the cgroup namespace as configured by the<br> default-cgroupns-mode option on the daemon (default) |
| `--cidfile` | `string` | | Write the container ID to the file |
| `--cpu-count` | `int64` | `0` | CPU count (Windows only) |
| `--cpu-percent` | `int64` | `0` | CPU percent (Windows only) |
| `--cpu-period` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) period |
| `--cpu-quota` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) quota |
| `--cpu-rt-period` | `int64` | `0` | Limit CPU real-time period in microseconds |
| `--cpu-rt-runtime` | `int64` | `0` | Limit CPU real-time runtime in microseconds |
| `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) |
| `--cpus` | `decimal` | | Number of CPUs |
| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) |
| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) |
| `--device` | `list` | | Add a host device to the container |
| `--device-cgroup-rule` | `list` | | Add a rule to the cgroup allowed devices list |
| `--device-read-bps` | `list` | | Limit read rate (bytes per second) from a device |
| `--device-read-iops` | `list` | | Limit read rate (IO per second) from a device |
| `--device-write-bps` | `list` | | Limit write rate (bytes per second) to a device |
| `--device-write-iops` | `list` | | Limit write rate (IO per second) to a device |
| `--disable-content-trust` | | | Skip image verification |
| `--dns` | `list` | | Set custom DNS servers |
| `--dns-option` | `list` | | Set DNS options |
| `--dns-search` | `list` | | Set custom DNS search domains |
| `--domainname` | `string` | | Container NIS domain name |
| `--entrypoint` | `string` | | Overwrite the default ENTRYPOINT of the image |
| `-e`, `--env` | `list` | | Set environment variables |
| `--env-file` | `list` | | Read in a file of environment variables |
| `--expose` | `list` | | Expose a port or a range of ports |
| `--gpus` | `gpu-request` | | GPU devices to add to the container ('all' to pass all GPUs) |
| `--group-add` | `list` | | Add additional groups to join |
| `--health-cmd` | `string` | | Command to run to check health |
| `--health-interval` | `duration` | `0s` | Time between running the check (ms\|s\|m\|h) (default 0s) |
| `--health-retries` | `int` | `0` | Consecutive failures needed to report unhealthy |
| `--health-start-period` | `duration` | `0s` | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s) |
| `--health-timeout` | `duration` | `0s` | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s) |
| `--help` | | | Print usage |
| `-h`, `--hostname` | `string` | | Container host name |
| `--init` | | | Run an init inside the container that forwards signals and reaps processes |
| `-i`, `--interactive` | | | Keep STDIN open even if not attached |
| `--io-maxbandwidth` | `bytes` | `0` | Maximum IO bandwidth limit for the system drive (Windows only) |
| `--io-maxiops` | `uint64` | `0` | Maximum IOps limit for the system drive (Windows only) |
| `--ip` | `string` | | IPv4 address (e.g., 172.30.100.104) |
| `--ip6` | `string` | | IPv6 address (e.g., 2001:db8::33) |
| `--ipc` | `string` | | IPC mode to use |
| `--isolation` | `string` | | Container isolation technology |
| `--kernel-memory` | `bytes` | `0` | Kernel memory limit |
| `-l`, `--label` | `list` | | Set meta data on a container |
| `--label-file` | `list` | | Read in a line delimited file of labels |
| `--link` | `list` | | Add link to another container |
| `--link-local-ip` | `list` | | Container IPv4/IPv6 link-local addresses |
| `--log-driver` | `string` | | Logging driver for the container |
| `--log-opt` | `list` | | Log driver options |
| `--mac-address` | `string` | | Container MAC address (e.g., 92:d0:c6:0a:29:33) |
| `-m`, `--memory` | `bytes` | `0` | Memory limit |
| `--memory-reservation` | `bytes` | `0` | Memory soft limit |
| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: '-1' to enable unlimited swap |
| `--memory-swappiness` | `int64` | `-1` | Tune container memory swappiness (0 to 100) |
| `--mount` | `mount` | | Attach a filesystem mount to the container |
| `--name` | `string` | | Assign a name to the container |
| `--network` | `network` | | Connect a container to a network |
| `--network-alias` | `list` | | Add network-scoped alias for the container |
| `--no-healthcheck` | | | Disable any container-specified HEALTHCHECK |
| `--oom-kill-disable` | | | Disable OOM Killer |
| `--oom-score-adj` | `int` | `0` | Tune host's OOM preferences (-1000 to 1000) |
| `--pid` | `string` | | PID namespace to use |
| `--pids-limit` | `int64` | `0` | Tune container pids limit (set -1 for unlimited) |
| `--platform` | `string` | | Set platform if server is multi-platform capable |
| `--privileged` | | | Give extended privileges to this container |
| `-p`, `--publish` | `list` | | Publish a container's port(s) to the host |
| `-P`, `--publish-all` | | | Publish all exposed ports to random ports |
| `--pull` | `string` | `missing` | Pull image before creating (`always`, `\|missing`, `never`) |
| `-q`, `--quiet` | | | Suppress the pull output |
| `--read-only` | | | Mount the container's root filesystem as read only |
| `--restart` | `string` | `no` | Restart policy to apply when a container exits |
| `--rm` | | | Automatically remove the container when it exits |
| `--runtime` | `string` | | Runtime to use for this container |
| `--security-opt` | `list` | | Security Options |
| `--shm-size` | `bytes` | `0` | Size of /dev/shm |
| `--stop-signal` | `string` | | Signal to stop the container |
| `--stop-timeout` | `int` | `0` | Timeout (in seconds) to stop a container |
| `--storage-opt` | `list` | | Storage driver options for the container |
| `--sysctl` | `map` | `map[]` | Sysctl options |
| `--tmpfs` | `list` | | Mount a tmpfs directory |
| `-t`, `--tty` | | | Allocate a pseudo-TTY |
| `--ulimit` | `ulimit` | | Ulimit options |
| `-u`, `--user` | `string` | | Username or UID (format: <name\|uid>[:<group\|gid>]) |
| `--userns` | `string` | | User namespace to use |
| `--uts` | `string` | | UTS namespace to use |
| `-v`, `--volume` | `list` | | Bind mount a volume |
| `--volume-driver` | `string` | | Optional volume driver for the container |
| `--volumes-from` | `list` | | Mount volumes from the specified container(s) |
| `-w`, `--workdir` | `string` | | Working directory inside the container |
<!---MARKER_GEN_END-->
## Description
See [docker create](create.md) for more information.

15
docs/reference/commandline/container_diff.md Normal file
View File

@ -0,0 +1,15 @@
# container diff
<!---MARKER_GEN_START-->
Inspect changes to files or directories on a container's filesystem
### Aliases
`docker container diff`, `docker diff`
<!---MARKER_GEN_END-->
## Description
See [docker diff](diff.md) for more information.

29
docs/reference/commandline/container_exec.md Normal file
View File

@ -0,0 +1,29 @@
# container exec
<!---MARKER_GEN_START-->
Execute a command in a running container
### Aliases
`docker container exec`, `docker exec`
### Options
| Name | Type | Default | Description |
|:----------------------|:---------|:--------|:-------------------------------------------------------|
| `-d`, `--detach` | | | Detached mode: run command in the background |
| `--detach-keys` | `string` | | Override the key sequence for detaching a container |
| `-e`, `--env` | `list` | | Set environment variables |
| `--env-file` | `list` | | Read in a file of environment variables |
| `-i`, `--interactive` | | | Keep STDIN open even if not attached |
| `--privileged` | | | Give extended privileges to the command |
| `-t`, `--tty` | | | Allocate a pseudo-TTY |
| `-u`, `--user` | `string` | | Username or UID (format: `<name\|uid>[:<group\|gid>]`) |
| `-w`, `--workdir` | `string` | | Working directory inside the container |
<!---MARKER_GEN_END-->
## Description
See [docker exec](exec.md) for more information.

21
docs/reference/commandline/container_export.md Normal file
View File

@ -0,0 +1,21 @@
# container export
<!---MARKER_GEN_START-->
Export a container's filesystem as a tar archive
### Aliases
`docker container export`, `docker export`
### Options
| Name | Type | Default | Description |
|:-----------------|:---------|:--------|:-----------------------------------|
| `-o`, `--output` | `string` | | Write to a file, instead of STDOUT |
<!---MARKER_GEN_END-->
## Description
See [docker export](export.md) for more information.

14
docs/reference/commandline/container_inspect.md Normal file
View File

@ -0,0 +1,14 @@
# container inspect
<!---MARKER_GEN_START-->
Display detailed information on one or more containers
### Options
| Name | Type | Default | Description |
|:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `-f`, `--format` | `string` | | Format output using a custom template:<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
| `-s`, `--size` | | | Display total file sizes |
<!---MARKER_GEN_END-->

21
docs/reference/commandline/container_kill.md Normal file
View File

@ -0,0 +1,21 @@
# container kill
<!---MARKER_GEN_START-->
Kill one or more running containers
### Aliases
`docker container kill`, `docker kill`
### Options
| Name | Type | Default | Description |
|:-----------------|:---------|:--------|:--------------------------------|
| `-s`, `--signal` | `string` | | Signal to send to the container |
<!---MARKER_GEN_END-->
## Description
See [docker kill](kill.md) for more information.

26
docs/reference/commandline/container_logs.md Normal file
View File

@ -0,0 +1,26 @@
# container logs
<!---MARKER_GEN_START-->
Fetch the logs of a container
### Aliases
`docker container logs`, `docker logs`
### Options
| Name | Type | Default | Description |
|:---------------------|:---------|:--------|:---------------------------------------------------------------------------------------------------|
| `--details` | | | Show extra details provided to logs |
| `-f`, `--follow` | | | Follow log output |
| `--since` | `string` | | Show logs since timestamp (e.g. `2013-01-02T13:23:37Z`) or relative (e.g. `42m` for 42 minutes) |
| `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs |
| `-t`, `--timestamps` | | | Show timestamps |
| `--until` | `string` | | Show logs before a timestamp (e.g. `2013-01-02T13:23:37Z`) or relative (e.g. `42m` for 42 minutes) |
<!---MARKER_GEN_END-->
## Description
See [docker logs](logs.md) for more information.

28
docs/reference/commandline/container_ls.md Normal file
View File

@ -0,0 +1,28 @@
# container ls
<!---MARKER_GEN_START-->
List containers
### Aliases
`docker container ls`, `docker container list`, `docker container ps`, `docker ps`
### Options
| Name | Type | Default | Description |
|:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `-a`, `--all` | | | Show all containers (default shows just running) |
| `-f`, `--filter` | `filter` | | Filter output based on conditions provided |
| `--format` | `string` | | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
| `-n`, `--last` | `int` | `-1` | Show n last created containers (includes all states) |
| `-l`, `--latest` | | | Show the latest created container (includes all states) |
| `--no-trunc` | | | Don't truncate output |
| `-q`, `--quiet` | | | Only display container IDs |
| `-s`, `--size` | | | Display total file sizes |
<!---MARKER_GEN_END-->
## Description
See [docker ps](ps.md) for more information.

15
docs/reference/commandline/container_pause.md Normal file
View File

@ -0,0 +1,15 @@
# container pause
<!---MARKER_GEN_START-->
Pause all processes within one or more containers
### Aliases
`docker container pause`, `docker pause`
<!---MARKER_GEN_END-->
## Description
See [docker pause](pause.md) for more information.

15
docs/reference/commandline/container_port.md Normal file
View File

@ -0,0 +1,15 @@
# container port
<!---MARKER_GEN_START-->
List port mappings or a specific mapping for the container
### Aliases
`docker container port`, `docker port`
<!---MARKER_GEN_END-->
## Description
See [docker port](port.md) for more information.

25
docs/reference/commandline/container_prune.md
View File

@ -1,22 +1,17 @@
---
title: "container prune"
description: "Remove all stopped containers"
keywords: container, prune, delete, remove
---
# container prune # container prune
```markdown <!---MARKER_GEN_START-->
Usage: docker container prune [OPTIONS]
Remove all stopped containers Remove all stopped containers
Options: ### Options
Options:
--filter filter Provide filter values (e.g. 'until=<timestamp>') | Name | Type | Default | Description |
-f, --force Do not prompt for confirmation |:----------------------|:---------|:--------|:-------------------------------------------------|
--help Print usage | [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `until=<timestamp>`) |
``` | `-f`, `--force` | | | Do not prompt for confirmation |
<!---MARKER_GEN_END-->
## Description ## Description

15
docs/reference/commandline/container_rename.md Normal file
View File

@ -0,0 +1,15 @@
# container rename
<!---MARKER_GEN_START-->
Rename a container
### Aliases
`docker container rename`, `docker rename`
<!---MARKER_GEN_END-->
## Description
See [docker rename](rename.md) for more information.

22
docs/reference/commandline/container_restart.md Normal file
View File

@ -0,0 +1,22 @@
# container restart
<!---MARKER_GEN_START-->
Restart one or more containers
### Aliases
`docker container restart`, `docker restart`
### Options
| Name | Type | Default | Description |
|:-----------------|:---------|:--------|:---------------------------------------------|
| `-s`, `--signal` | `string` | | Signal to send to the container |
| `-t`, `--time` | `int` | `0` | Seconds to wait before killing the container |
<!---MARKER_GEN_END-->
## Description
See [docker restart](restart.md) for more information.

23
docs/reference/commandline/container_rm.md Normal file
View File

@ -0,0 +1,23 @@
# container rm
<!---MARKER_GEN_START-->
Remove one or more containers
### Aliases
`docker container rm`, `docker rm`
### Options
| Name | Type | Default | Description |
|:------------------|:-----|:--------|:--------------------------------------------------------|
| `-f`, `--force` | | | Force the removal of a running container (uses SIGKILL) |
| `-l`, `--link` | | | Remove the specified link |
| `-v`, `--volumes` | | | Remove anonymous volumes associated with the container |
<!---MARKER_GEN_END-->
## Description
See [docker rm](rm.md) for more information.

121
docs/reference/commandline/container_run.md Normal file
View File

@ -0,0 +1,121 @@
# container run
<!---MARKER_GEN_START-->
Create and run a new container from an image
### Aliases
`docker container run`, `docker run`
### Options
| Name | Type | Default | Description |
|:--------------------------|:--------------|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--add-host` | `list` | | Add a custom host-to-IP mapping (host:ip) |
| `-a`, `--attach` | `list` | | Attach to STDIN, STDOUT or STDERR |
| `--blkio-weight` | `uint16` | `0` | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) |
| `--blkio-weight-device` | `list` | | Block IO weight (relative device weight) |
| `--cap-add` | `list` | | Add Linux capabilities |
| `--cap-drop` | `list` | | Drop Linux capabilities |
| `--cgroup-parent` | `string` | | Optional parent cgroup for the container |
| `--cgroupns` | `string` | | Cgroup namespace to use (host\|private)<br>'host': Run the container in the Docker host's cgroup namespace<br>'private': Run the container in its own private cgroup namespace<br>'': Use the cgroup namespace as configured by the<br> default-cgroupns-mode option on the daemon (default) |
| `--cidfile` | `string` | | Write the container ID to the file |
| `--cpu-count` | `int64` | `0` | CPU count (Windows only) |
| `--cpu-percent` | `int64` | `0` | CPU percent (Windows only) |
| `--cpu-period` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) period |
| `--cpu-quota` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) quota |
| `--cpu-rt-period` | `int64` | `0` | Limit CPU real-time period in microseconds |
| `--cpu-rt-runtime` | `int64` | `0` | Limit CPU real-time runtime in microseconds |
| `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) |
| `--cpus` | `decimal` | | Number of CPUs |
| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) |
| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) |
| `-d`, `--detach` | | | Run container in background and print container ID |
| `--detach-keys` | `string` | | Override the key sequence for detaching a container |
| `--device` | `list` | | Add a host device to the container |
| `--device-cgroup-rule` | `list` | | Add a rule to the cgroup allowed devices list |
| `--device-read-bps` | `list` | | Limit read rate (bytes per second) from a device |
| `--device-read-iops` | `list` | | Limit read rate (IO per second) from a device |
| `--device-write-bps` | `list` | | Limit write rate (bytes per second) to a device |
| `--device-write-iops` | `list` | | Limit write rate (IO per second) to a device |
| `--disable-content-trust` | | | Skip image verification |
| `--dns` | `list` | | Set custom DNS servers |
| `--dns-option` | `list` | | Set DNS options |
| `--dns-search` | `list` | | Set custom DNS search domains |
| `--domainname` | `string` | | Container NIS domain name |
| `--entrypoint` | `string` | | Overwrite the default ENTRYPOINT of the image |
| `-e`, `--env` | `list` | | Set environment variables |
| `--env-file` | `list` | | Read in a file of environment variables |
| `--expose` | `list` | | Expose a port or a range of ports |
| `--gpus` | `gpu-request` | | GPU devices to add to the container ('all' to pass all GPUs) |
| `--group-add` | `list` | | Add additional groups to join |
| `--health-cmd` | `string` | | Command to run to check health |
| `--health-interval` | `duration` | `0s` | Time between running the check (ms\|s\|m\|h) (default 0s) |
| `--health-retries` | `int` | `0` | Consecutive failures needed to report unhealthy |
| `--health-start-period` | `duration` | `0s` | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s) |
| `--health-timeout` | `duration` | `0s` | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s) |
| `--help` | | | Print usage |
| `-h`, `--hostname` | `string` | | Container host name |
| `--init` | | | Run an init inside the container that forwards signals and reaps processes |
| `-i`, `--interactive` | | | Keep STDIN open even if not attached |
| `--io-maxbandwidth` | `bytes` | `0` | Maximum IO bandwidth limit for the system drive (Windows only) |
| `--io-maxiops` | `uint64` | `0` | Maximum IOps limit for the system drive (Windows only) |
| `--ip` | `string` | | IPv4 address (e.g., 172.30.100.104) |
| `--ip6` | `string` | | IPv6 address (e.g., 2001:db8::33) |
| `--ipc` | `string` | | IPC mode to use |
| `--isolation` | `string` | | Container isolation technology |
| `--kernel-memory` | `bytes` | `0` | Kernel memory limit |
| `-l`, `--label` | `list` | | Set meta data on a container |
| `--label-file` | `list` | | Read in a line delimited file of labels |
| `--link` | `list` | | Add link to another container |
| `--link-local-ip` | `list` | | Container IPv4/IPv6 link-local addresses |
| `--log-driver` | `string` | | Logging driver for the container |
| `--log-opt` | `list` | | Log driver options |
| `--mac-address` | `string` | | Container MAC address (e.g., 92:d0:c6:0a:29:33) |
| `-m`, `--memory` | `bytes` | `0` | Memory limit |
| `--memory-reservation` | `bytes` | `0` | Memory soft limit |
| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: '-1' to enable unlimited swap |
| `--memory-swappiness` | `int64` | `-1` | Tune container memory swappiness (0 to 100) |
| `--mount` | `mount` | | Attach a filesystem mount to the container |
| `--name` | `string` | | Assign a name to the container |
| `--network` | `network` | | Connect a container to a network |
| `--network-alias` | `list` | | Add network-scoped alias for the container |
| `--no-healthcheck` | | | Disable any container-specified HEALTHCHECK |
| `--oom-kill-disable` | | | Disable OOM Killer |
| `--oom-score-adj` | `int` | `0` | Tune host's OOM preferences (-1000 to 1000) |
| `--pid` | `string` | | PID namespace to use |
| `--pids-limit` | `int64` | `0` | Tune container pids limit (set -1 for unlimited) |
| `--platform` | `string` | | Set platform if server is multi-platform capable |
| `--privileged` | | | Give extended privileges to this container |
| `-p`, `--publish` | `list` | | Publish a container's port(s) to the host |
| `-P`, `--publish-all` | | | Publish all exposed ports to random ports |
| `--pull` | `string` | `missing` | Pull image before running (`always`, `missing`, `never`) |
| `-q`, `--quiet` | | | Suppress the pull output |
| `--read-only` | | | Mount the container's root filesystem as read only |
| `--restart` | `string` | `no` | Restart policy to apply when a container exits |
| `--rm` | | | Automatically remove the container when it exits |
| `--runtime` | `string` | | Runtime to use for this container |
| `--security-opt` | `list` | | Security Options |
| `--shm-size` | `bytes` | `0` | Size of /dev/shm |
| `--sig-proxy` | | | Proxy received signals to the process |
| `--stop-signal` | `string` | | Signal to stop the container |
| `--stop-timeout` | `int` | `0` | Timeout (in seconds) to stop a container |
| `--storage-opt` | `list` | | Storage driver options for the container |
| `--sysctl` | `map` | `map[]` | Sysctl options |
| `--tmpfs` | `list` | | Mount a tmpfs directory |
| `-t`, `--tty` | | | Allocate a pseudo-TTY |
| `--ulimit` | `ulimit` | | Ulimit options |
| `-u`, `--user` | `string` | | Username or UID (format: <name\|uid>[:<group\|gid>]) |
| `--userns` | `string` | | User namespace to use |
| `--uts` | `string` | | UTS namespace to use |
| `-v`, `--volume` | `list` | | Bind mount a volume |
| `--volume-driver` | `string` | | Optional volume driver for the container |
| `--volumes-from` | `list` | | Mount volumes from the specified container(s) |
| `-w`, `--workdir` | `string` | | Working directory inside the container |
<!---MARKER_GEN_END-->
## Description
See [docker run](run.md) for more information.

25
docs/reference/commandline/container_start.md Normal file
View File

@ -0,0 +1,25 @@
# container start
<!---MARKER_GEN_START-->
Start one or more stopped containers
### Aliases
`docker container start`, `docker start`
### Options
| Name | Type | Default | Description |
|:----------------------|:---------|:--------|:----------------------------------------------------|
| `-a`, `--attach` | | | Attach STDOUT/STDERR and forward signals |
| `--checkpoint` | `string` | | Restore from this checkpoint |
| `--checkpoint-dir` | `string` | | Use a custom checkpoint storage directory |
| `--detach-keys` | `string` | | Override the key sequence for detaching a container |
| `-i`, `--interactive` | | | Attach container's STDIN |
<!---MARKER_GEN_END-->
## Description
See [docker start](start.md) for more information.

24
docs/reference/commandline/container_stats.md Normal file
View File

@ -0,0 +1,24 @@
# container stats
<!---MARKER_GEN_START-->
Display a live stream of container(s) resource usage statistics
### Aliases
`docker container stats`, `docker stats`
### Options
| Name | Type | Default | Description |
|:--------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `-a`, `--all` | | | Show all containers (default shows just running) |
| `--format` | `string` | | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
| `--no-stream` | | | Disable streaming stats and only pull the first result |
| `--no-trunc` | | | Do not truncate output |
<!---MARKER_GEN_END-->
## Description
See [docker stats](stats.md) for more information.

22
docs/reference/commandline/container_stop.md Normal file
View File

@ -0,0 +1,22 @@
# container stop
<!---MARKER_GEN_START-->
Stop one or more running containers
### Aliases
`docker container stop`, `docker stop`
### Options
| Name | Type | Default | Description |
|:-----------------|:---------|:--------|:---------------------------------------------|
| `-s`, `--signal` | `string` | | Signal to send to the container |
| `-t`, `--time` | `int` | `0` | Seconds to wait before killing the container |
<!---MARKER_GEN_END-->
## Description
See [docker stop](stop.md) for more information.

15
docs/reference/commandline/container_top.md Normal file
View File

@ -0,0 +1,15 @@
# container top
<!---MARKER_GEN_START-->
Display the running processes of a container
### Aliases
`docker container top`, `docker top`
<!---MARKER_GEN_END-->
## Description
See [docker top](top.md) for more information.

15
docs/reference/commandline/container_unpause.md Normal file
View File

@ -0,0 +1,15 @@
# container unpause
<!---MARKER_GEN_START-->
Unpause all processes within one or more containers
### Aliases
`docker container unpause`, `docker unpause`
<!---MARKER_GEN_END-->
## Description
See [docker unpause](unpause.md) for more information.

34
docs/reference/commandline/container_update.md Normal file
View File

@ -0,0 +1,34 @@
# container update
<!---MARKER_GEN_START-->
Update configuration of one or more containers
### Aliases
`docker container update`, `docker update`
### Options
| Name | Type | Default | Description |
|:-----------------------|:----------|:--------|:-----------------------------------------------------------------------------|
| `--blkio-weight` | `uint16` | `0` | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) |
| `--cpu-period` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) period |
| `--cpu-quota` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) quota |
| `--cpu-rt-period` | `int64` | `0` | Limit the CPU real-time period in microseconds |
| `--cpu-rt-runtime` | `int64` | `0` | Limit the CPU real-time runtime in microseconds |
| `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) |
| `--cpus` | `decimal` | | Number of CPUs |
| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) |
| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) |
| `-m`, `--memory` | `bytes` | `0` | Memory limit |
| `--memory-reservation` | `bytes` | `0` | Memory soft limit |
| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: -1 to enable unlimited swap |
| `--pids-limit` | `int64` | `0` | Tune container pids limit (set -1 for unlimited) |
| `--restart` | `string` | | Restart policy to apply when a container exits |
<!---MARKER_GEN_END-->
## Description
See [docker update](update.md) for more information.

15
docs/reference/commandline/container_wait.md Normal file
View File

@ -0,0 +1,15 @@
# container wait
<!---MARKER_GEN_START-->
Block until one or more containers stop, then print their exit codes
### Aliases
`docker container wait`, `docker wait`
<!---MARKER_GEN_END-->
## Description
See [docker wait](wait.md) for more information.

38
docs/reference/commandline/context.md
View File

@ -1,33 +1,25 @@
---
title: "context"
description: "The context command description and usage"
keywords: "context"
---
# config # config
```markdown <!---MARKER_GEN_START-->
Manage contexts Manage contexts
Usage: ### Subcommands
docker context [command]
Available Commands: | Name | Description |
create Create new context |:--------------------------------|:------------------------------------------------------------------|
export Export a context to a tar or kubeconfig file | [`create`](context_create.md) | Create a context |
import Import a context from a tar or zip file | [`export`](context_export.md) | Export a context to a tar archive FILE or a tar stream on STDOUT. |
inspect Display detailed information on one or more contexts | [`import`](context_import.md) | Import a context from a tar or zip file |
list List available contexts | [`inspect`](context_inspect.md) | Display detailed information on one or more contexts |
rm Remove one or more contexts | [`ls`](context_ls.md) | List contexts |
show Print the current context | [`rm`](context_rm.md) | Remove one or more contexts |
update Update a context | [`show`](context_show.md) | Print the name of the current context |
use Set the default context | [`update`](context_update.md) | Update a context |
| [`use`](context_use.md) | Set the current docker context |
Flags:
-h, --help Help for context
Use "docker context [command] --help" for more information about a command.
``` <!---MARKER_GEN_END-->
## Description ## Description

33
docs/reference/commandline/context_create.md
View File

@ -1,20 +1,12 @@
---
title: "context create"
description: "The context create command description and usage"
keywords: "context, create"
---
# context create # context create
```markdown <!---MARKER_GEN_START-->
Usage: docker context create [OPTIONS] CONTEXT
Create a context Create a context
Docker endpoint config: Docker endpoint config:
NAME DESCRIPTION NAME DESCRIPTION
from Copy Docker endpoint configuration from an existing context from Copy named context's Docker endpoint configuration
host Docker endpoint on which to connect host Docker endpoint on which to connect
ca Trust certs signed only by this CA ca Trust certs signed only by this CA
cert Path to TLS certificate file cert Path to TLS certificate file
@ -23,16 +15,19 @@ skip-tls-verify Skip TLS certificate validation
Example: Example:
$ docker context create my-context \ $ docker context create my-context --description "some description" --docker "host=tcp://myserver:2376,ca=~/ca-file,cert=~/cert-file,key=~/key-file"
--description "some description" \
--docker "host=tcp://myserver:2376,ca=~/ca-file,cert=~/cert-file,key=~/key-file"
Options:
--description string Description of the context ### Options
--docker stringToString set the docker endpoint
(default []) | Name | Type | Default | Description |
--from string Create the context from an existing context |:----------------------|:-----------------|:--------|:------------------------------------|
``` | `--description` | `string` | | Description of the context |
| [`--docker`](#docker) | `stringToString` | | set the docker endpoint |
| [`--from`](#from) | `string` | | create context from a named context |
<!---MARKER_GEN_END-->
## Description ## Description

14
docs/reference/commandline/context_export.md
View File

@ -1,16 +1,10 @@
---
title: "context export"
description: "The context export command description and usage"
keywords: "context, export"
---
# context export # context export
```markdown <!---MARKER_GEN_START-->
Usage: docker context export [OPTIONS] CONTEXT [FILE|-]
Export a context to a tar archive FILE or a tar stream on STDOUT. Export a context to a tar archive FILE or a tar stream on STDOUT.
```
<!---MARKER_GEN_END-->
## Description ## Description

14
docs/reference/commandline/context_import.md
View File

@ -1,16 +1,10 @@
---
title: "context import"
description: "The context import command description and usage"
keywords: "context, import"
---
# context import # context import
```markdown <!---MARKER_GEN_START-->
Usage: docker context import [OPTIONS] CONTEXT FILE|- Import a context from a tar or zip file
Import a context from a tar file
``` <!---MARKER_GEN_END-->
## Description ## Description

24
docs/reference/commandline/context_inspect.md
View File

@ -1,22 +1,16 @@
---
title: "context inspect"
description: "The context inspect command description and usage"
keywords: "context, inspect"
---
# context inspect # context inspect
```markdown <!---MARKER_GEN_START-->
Usage: docker context inspect [OPTIONS] [CONTEXT] [CONTEXT...]
Display detailed information on one or more contexts Display detailed information on one or more contexts
Options: ### Options
-f, --format string Format output using a custom template:
'json': Print in JSON format | Name | Type | Default | Description |
'TEMPLATE': Print output using the given Go template. |:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | `-f`, `--format` | `string` | | Format output using a custom template:<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
```
<!---MARKER_GEN_END-->
## Description ## Description

33
docs/reference/commandline/context_ls.md
View File

@ -1,28 +1,21 @@
---
title: "context ls"
description: "The context ls command description and usage"
keywords: "context, ls"
---
# context ls # context ls
```markdown <!---MARKER_GEN_START-->
Usage: docker context ls [OPTIONS]
List contexts List contexts
Aliases: ### Aliases
ls, list
Options: `docker context ls`, `docker context list`
--format string Format output using a custom template:
'table': Print output in table format with column headers (default) ### Options
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format | Name | Type | Default | Description |
'TEMPLATE': Print output using the given Go template. |:----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | `--format` | `string` | | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
-q, --quiet Only show context names | `-q`, `--quiet` | | | Only show context names |
```
<!---MARKER_GEN_END-->
## Examples ## Examples

26
docs/reference/commandline/context_rm.md
View File

@ -1,19 +1,17 @@
---
title: "context rm"
description: "The context rm command description and usage"
keywords: "context, rm"
---
# context rm # context rm
```markdown <!---MARKER_GEN_START-->
Usage: docker context rm CONTEXT [CONTEXT...]
Remove one or more contexts Remove one or more contexts
Aliases: ### Aliases
rm, remove
Options: `docker context rm`, `docker context remove`
-f, --force Force the removal of a context in use
``` ### Options
| Name | Type | Default | Description |
|:----------------|:-----|:--------|:--------------------------------------|
| `-f`, `--force` | | | Force the removal of a context in use |
<!---MARKER_GEN_END-->

14
docs/reference/commandline/context_show.md
View File

@ -1,16 +1,10 @@
---
title: "context show"
description: "The context show command description and usage"
keywords: "context, show"
---
# context show # context show
```markdown <!---MARKER_GEN_START-->
Usage: docker context show
Print the name of the current context Print the name of the current context
```
<!---MARKER_GEN_END-->
## Description ## Description

27
docs/reference/commandline/context_update.md
View File

@ -1,20 +1,12 @@
---
title: "context update"
description: "The context update command description and usage"
keywords: "context, update"
---
# context update # context update
```markdown <!---MARKER_GEN_START-->
Usage: docker context update [OPTIONS] CONTEXT
Update a context Update a context
Docker endpoint config: Docker endpoint config:
NAME DESCRIPTION NAME DESCRIPTION
from Copy Docker endpoint configuration from an existing context from Copy named context's Docker endpoint configuration
host Docker endpoint on which to connect host Docker endpoint on which to connect
ca Trust certs signed only by this CA ca Trust certs signed only by this CA
cert Path to TLS certificate file cert Path to TLS certificate file
@ -25,11 +17,16 @@ Example:
$ docker context update my-context --description "some description" --docker "host=tcp://myserver:2376,ca=~/ca-file,cert=~/cert-file,key=~/key-file" $ docker context update my-context --description "some description" --docker "host=tcp://myserver:2376,ca=~/ca-file,cert=~/cert-file,key=~/key-file"
Options:
--description string Description of the context ### Options
--docker stringToString set the docker endpoint
(default []) | Name | Type | Default | Description |
``` |:----------------|:-----------------|:--------|:---------------------------|
| `--description` | `string` | | Description of the context |
| `--docker` | `stringToString` | | set the docker endpoint |
<!---MARKER_GEN_END-->
## Description ## Description

14
docs/reference/commandline/context_use.md
View File

@ -1,16 +1,10 @@
---
title: "context use"
description: "The context use command description and usage"
keywords: "context, use"
---
# context use # context use
```markdown <!---MARKER_GEN_START-->
Usage: docker context use CONTEXT
Set the current docker context Set the current docker context
```
<!---MARKER_GEN_END-->
## Description ## Description

31
docs/reference/commandline/cp.md
View File

@ -1,15 +1,6 @@
---
title: "cp"
description: "The cp command description and usage"
keywords: "copy, container, files, folders"
---
# cp # cp
```markdown <!---MARKER_GEN_START-->
Usage: docker cp [OPTIONS] CONTAINER:SRC_PATH DEST_PATH|-
docker cp [OPTIONS] SRC_PATH|- CONTAINER:DEST_PATH
Copy files/folders between a container and the local filesystem Copy files/folders between a container and the local filesystem
Use '-' as the source to read a tar archive from stdin Use '-' as the source to read a tar archive from stdin
@ -17,14 +8,20 @@ and extract it to a directory destination in a container.
Use '-' as the destination to stream a tar archive of a Use '-' as the destination to stream a tar archive of a
container source to stdout. container source to stdout.
Aliases: ### Aliases
docker container cp, docker cp
Options: `docker container cp`, `docker cp`
-L, --follow-link Always follow symbol link in SRC_PATH
-a, --archive Archive mode (copy all uid/gid information) ### Options
--help Print usage
``` | Name | Type | Default | Description |
|:----------------------|:-----|:--------|:-------------------------------------------------------------------------------------------------------------|
| `-a`, `--archive` | | | Archive mode (copy all uid/gid information) |
| `-L`, `--follow-link` | | | Always follow symbol link in SRC_PATH |
| `-q`, `--quiet` | | | Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached |
<!---MARKER_GEN_END-->
## Description ## Description

242
docs/reference/commandline/create.md
View File

@ -1,141 +1,117 @@
---
title: "create"
description: "The create command description and usage"
keywords: "docker, create, container"
---
# create # create
Creates a new container. <!---MARKER_GEN_START-->
```markdown
Usage: docker create [OPTIONS] IMAGE [COMMAND] [ARG...]
Create a new container Create a new container
Aliases: ### Aliases
docker container create, docker create
Options: `docker container create`, `docker create`
--add-host value Add a custom host-to-IP mapping (host:ip) (default [])
-a, --attach value Attach to STDIN, STDOUT or STDERR (default []) ### Options
--blkio-weight value Block IO (relative weight), between 10 and 1000
--blkio-weight-device value Block IO weight (relative device weight) (default []) | Name | Type | Default | Description |
--cap-add value Add Linux capabilities (default []) |:--------------------------|:--------------|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
--cap-drop value Drop Linux capabilities (default []) | `--add-host` | `list` | | Add a custom host-to-IP mapping (host:ip) |
--cgroupns string Cgroup namespace to use | `-a`, `--attach` | `list` | | Attach to STDIN, STDOUT or STDERR |
'host': Run the container in the Docker host's cgroup namespace | `--blkio-weight` | `uint16` | `0` | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) |
'private': Run the container in its own private cgroup namespace | `--blkio-weight-device` | `list` | | Block IO weight (relative device weight) |
'': Use the default Docker daemon cgroup namespace specified by the `--default-cgroupns-mode` option | `--cap-add` | `list` | | Add Linux capabilities |
--cgroup-parent string Optional parent cgroup for the container | `--cap-drop` | `list` | | Drop Linux capabilities |
--cidfile string Write the container ID to the file | `--cgroup-parent` | `string` | | Optional parent cgroup for the container |
--cpu-count int The number of CPUs available for execution by the container. | `--cgroupns` | `string` | | Cgroup namespace to use (host\|private)<br>'host': Run the container in the Docker host's cgroup namespace<br>'private': Run the container in its own private cgroup namespace<br>'': Use the cgroup namespace as configured by the<br> default-cgroupns-mode option on the daemon (default) |
Windows daemon only. On Windows Server containers, this is | `--cidfile` | `string` | | Write the container ID to the file |
approximated as a percentage of total CPU usage. | `--cpu-count` | `int64` | `0` | CPU count (Windows only) |
--cpu-percent int CPU percent (Windows only) | `--cpu-percent` | `int64` | `0` | CPU percent (Windows only) |
--cpu-period int Limit CPU CFS (Completely Fair Scheduler) period | `--cpu-period` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) period |
--cpu-quota int Limit CPU CFS (Completely Fair Scheduler) quota | `--cpu-quota` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) quota |
-c, --cpu-shares int CPU shares (relative weight) | `--cpu-rt-period` | `int64` | `0` | Limit CPU real-time period in microseconds |
--cpus NanoCPUs Number of CPUs (default 0.000) | `--cpu-rt-runtime` | `int64` | `0` | Limit CPU real-time runtime in microseconds |
--cpu-rt-period int Limit the CPU real-time period in microseconds | `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) |
--cpu-rt-runtime int Limit the CPU real-time runtime in microseconds | `--cpus` | `decimal` | | Number of CPUs |
--cpuset-cpus string CPUs in which to allow execution (0-3, 0,1) | `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) |
--cpuset-mems string MEMs in which to allow execution (0-3, 0,1) | `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) |
--device value Add a host device to the container (default []) | `--device` | `list` | | Add a host device to the container |
--device-cgroup-rule value Add a rule to the cgroup allowed devices list | `--device-cgroup-rule` | `list` | | Add a rule to the cgroup allowed devices list |
--device-read-bps value Limit read rate (bytes per second) from a device (default []) | `--device-read-bps` | `list` | | Limit read rate (bytes per second) from a device |
--device-read-iops value Limit read rate (IO per second) from a device (default []) | `--device-read-iops` | `list` | | Limit read rate (IO per second) from a device |
--device-write-bps value Limit write rate (bytes per second) to a device (default []) | `--device-write-bps` | `list` | | Limit write rate (bytes per second) to a device |
--device-write-iops value Limit write rate (IO per second) to a device (default []) | `--device-write-iops` | `list` | | Limit write rate (IO per second) to a device |
--disable-content-trust Skip image verification (default true) | `--disable-content-trust` | | | Skip image verification |
--dns value Set custom DNS servers (default []) | `--dns` | `list` | | Set custom DNS servers |
--dns-option value Set DNS options (default []) | `--dns-option` | `list` | | Set DNS options |
--dns-search value Set custom DNS search domains (default []) | `--dns-search` | `list` | | Set custom DNS search domains |
--domainname string Container NIS domain name | `--domainname` | `string` | | Container NIS domain name |
--entrypoint string Overwrite the default ENTRYPOINT of the image | `--entrypoint` | `string` | | Overwrite the default ENTRYPOINT of the image |
-e, --env value Set environment variables (default []) | `-e`, `--env` | `list` | | Set environment variables |
--env-file value Read in a file of environment variables (default []) | `--env-file` | `list` | | Read in a file of environment variables |
--expose value Expose a port or a range of ports (default []) | `--expose` | `list` | | Expose a port or a range of ports |
--group-add value Add additional groups to join (default []) | `--gpus` | `gpu-request` | | GPU devices to add to the container ('all' to pass all GPUs) |
--health-cmd string Command to run to check health | `--group-add` | `list` | | Add additional groups to join |
--health-interval duration Time between running the check (ns|us|ms|s|m|h) (default 0s) | `--health-cmd` | `string` | | Command to run to check health |
--health-retries int Consecutive failures needed to report unhealthy | `--health-interval` | `duration` | `0s` | Time between running the check (ms\|s\|m\|h) (default 0s) |
--health-timeout duration Maximum time to allow one check to run (ns|us|ms|s|m|h) (default 0s) | `--health-retries` | `int` | `0` | Consecutive failures needed to report unhealthy |
--health-start-period duration Start period for the container to initialize before counting retries towards unstable (ns|us|ms|s|m|h) (default 0s) | `--health-start-period` | `duration` | `0s` | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s) |
--help Print usage | `--health-timeout` | `duration` | `0s` | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s) |
-h, --hostname string Container host name | `--help` | | | Print usage |
--init Run an init inside the container that forwards signals and reaps processes | `-h`, `--hostname` | `string` | | Container host name |
-i, --interactive Keep STDIN open even if not attached | `--init` | | | Run an init inside the container that forwards signals and reaps processes |
--io-maxbandwidth string Maximum IO bandwidth limit for the system drive (Windows only) | `-i`, `--interactive` | | | Keep STDIN open even if not attached |
--io-maxiops uint Maximum IOps limit for the system drive (Windows only) | `--io-maxbandwidth` | `bytes` | `0` | Maximum IO bandwidth limit for the system drive (Windows only) |
--ip string IPv4 address (e.g., 172.30.100.104) | `--io-maxiops` | `uint64` | `0` | Maximum IOps limit for the system drive (Windows only) |
--ip6 string IPv6 address (e.g., 2001:db8::33) | `--ip` | `string` | | IPv4 address (e.g., 172.30.100.104) |
--ipc string IPC namespace to use | `--ip6` | `string` | | IPv6 address (e.g., 2001:db8::33) |
--isolation string Container isolation technology | `--ipc` | `string` | | IPC mode to use |
--kernel-memory string Kernel memory limit | `--isolation` | `string` | | Container isolation technology |
-l, --label value Set meta data on a container (default []) | `--kernel-memory` | `bytes` | `0` | Kernel memory limit |
--label-file value Read in a line delimited file of labels (default []) | `-l`, `--label` | `list` | | Set meta data on a container |
--link value Add link to another container (default []) | `--label-file` | `list` | | Read in a line delimited file of labels |
--link-local-ip value Container IPv4/IPv6 link-local addresses (default []) | `--link` | `list` | | Add link to another container |
--log-driver string Logging driver for the container | `--link-local-ip` | `list` | | Container IPv4/IPv6 link-local addresses |
--log-opt value Log driver options (default []) | `--log-driver` | `string` | | Logging driver for the container |
--mac-address string Container MAC address (e.g., 92:d0:c6:0a:29:33) | `--log-opt` | `list` | | Log driver options |
-m, --memory string Memory limit | `--mac-address` | `string` | | Container MAC address (e.g., 92:d0:c6:0a:29:33) |
--memory-reservation string Memory soft limit | `-m`, `--memory` | `bytes` | `0` | Memory limit |
--memory-swap string Swap limit equal to memory plus swap: '-1' to enable unlimited swap | `--memory-reservation` | `bytes` | `0` | Memory soft limit |
--memory-swappiness int Tune container memory swappiness (0 to 100) (default -1) | `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: '-1' to enable unlimited swap |
--mount value Attach a filesystem mount to the container (default []) | `--memory-swappiness` | `int64` | `-1` | Tune container memory swappiness (0 to 100) |
--name string Assign a name to the container | `--mount` | `mount` | | Attach a filesystem mount to the container |
--network-alias value Add network-scoped alias for the container (default []) | `--name` | `string` | | Assign a name to the container |
--network string Connect a container to a network (default "default") | `--network` | `network` | | Connect a container to a network |
'bridge': create a network stack on the default Docker bridge | `--network-alias` | `list` | | Add network-scoped alias for the container |
'none': no networking | `--no-healthcheck` | | | Disable any container-specified HEALTHCHECK |
'container:<name|id>': reuse another container's network stack | `--oom-kill-disable` | | | Disable OOM Killer |
'host': use the Docker host network stack | `--oom-score-adj` | `int` | `0` | Tune host's OOM preferences (-1000 to 1000) |
'<network-name>|<network-id>': connect to a user-defined network | `--pid` | `string` | | PID namespace to use |
--no-healthcheck Disable any container-specified HEALTHCHECK | `--pids-limit` | `int64` | `0` | Tune container pids limit (set -1 for unlimited) |
--oom-kill-disable Disable OOM Killer | `--platform` | `string` | | Set platform if server is multi-platform capable |
--oom-score-adj int Tune host's OOM preferences (-1000 to 1000) | `--privileged` | | | Give extended privileges to this container |
--pid string PID namespace to use | `-p`, `--publish` | `list` | | Publish a container's port(s) to the host |
--pids-limit int Tune container pids limit (set -1 for unlimited), kernel >= 4.3 | `-P`, `--publish-all` | | | Publish all exposed ports to random ports |
--privileged Give extended privileges to this container | `--pull` | `string` | `missing` | Pull image before creating (`always`, `\|missing`, `never`) |
-p, --publish value Publish a container's port(s) to the host (default []) | `-q`, `--quiet` | | | Suppress the pull output |
-P, --publish-all Publish all exposed ports to random ports | `--read-only` | | | Mount the container's root filesystem as read only |
--pull string Pull image before creating ("always"|"missing"|"never") (default "missing") | `--restart` | `string` | `no` | Restart policy to apply when a container exits |
-q, --quiet Suppress the pull output | `--rm` | | | Automatically remove the container when it exits |
--read-only Mount the container's root filesystem as read only | `--runtime` | `string` | | Runtime to use for this container |
--restart string Restart policy to apply when a container exits (default "no") | `--security-opt` | `list` | | Security Options |
Possible values are: no, on-failure[:max-retry], always, unless-stopped | `--shm-size` | `bytes` | `0` | Size of /dev/shm |
--rm Automatically remove the container when it exits | `--stop-signal` | `string` | | Signal to stop the container |
--runtime string Runtime to use for this container | `--stop-timeout` | `int` | `0` | Timeout (in seconds) to stop a container |
--security-opt value Security Options (default []) | `--storage-opt` | `list` | | Storage driver options for the container |
--shm-size bytes Size of /dev/shm | `--sysctl` | `map` | `map[]` | Sysctl options |
The format is `<number><unit>`. `number` must be greater than `0`. | `--tmpfs` | `list` | | Mount a tmpfs directory |
Unit is optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), | `-t`, `--tty` | | | Allocate a pseudo-TTY |
or `g` (gigabytes). If you omit the unit, the system uses bytes. | `--ulimit` | `ulimit` | | Ulimit options |
--stop-signal string Signal to stop the container | `-u`, `--user` | `string` | | Username or UID (format: <name\|uid>[:<group\|gid>]) |
--stop-timeout int Timeout (in seconds) to stop a container | `--userns` | `string` | | User namespace to use |
--storage-opt value Storage driver options for the container (default []) | `--uts` | `string` | | UTS namespace to use |
--sysctl value Sysctl options (default map[]) | `-v`, `--volume` | `list` | | Bind mount a volume |
--tmpfs value Mount a tmpfs directory (default []) | `--volume-driver` | `string` | | Optional volume driver for the container |
-t, --tty Allocate a pseudo-TTY | `--volumes-from` | `list` | | Mount volumes from the specified container(s) |
--ulimit value Ulimit options (default []) | `-w`, `--workdir` | `string` | | Working directory inside the container |
-u, --user string Username or UID (format: <name|uid>[:<group|gid>])
--userns string User namespace to use
'host': Use the Docker host user namespace <!---MARKER_GEN_END-->
'': Use the Docker daemon user namespace specified by `--userns-remap` option.
--uts string UTS namespace to use
-v, --volume value Bind mount a volume (default []). The format
is `[host-src:]container-dest[:<options>]`.
The comma-delimited `options` are [rw|ro],
[z|Z], [[r]shared|[r]slave|[r]private],
[delegated|cached|consistent], and
[nocopy]. The 'host-src' is an absolute path
or a name value.
--volume-driver string Optional volume driver for the container
--volumes-from value Mount volumes from the specified container(s) (default [])
-w, --workdir string Working directory inside the container
```
## Description ## Description

20
docs/reference/commandline/diff.md
View File

@ -1,22 +1,14 @@
---
title: "diff"
description: "The diff command description and usage"
keywords: "list, changed, files, container"
---
# diff # diff
```markdown <!---MARKER_GEN_START-->
Usage: docker diff CONTAINER
Inspect changes to files or directories on a container's filesystem Inspect changes to files or directories on a container's filesystem
Aliases: ### Aliases
docker container diff, docker diff
Options: `docker container diff`, `docker diff`
--help Print usage
```
<!---MARKER_GEN_END-->
## Description ## Description

33
docs/reference/commandline/events.md
View File

@ -1,26 +1,23 @@
---
title: "events"
description: "The events command description and usage"
keywords: "events, container, report"
---
# events # events
```markdown <!---MARKER_GEN_START-->
Usage: docker events [OPTIONS]
Get real time events from the server Get real time events from the server
Aliases: ### Aliases
docker system events, docker events
Options: `docker system events`, `docker events`
-f, --filter value Filter output based on conditions provided (default [])
--format string Format the output using the given Go template ### Options
--help Print usage
--since string Show all events created since timestamp | Name | Type | Default | Description |
--until string Stream events until this timestamp |:---------------------------------------|:---------|:--------|:----------------------------------------------|
``` | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided |
| [`--format`](#format) | `string` | | Format the output using the given Go template |
| [`--since`](#since) | `string` | | Show all events created since timestamp |
| `--until` | `string` | | Stream events until this timestamp |
<!---MARKER_GEN_END-->
## Description ## Description

43
docs/reference/commandline/exec.md
View File

@ -1,31 +1,28 @@
---
title: "exec"
description: "The exec command description and usage"
keywords: "command, container, run, execute"
---
# exec # exec
```markdown <!---MARKER_GEN_START-->
Usage: docker exec [OPTIONS] CONTAINER COMMAND [ARG...]
Execute a command in a running container Execute a command in a running container
Aliases: ### Aliases
docker container exec, docker exec
Options: `docker container exec`, `docker exec`
-d, --detach Detached mode: run command in the background
--detach-keys Override the key sequence for detaching a container ### Options
-e, --env=[] Set environment variables
--env-file Read in a file of environment variables | Name | Type | Default | Description |
--help Print usage |:------------------------------------------|:---------|:--------|:-------------------------------------------------------|
-i, --interactive Keep STDIN open even if not attached | `-d`, `--detach` | | | Detached mode: run command in the background |
--privileged Give extended privileges to the command | `--detach-keys` | `string` | | Override the key sequence for detaching a container |
-t, --tty Allocate a pseudo-TTY | [`-e`](#env), [`--env`](#env) | `list` | | Set environment variables |
-u, --user Username or UID (format: <name|uid>[:<group|gid>]) | `--env-file` | `list` | | Read in a file of environment variables |
-w, --workdir Working directory inside the container | `-i`, `--interactive` | | | Keep STDIN open even if not attached |
``` | `--privileged` | | | Give extended privileges to the command |
| `-t`, `--tty` | | | Allocate a pseudo-TTY |
| `-u`, `--user` | `string` | | Username or UID (format: `<name\|uid>[:<group\|gid>]`) |
| [`-w`](#workdir), [`--workdir`](#workdir) | `string` | | Working directory inside the container |
<!---MARKER_GEN_END-->
## Description ## Description

27
docs/reference/commandline/export.md
View File

@ -1,23 +1,20 @@
---
title: "export"
description: "The export command description and usage"
keywords: "export, file, system, container"
---
# export # export
```markdown <!---MARKER_GEN_START-->
Usage: docker export [OPTIONS] CONTAINER
Export a container's filesystem as a tar archive Export a container's filesystem as a tar archive
Aliases: ### Aliases
docker container export, docker export
Options: `docker container export`, `docker export`
--help Print usage
-o, --output string Write to a file, instead of STDOUT ### Options
```
| Name | Type | Default | Description |
|:-----------------|:---------|:--------|:-----------------------------------|
| `-o`, `--output` | `string` | | Write to a file, instead of STDOUT |
<!---MARKER_GEN_END-->
## Description ## Description

32
docs/reference/commandline/history.md
View File

@ -1,27 +1,23 @@
---
title: "history"
description: "The history command description and usage"
keywords: "docker, image, history"
---
# history # history
```markdown <!---MARKER_GEN_START-->
Usage: docker history [OPTIONS] IMAGE
Show the history of an image Show the history of an image
Aliases: ### Aliases
docker image history, docker history
Options: `docker image history`, `docker history`
--format string Pretty-print images using a Go template
--help Print usage
-H, --human Print sizes and dates in human readable format (default true)
--no-trunc Don't truncate output
-q, --quiet Only show image IDs
```
### Options
| Name | Type | Default | Description |
|:----------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`--format`](#format) | `string` | | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
| `-H`, `--human` | | | Print sizes and dates in human readable format |
| `--no-trunc` | | | Don't truncate output |
| `-q`, `--quiet` | | | Only show image IDs |
<!---MARKER_GEN_END-->
## Examples ## Examples

45
docs/reference/commandline/image.md
View File

@ -1,37 +1,28 @@
---
title: "image"
description: "The image command description and usage"
keywords: "image"
---
# image # image
```markdown <!---MARKER_GEN_START-->
Usage: docker image COMMAND
Manage images Manage images
Options: ### Subcommands
--help Print usage
Commands: | Name | Description |
build Build an image from a Dockerfile |:------------------------------|:-------------------------------------------------------------------------|
history Show the history of an image | [`build`](image_build.md) | Build an image from a Dockerfile |
import Import the contents from a tarball to create a filesystem image | [`history`](image_history.md) | Show the history of an image |
inspect Display detailed information on one or more images | [`import`](image_import.md) | Import the contents from a tarball to create a filesystem image |
load Load an image from a tar archive or STDIN | [`inspect`](image_inspect.md) | Display detailed information on one or more images |
ls List images | [`load`](image_load.md) | Load an image from a tar archive or STDIN |
prune Remove unused images | [`ls`](image_ls.md) | List images |
pull Download an image from a registry | [`prune`](image_prune.md) | Remove unused images |
push Upload an image to a registry | [`pull`](image_pull.md) | Download an image from a registry |
rm Remove one or more images | [`push`](image_push.md) | Upload an image to a registry |
save Save one or more images to a tar archive (streamed to STDOUT by default) | [`rm`](image_rm.md) | Remove one or more images |
tag Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE | [`save`](image_save.md) | Save one or more images to a tar archive (streamed to STDOUT by default) |
| [`tag`](image_tag.md) | Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE |
Run 'docker image COMMAND --help' for more information on a command.
```
<!---MARKER_GEN_END-->
## Description ## Description

50
docs/reference/commandline/image_build.md Normal file
View File

@ -0,0 +1,50 @@
# image build
<!---MARKER_GEN_START-->
Build an image from a Dockerfile
### Aliases
`docker image build`, `docker build`, `docker buildx build`, `docker builder build`
### Options
| Name | Type | Default | Description |
|:--------------------------|:--------------|:----------|:------------------------------------------------------------------|
| `--add-host` | `list` | | Add a custom host-to-IP mapping (`host:ip`) |
| `--build-arg` | `list` | | Set build-time variables |
| `--cache-from` | `stringSlice` | | Images to consider as cache sources |
| `--cgroup-parent` | `string` | | Optional parent cgroup for the container |
| `--compress` | | | Compress the build context using gzip |
| `--cpu-period` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) period |
| `--cpu-quota` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) quota |
| `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) |
| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) |
| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) |
| `--disable-content-trust` | | | Skip image verification |
| `-f`, `--file` | `string` | | Name of the Dockerfile (Default is `PATH/Dockerfile`) |
| `--force-rm` | | | Always remove intermediate containers |
| `--iidfile` | `string` | | Write the image ID to the file |
| `--isolation` | `string` | | Container isolation technology |
| `--label` | `list` | | Set metadata for an image |
| `-m`, `--memory` | `bytes` | `0` | Memory limit |
| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: -1 to enable unlimited swap |
| `--network` | `string` | `default` | Set the networking mode for the RUN instructions during build |
| `--no-cache` | | | Do not use cache when building the image |
| `--platform` | `string` | | Set platform if server is multi-platform capable |
| `--pull` | | | Always attempt to pull a newer version of the image |
| `-q`, `--quiet` | | | Suppress the build output and print image ID on success |
| `--rm` | | | Remove intermediate containers after a successful build |
| `--security-opt` | `stringSlice` | | Security options |
| `--shm-size` | `bytes` | `0` | Size of `/dev/shm` |
| `--squash` | | | Squash newly built layers into a single new layer |
| `-t`, `--tag` | `list` | | Name and optionally a tag in the `name:tag` format |
| `--target` | `string` | | Set the target build stage to build. |
| `--ulimit` | `ulimit` | | Ulimit options |
<!---MARKER_GEN_END-->
## Description
See [docker build](build.md) for more information.

24
docs/reference/commandline/image_history.md Normal file
View File

@ -0,0 +1,24 @@
# image history
<!---MARKER_GEN_START-->
Show the history of an image
### Aliases
`docker image history`, `docker history`
### Options
| Name | Type | Default | Description |
|:----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--format` | `string` | | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
| `-H`, `--human` | | | Print sizes and dates in human readable format |
| `--no-trunc` | | | Don't truncate output |
| `-q`, `--quiet` | | | Only show image IDs |
<!---MARKER_GEN_END-->
## Description
See [docker history](history.md) for more information.

23
docs/reference/commandline/image_import.md Normal file
View File

@ -0,0 +1,23 @@
# image import
<!---MARKER_GEN_START-->
Import the contents from a tarball to create a filesystem image
### Aliases
`docker image import`, `docker import`
### Options
| Name | Type | Default | Description |
|:------------------|:---------|:--------|:--------------------------------------------------|
| `-c`, `--change` | `list` | | Apply Dockerfile instruction to the created image |
| `-m`, `--message` | `string` | | Set commit message for imported image |
| `--platform` | `string` | | Set platform if server is multi-platform capable |
<!---MARKER_GEN_END-->
## Description
See [docker import](import.md) for more information.

13
docs/reference/commandline/image_inspect.md Normal file
View File

@ -0,0 +1,13 @@
# image inspect
<!---MARKER_GEN_START-->
Display detailed information on one or more images
### Options
| Name | Type | Default | Description |
|:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `-f`, `--format` | `string` | | Format output using a custom template:<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
<!---MARKER_GEN_END-->

22
docs/reference/commandline/image_load.md Normal file
View File

@ -0,0 +1,22 @@
# image load
<!---MARKER_GEN_START-->
Load an image from a tar archive or STDIN
### Aliases
`docker image load`, `docker load`
### Options
| Name | Type | Default | Description |
|:----------------|:---------|:--------|:---------------------------------------------|
| `-i`, `--input` | `string` | | Read from tar archive file, instead of STDIN |
| `-q`, `--quiet` | | | Suppress the load output |
<!---MARKER_GEN_END-->
## Description
See [docker load](load.md) for more information.

26
docs/reference/commandline/image_ls.md Normal file
View File

@ -0,0 +1,26 @@
# image ls
<!---MARKER_GEN_START-->
List images
### Aliases
`docker image ls`, `docker image list`, `docker images`
### Options
| Name | Type | Default | Description |
|:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `-a`, `--all` | | | Show all images (default hides intermediate images) |
| `--digests` | | | Show digests |
| `-f`, `--filter` | `filter` | | Filter output based on conditions provided |
| `--format` | `string` | | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
| `--no-trunc` | | | Don't truncate output |
| `-q`, `--quiet` | | | Only show image IDs |
<!---MARKER_GEN_END-->
## Description
See [docker images](images.md) for more information.

26
docs/reference/commandline/image_prune.md
View File

@ -1,22 +1,18 @@
---
title: "image prune"
description: "Remove all stopped images"
keywords: "image, prune, delete, remove"
---
# image prune # image prune
```markdown <!---MARKER_GEN_START-->
Usage: docker image prune [OPTIONS]
Remove unused images Remove unused images
Options: ### Options
-a, --all Remove all unused images, not just dangling ones
--filter filter Provide filter values (e.g. 'until=<timestamp>') | Name | Type | Default | Description |
-f, --force Do not prompt for confirmation |:----------------------|:---------|:--------|:-------------------------------------------------|
--help Print usage | `-a`, `--all` | | | Remove all unused images, not just dangling ones |
``` | [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `until=<timestamp>`) |
| `-f`, `--force` | | | Do not prompt for confirmation |
<!---MARKER_GEN_END-->
## Description ## Description

24
docs/reference/commandline/image_pull.md Normal file
View File

@ -0,0 +1,24 @@
# image pull
<!---MARKER_GEN_START-->
Download an image from a registry
### Aliases
`docker image pull`, `docker pull`
### Options
| Name | Type | Default | Description |
|:--------------------------|:---------|:--------|:-------------------------------------------------|
| `-a`, `--all-tags` | | | Download all tagged images in the repository |
| `--disable-content-trust` | | | Skip image verification |
| `--platform` | `string` | | Set platform if server is multi-platform capable |
| `-q`, `--quiet` | | | Suppress verbose output |
<!---MARKER_GEN_END-->
## Description
See [docker pull](pull.md) for more information.

23
docs/reference/commandline/image_push.md Normal file
View File

@ -0,0 +1,23 @@
# image push
<!---MARKER_GEN_START-->
Upload an image to a registry
### Aliases
`docker image push`, `docker push`
### Options
| Name | Type | Default | Description |
|:--------------------------|:-----|:--------|:--------------------------------------------|
| `-a`, `--all-tags` | | | Push all tags of an image to the repository |
| `--disable-content-trust` | | | Skip image signing |
| `-q`, `--quiet` | | | Suppress verbose output |
<!---MARKER_GEN_END-->
## Description
See [docker push](push.md) for more information.

22
docs/reference/commandline/image_rm.md Normal file
View File

@ -0,0 +1,22 @@
# image rm
<!---MARKER_GEN_START-->
Remove one or more images
### Aliases
`docker image rm`, `docker image remove`, `docker rmi`
### Options
| Name | Type | Default | Description |
|:----------------|:-----|:--------|:-------------------------------|
| `-f`, `--force` | | | Force removal of the image |
| `--no-prune` | | | Do not delete untagged parents |
<!---MARKER_GEN_END-->
## Description
See [docker rmi](rmi.md) for more information.

21
docs/reference/commandline/image_save.md Normal file
View File

@ -0,0 +1,21 @@
# image save
<!---MARKER_GEN_START-->
Save one or more images to a tar archive (streamed to STDOUT by default)
### Aliases
`docker image save`, `docker save`
### Options
| Name | Type | Default | Description |
|:-----------------|:---------|:--------|:-----------------------------------|
| `-o`, `--output` | `string` | | Write to a file, instead of STDOUT |
<!---MARKER_GEN_END-->
## Description
See [docker save](save.md) for more information.

15
docs/reference/commandline/image_tag.md Normal file
View File

@ -0,0 +1,15 @@
# image tag
<!---MARKER_GEN_START-->
Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE
### Aliases
`docker image tag`, `docker tag`
<!---MARKER_GEN_END-->
## Description
See [docker tag](tag.md) for more information.

47
docs/reference/commandline/images.md
View File

@ -1,38 +1,25 @@
---
title: "images"
description: "The images command description and usage"
keywords: "list, docker, images"
---
# images # images
```markdown <!---MARKER_GEN_START-->
Usage: docker images [OPTIONS] [REPOSITORY[:TAG]]
List images List images
Aliases: ### Aliases
docker image ls, docker image list, docker images
Options: `docker image ls`, `docker image list`, `docker images`
-a, --all Show all images (default hides intermediate images)
--digests Show digests ### Options
-f, --filter value Filter output based on conditions provided (default [])
- dangling=(true|false) | Name | Type | Default | Description |
- label=<key> or label=<key>=<value> |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
- before=(<image-name>[:tag]|<image-id>|<image@digest>) | `-a`, `--all` | | | Show all images (default hides intermediate images) |
- since=(<image-name>[:tag]|<image-id>|<image@digest>) | [`--digests`](#digests) | | | Show digests |
- reference=(pattern of an image reference) | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Filter output based on conditions provided |
--format string Format output using a custom template: | [`--format`](#format) | `string` | | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
'table': Print output in table format with column headers (default) | [`--no-trunc`](#no-trunc) | | | Don't truncate output |
'table TEMPLATE': Print output in table format using the given Go template | `-q`, `--quiet` | | | Only show image IDs |
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates <!---MARKER_GEN_END-->
--help Print usage
--no-trunc Don't truncate output
-q, --quiet Only show image IDs
```
## Description ## Description

31
docs/reference/commandline/import.md
View File

@ -1,25 +1,22 @@
---
title: "import"
description: "The import command description and usage"
keywords: "import, file, system, container"
---
# import # import
```markdown <!---MARKER_GEN_START-->
Usage: docker import [OPTIONS] file|URL|- [REPOSITORY[:TAG]]
Import the contents from a tarball to create a filesystem image Import the contents from a tarball to create a filesystem image
Aliases: ### Aliases
docker image import, docker import
Options: `docker image import`, `docker import`
-c, --change value Apply Dockerfile instruction to the created image (default [])
--help Print usage ### Options
-m, --message string Set commit message for imported image
--platform string Set platform if server is multi-platform capable | Name | Type | Default | Description |
``` |:------------------|:---------|:--------|:--------------------------------------------------|
| `-c`, `--change` | `list` | | Apply Dockerfile instruction to the created image |
| `-m`, `--message` | `string` | | Set commit message for imported image |
| `--platform` | `string` | | Set platform if server is multi-platform capable |
<!---MARKER_GEN_END-->
## Description ## Description

27
docs/reference/commandline/info.md
View File

@ -1,23 +1,20 @@
---
title: "info"
description: "The info command description and usage"
keywords: "display, docker, information"
---
# info # info
```markdown <!---MARKER_GEN_START-->
Usage: docker info [OPTIONS]
Display system-wide information Display system-wide information
Aliases: ### Aliases
docker system info, docker info
Options: `docker system info`, `docker info`
-f, --format string Format the output using the given Go template
--help Print usage ### Options
```
| Name | Type | Default | Description |
|:---------------------------------------|:---------|:--------|:----------------------------------------------|
| [`-f`](#format), [`--format`](#format) | `string` | | Format the output using the given Go template |
<!---MARKER_GEN_END-->
## Description ## Description

27
docs/reference/commandline/inspect.md
View File

@ -1,23 +1,18 @@
---
title: "inspect"
description: "The inspect command description and usage"
keywords: "inspect, container, json"
---
# inspect # inspect
```markdown <!---MARKER_GEN_START-->
Usage: docker inspect [OPTIONS] NAME|ID [NAME|ID...] Return low-level information on Docker objects
Return low-level information on Docker object(s) (e.g. container, image, volume, ### Options
network, node, service, or task) identified by name or ID
Options: | Name | Type | Default | Description |
-f, --format Format the output using the given Go template |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
--help Print usage | [`-f`](#format), [`--format`](#format) | `string` | | Format output using a custom template:<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
-s, --size Display total file sizes if the type is container | [`-s`](#size), [`--size`](#size) | | | Display total file sizes if the type is container |
--type Return JSON for specified type | [`--type`](#type) | `string` | | Return JSON for specified type |
```
<!---MARKER_GEN_END-->
## Description ## Description

27
docs/reference/commandline/kill.md
View File

@ -1,23 +1,20 @@
---
title: "kill"
description: "The kill command description and usage"
keywords: "container, kill, signal"
---
# kill # kill
```markdown <!---MARKER_GEN_START-->
Usage: docker kill [OPTIONS] CONTAINER [CONTAINER...]
Kill one or more running containers Kill one or more running containers
Aliases: ### Aliases
docker container kill, docker kill
Options: `docker container kill`, `docker kill`
--help Print usage
-s, --signal string Signal to send to the container ### Options
```
| Name | Type | Default | Description |
|:---------------------------------------|:---------|:--------|:--------------------------------|
| [`-s`](#signal), [`--signal`](#signal) | `string` | | Signal to send to the container |
<!---MARKER_GEN_END-->
## Description ## Description

31
docs/reference/commandline/load.md
View File

@ -1,26 +1,21 @@
---
title: "load"
description: "The load command description and usage"
keywords: "stdin, tarred, repository"
---
# load # load
```markdown <!---MARKER_GEN_START-->
Usage: docker load [OPTIONS] Load an image from a tar archive or STDIN
Load an image or repository from a tar archive (even if compressed with gzip, ### Aliases
bzip2, or xz) from a file or STDIN.
Aliases: `docker image load`, `docker load`
docker image load, docker load
Options: ### Options
--help Print usage
-i, --input string Read from tar archive file, instead of STDIN. | Name | Type | Default | Description |
The tarball may be compressed with gzip, bzip, or xz |:------------------------------------|:---------|:--------|:---------------------------------------------|
-q, --quiet Suppress the load output but still outputs the imported images | [`-i`](#input), [`--input`](#input) | `string` | | Read from tar archive file, instead of STDIN |
``` | `-q`, `--quiet` | | | Suppress the load output |
<!---MARKER_GEN_END-->
## Description ## Description

26
docs/reference/commandline/login.md
View File

@ -1,23 +1,19 @@
---
title: "login"
description: "The login command description and usage"
keywords: "registry, login, image"
---
# login # login
```markdown <!---MARKER_GEN_START-->
Usage: docker login [OPTIONS] [SERVER]
Log in to a registry. Log in to a registry.
If no server is specified, the default is defined by the daemon. If no server is specified, the default is defined by the daemon.
Options: ### Options
--help Print usage
-p, --password string Password | Name | Type | Default | Description |
--password-stdin Read password from stdin |:--------------------------------------|:---------|:--------|:-----------------------------|
-u, --username string Username | `-p`, `--password` | `string` | | Password |
``` | [`--password-stdin`](#password-stdin) | | | Take the password from stdin |
| `-u`, `--username` | `string` | | Username |
<!---MARKER_GEN_END-->
## Description ## Description

15
docs/reference/commandline/logout.md
View File

@ -1,20 +1,11 @@
---
title: "logout"
description: "The logout command description and usage"
keywords: "logout, docker, registry"
---
# logout # logout
```markdown <!---MARKER_GEN_START-->
Usage: docker logout [SERVER]
Log out from a registry. Log out from a registry.
If no server is specified, the default is defined by the daemon. If no server is specified, the default is defined by the daemon.
Options:
--help Print usage <!---MARKER_GEN_END-->
```
## Examples ## Examples

37
docs/reference/commandline/logs.md
View File

@ -1,28 +1,25 @@
---
title: "logs"
description: "The logs command description and usage"
keywords: "logs, retrieve, docker"
---
# logs # logs
```markdown <!---MARKER_GEN_START-->
Usage: docker logs [OPTIONS] CONTAINER
Fetch the logs of a container Fetch the logs of a container
Aliases: ### Aliases
docker container logs, docker logs
Options: `docker container logs`, `docker logs`
--details Show extra details provided to logs
-f, --follow Follow log output ### Options
--help Print usage
--since string Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) | Name | Type | Default | Description |
--until string Show logs before timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes) |:---------------------|:---------|:--------|:---------------------------------------------------------------------------------------------------|
-n, --tail string Number of lines to show from the end of the logs (default "all") | `--details` | | | Show extra details provided to logs |
-t, --timestamps Show timestamps | `-f`, `--follow` | | | Follow log output |
``` | `--since` | `string` | | Show logs since timestamp (e.g. `2013-01-02T13:23:37Z`) or relative (e.g. `42m` for 42 minutes) |
| `-n`, `--tail` | `string` | `all` | Number of lines to show from the end of the logs |
| `-t`, `--timestamps` | | | Show timestamps |
| [`--until`](#until) | `string` | | Show logs before a timestamp (e.g. `2013-01-02T13:23:37Z`) or relative (e.g. `42m` for 42 minutes) |
<!---MARKER_GEN_END-->
## Description ## Description

40
docs/reference/commandline/manifest.md
View File

@ -1,24 +1,32 @@
--- # manifest
title: "manifest"
description: "The manifest command description and usage"
keywords: "docker, manifest"
---
```markdown <!---MARKER_GEN_START-->
Usage: docker manifest COMMAND
Manage Docker image manifests and manifest lists The **docker manifest** command has subcommands for managing image manifests and
manifest lists. A manifest list allows you to use one name to refer to the same image
built for multiple architectures.
Options: To see help for a subcommand, use:
--help Print usage
Commands: docker manifest CMD --help
annotate Add additional information to a local image manifest
create Create a local manifest list for annotating and pushing to a registry
inspect Display an image manifest, or manifest list
push Push a manifest list to a repository
``` For full details on using docker manifest lists, see the registry v2 specification.
### Subcommands
| Name | Description |
|:-----------------------------------|:----------------------------------------------------------------------|
| [`annotate`](manifest_annotate.md) | Add additional information to a local image manifest |
| [`create`](manifest_create.md) | Create a local manifest list for annotating and pushing to a registry |
| [`inspect`](manifest_inspect.md) | Display an image manifest, or manifest list |
| [`push`](manifest_push.md) | Push a manifest list to a repository |
| [`rm`](manifest_rm.md) | Delete one or more manifest lists from local storage |
<!---MARKER_GEN_END-->
## Description ## Description

18
docs/reference/commandline/manifest_annotate.md Normal file
View File

@ -0,0 +1,18 @@
# manifest annotate
<!---MARKER_GEN_START-->
Add additional information to a local image manifest
### Options
| Name | Type | Default | Description |
|:----------------|:--------------|:--------|:-----------------------------|
| `--arch` | `string` | | Set architecture |
| `--os` | `string` | | Set operating system |
| `--os-features` | `stringSlice` | | Set operating system feature |
| `--os-version` | `string` | | Set operating system version |
| `--variant` | `string` | | Set architecture variant |
<!---MARKER_GEN_END-->

15
docs/reference/commandline/manifest_create.md Normal file
View File

@ -0,0 +1,15 @@
# manifest create
<!---MARKER_GEN_START-->
Create a local manifest list for annotating and pushing to a registry
### Options
| Name | Type | Default | Description |
|:----------------|:-----|:--------|:----------------------------------------------|
| `-a`, `--amend` | | | Amend an existing manifest list |
| `--insecure` | | | Allow communication with an insecure registry |
<!---MARKER_GEN_END-->

15
docs/reference/commandline/manifest_inspect.md Normal file
View File

@ -0,0 +1,15 @@
# manifest inspect
<!---MARKER_GEN_START-->
Display an image manifest, or manifest list
### Options
| Name | Type | Default | Description |
|:------------------|:-----|:--------|:-----------------------------------------------------|
| `--insecure` | | | Allow communication with an insecure registry |
| `-v`, `--verbose` | | | Output additional info including layers and platform |
<!---MARKER_GEN_END-->

15
docs/reference/commandline/manifest_push.md Normal file
View File

@ -0,0 +1,15 @@
# manifest push
<!---MARKER_GEN_START-->
Push a manifest list to a repository
### Options
| Name | Type | Default | Description |
|:----------------|:-----|:--------|:------------------------------------------|
| `--insecure` | | | Allow push to an insecure registry |
| `-p`, `--purge` | | | Remove the local manifest list after push |
<!---MARKER_GEN_END-->

8
docs/reference/commandline/manifest_rm.md Normal file
View File

@ -0,0 +1,8 @@
# manifest rm
<!---MARKER_GEN_START-->
Delete one or more manifest lists from local storage
<!---MARKER_GEN_END-->

45
docs/reference/commandline/network.md
View File

@ -1,42 +1,25 @@
---
title: "network"
description: "The network command description and usage"
keywords: "network"
---
# network # network
```markdown <!---MARKER_GEN_START-->
Usage: docker network COMMAND
Manage networks Manage networks
Options: ### Subcommands
--help Print usage
Commands: | Name | Description |
connect Connect a container to a network |:--------------------------------------|:-----------------------------------------------------|
create Create a network | [`connect`](network_connect.md) | Connect a container to a network |
disconnect Disconnect a container from a network | [`create`](network_create.md) | Create a network |
inspect Display detailed information on one or more networks | [`disconnect`](network_disconnect.md) | Disconnect a container from a network |
ls List networks | [`inspect`](network_inspect.md) | Display detailed information on one or more networks |
prune Remove all unused networks | [`ls`](network_ls.md) | List networks |
rm Remove one or more networks | [`prune`](network_prune.md) | Remove all unused networks |
| [`rm`](network_rm.md) | Remove one or more networks |
Run 'docker network COMMAND --help' for more information on a command.
```
<!---MARKER_GEN_END-->
## Description ## Description
Manage networks. You can use subcommands to create, inspect, list, remove, Manage networks. You can use subcommands to create, inspect, list, remove,
prune, connect, and disconnect networks. prune, connect, and disconnect networks.
## Related commands
* [network create](network_create.md)
* [network inspect](network_inspect.md)
* [network list](network_ls.md)
* [network rm](network_rm.md)
* [network prune](network_prune.md)
* [network connect](network_connect.md)
* [network disconnect](network_disconnect.md)

31
docs/reference/commandline/network_connect.md
View File

@ -1,24 +1,21 @@
---
title: "network connect"
description: "The network connect command description and usage"
keywords: "network, connect, user-defined"
---
# network connect # network connect
```markdown <!---MARKER_GEN_START-->
Usage: docker network connect [OPTIONS] NETWORK CONTAINER
Connect a container to a network Connect a container to a network
Options: ### Options
--alias value Add network-scoped alias for the container (default [])
--help Print usage | Name | Type | Default | Description |
--ip string IPv4 address (e.g., 172.30.100.104) |:--------------------|:--------------|:--------|:-------------------------------------------|
--ip6 string IPv6 address (e.g., 2001:db8::33) | [`--alias`](#alias) | `stringSlice` | | Add network-scoped alias for the container |
--link value Add link to another container (default []) | `--driver-opt` | `stringSlice` | | driver options for the network |
--link-local-ip value Add a link-local address for the container (default []) | [`--ip`](#ip) | `string` | | IPv4 address (e.g., `172.30.100.104`) |
``` | `--ip6` | `string` | | IPv6 address (e.g., `2001:db8::33`) |
| [`--link`](#link) | `list` | | Add link to another container |
| `--link-local-ip` | `stringSlice` | | Add a link-local address for the container |
<!---MARKER_GEN_END-->
## Description ## Description

54
docs/reference/commandline/network_create.md
View File

@ -1,37 +1,31 @@
---
title: "network create"
description: "The network create command description and usage"
keywords: "network, create"
---
# network create # network create
```markdown <!---MARKER_GEN_START-->
Usage: docker network create [OPTIONS] NETWORK
Create a network Create a network
Options: ### Options
--attachable Enable manual container attachment
--ingress Specify the network provides the routing-mesh | Name | Type | Default | Description |
--aux-address value Auxiliary IPv4 or IPv6 addresses used by Network |:--------------------------|:--------------|:----------|:--------------------------------------------------------|
driver (default map[]) | `--attachable` | | | Enable manual container attachment |
-d, --driver string Driver to manage the Network (default "bridge") | `--aux-address` | `map` | `map[]` | Auxiliary IPv4 or IPv6 addresses used by Network driver |
--gateway value IPv4 or IPv6 Gateway for the master subnet (default []) | `--config-from` | `string` | | The network from which to copy the configuration |
--help Print usage | `--config-only` | | | Create a configuration only network |
--internal Restrict external access to the network | `-d`, `--driver` | `string` | `bridge` | Driver to manage the Network |
--ip-range value Allocate container ip from a sub-range (default []) | `--gateway` | `stringSlice` | | IPv4 or IPv6 Gateway for the master subnet |
--ipam-driver string IP Address Management Driver (default "default") | [`--ingress`](#ingress) | | | Create swarm routing-mesh network |
--ipam-opt value Set IPAM driver specific options (default map[]) | [`--internal`](#internal) | | | Restrict external access to the network |
--ipv6 Enable IPv6 networking | `--ip-range` | `stringSlice` | | Allocate container ip from a sub-range |
--label value Set metadata on a network (default []) | `--ipam-driver` | `string` | `default` | IP Address Management Driver |
-o, --opt value Set driver specific options (default map[]) | `--ipam-opt` | `map` | `map[]` | Set IPAM driver specific options |
--subnet value Subnet in CIDR format that represents a | `--ipv6` | | | Enable IPv6 networking |
network segment (default []) | `--label` | `list` | | Set metadata on a network |
--scope value Promote a network to swarm scope (value = [ local | swarm ]) | `-o`, `--opt` | `map` | `map[]` | Set driver specific options |
--config-only Creates a configuration only network | `--scope` | `string` | | Control the network's scope |
--config-from The name of the network from which to copy the configuration | `--subnet` | `stringSlice` | | Subnet in CIDR format that represents a network segment |
```
<!---MARKER_GEN_END-->
## Description ## Description

22
docs/reference/commandline/network_disconnect.md
View File

@ -1,20 +1,16 @@
---
title: "network disconnect"
description: "The network disconnect command description and usage"
keywords: "network, disconnect, user-defined"
---
# network disconnect # network disconnect
```markdown <!---MARKER_GEN_START-->
Usage: docker network disconnect [OPTIONS] NETWORK CONTAINER
Disconnect a container from a network Disconnect a container from a network
Options: ### Options
-f, --force Force the container to disconnect from a network
--help Print usage | Name | Type | Default | Description |
``` |:----------------|:-----|:--------|:-------------------------------------------------|
| `-f`, `--force` | | | Force the container to disconnect from a network |
<!---MARKER_GEN_END-->
## Description ## Description

27
docs/reference/commandline/network_inspect.md
View File

@ -1,24 +1,17 @@
---
title: "network inspect"
description: "The network inspect command description and usage"
keywords: "network, inspect, user-defined"
---
# network inspect # network inspect
```markdown <!---MARKER_GEN_START-->
Usage: docker network inspect [OPTIONS] NETWORK [NETWORK...]
Display detailed information on one or more networks Display detailed information on one or more networks
Options: ### Options
-f, --format string Format output using a custom template:
'json': Print in JSON format | Name | Type | Default | Description |
'TEMPLATE': Print output using the given Go template. |:------------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | `-f`, `--format` | `string` | | Format output using a custom template:<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
-v, --verbose Verbose output for diagnostics | [`-v`](#verbose), [`--verbose`](#verbose) | | | Verbose output for diagnostics |
--help Print usage
```
<!---MARKER_GEN_END-->
## Description ## Description

40
docs/reference/commandline/network_ls.md
View File

@ -1,31 +1,23 @@
--- # network ls
title: "network ls"
description: "The network ls command description and usage"
keywords: "network, list, user-defined"
---
# docker network ls
```markdown
Usage: docker network ls [OPTIONS]
<!---MARKER_GEN_START-->
List networks List networks
Aliases: ### Aliases
ls, list
Options: `docker network ls`, `docker network list`
-f, --filter filter Provide filter values (e.g. 'driver=bridge')
--format string Format output using a custom template: ### Options
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template | Name | Type | Default | Description |
'json': Print in JSON format |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
'TEMPLATE': Print output using the given Go template. | [`-f`](#filter), [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `driver=bridge`) |
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | [`--format`](#format) | `string` | | Format output using a custom template:<br>'table': Print output in table format with column headers (default)<br>'table TEMPLATE': Print output in table format using the given Go template<br>'json': Print in JSON format<br>'TEMPLATE': Print output using the given Go template.<br>Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
--help Print usage | `--no-trunc` | | | Do not truncate the output |
--no-trunc Do not truncate the output | `-q`, `--quiet` | | | Only display network IDs |
-q, --quiet Only display network IDs
```
<!---MARKER_GEN_END-->
## Description ## Description

24
docs/reference/commandline/network_prune.md
View File

@ -1,21 +1,17 @@
---
title: "network prune"
description: "Remove unused networks"
keywords: "network, prune, delete"
---
# network prune # network prune
```markdown <!---MARKER_GEN_START-->
Usage: docker network prune [OPTIONS]
Remove all unused networks Remove all unused networks
Options: ### Options
--filter filter Provide filter values (e.g. 'until=<timestamp>')
-f, --force Do not prompt for confirmation | Name | Type | Default | Description |
--help Print usage |:----------------------|:---------|:--------|:-------------------------------------------------|
``` | [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `until=<timestamp>`) |
| `-f`, `--force` | | | Do not prompt for confirmation |
<!---MARKER_GEN_END-->
## Description ## Description

26
docs/reference/commandline/network_rm.md
View File

@ -1,22 +1,20 @@
---
title: "network rm"
description: "the network rm command description and usage"
keywords: "network, rm, user-defined"
---
# network rm # network rm
```markdown <!---MARKER_GEN_START-->
Usage: docker network rm NETWORK [NETWORK...]
Remove one or more networks Remove one or more networks
Aliases: ### Aliases
rm, remove
Options: `docker network rm`, `docker network remove`
-f, --force Do not error if the network does not exist
``` ### Options
| Name | Type | Default | Description |
|:----------------|:-----|:--------|:-------------------------------------------|
| `-f`, `--force` | | | Do not error if the network does not exist |
<!---MARKER_GEN_END-->
## Description ## Description

35
docs/reference/commandline/node.md
View File

@ -1,31 +1,24 @@
---
title: "node"
description: "The node command description and usage"
keywords: "node"
---
# node # node
```markdown <!---MARKER_GEN_START-->
Usage: docker node COMMAND
Manage Swarm nodes Manage Swarm nodes
Options: ### Subcommands
--help Print usage
Commands: | Name | Description |
demote Demote one or more nodes from manager in the swarm |:-----------------------------|:------------------------------------------------------------------|
inspect Display detailed information on one or more nodes | [`demote`](node_demote.md) | Demote one or more nodes from manager in the swarm |
ls List nodes in the swarm | [`inspect`](node_inspect.md) | Display detailed information on one or more nodes |
promote Promote one or more nodes to manager in the swarm | [`ls`](node_ls.md) | List nodes in the swarm |
ps List tasks running on one or more nodes, defaults to current node | [`promote`](node_promote.md) | Promote one or more nodes to manager in the swarm |
rm Remove one or more nodes from the swarm | [`ps`](node_ps.md) | List tasks running on one or more nodes, defaults to current node |
update Update a node | [`rm`](node_rm.md) | Remove one or more nodes from the swarm |
| [`update`](node_update.md) | Update a node |
Run 'docker node COMMAND --help' for more information on a command.
```
<!---MARKER_GEN_END-->
## Description ## Description

14
docs/reference/commandline/node_demote.md
View File

@ -1,20 +1,10 @@
---
title: "node demote"
description: "The node demote command description and usage"
keywords: "node, demote"
---
# node demote # node demote
```markdown <!---MARKER_GEN_START-->
Usage: docker node demote NODE [NODE...]
Demote one or more nodes from manager in the swarm Demote one or more nodes from manager in the swarm
Options:
--help Print usage
``` <!---MARKER_GEN_END-->
## Description ## Description

Some files were not shown because too many files have changed in this diff Show More