diff --git a/docs/reference/commandline/attach.md b/docs/reference/commandline/attach.md new file mode 100644 index 0000000000..ffbf58a81d --- /dev/null +++ b/docs/reference/commandline/attach.md @@ -0,0 +1,20 @@ +# docker attach + + +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 | + + + + diff --git a/docs/reference/commandline/build.md b/docs/reference/commandline/build.md new file mode 100644 index 0000000000..40983fb0e7 --- /dev/null +++ b/docs/reference/commandline/build.md @@ -0,0 +1,47 @@ +# docker build + + +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` | | Set the parent cgroup for the `RUN` instructions during build | +| `--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 | + + + + diff --git a/docs/reference/commandline/commit.md b/docs/reference/commandline/commit.md new file mode 100644 index 0000000000..281d96e488 --- /dev/null +++ b/docs/reference/commandline/commit.md @@ -0,0 +1,21 @@ +# docker commit + + +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 `) | +| `-c`, `--change` | `list` | | Apply Dockerfile instruction to the created image | +| `-m`, `--message` | `string` | | Commit message | +| `-p`, `--pause` | | | Pause container during commit | + + + + diff --git a/docs/reference/commandline/cp.md b/docs/reference/commandline/cp.md new file mode 100644 index 0000000000..41c9529f9f --- /dev/null +++ b/docs/reference/commandline/cp.md @@ -0,0 +1,25 @@ +# docker cp + + +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 | + + + + diff --git a/docs/reference/commandline/create.md b/docs/reference/commandline/create.md new file mode 100644 index 0000000000..ce34f5b12c --- /dev/null +++ b/docs/reference/commandline/create.md @@ -0,0 +1,117 @@ +# docker create + + +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) | +| `--annotation` | `map` | `map[]` | Add an annotation to the container (passed through to the OCI runtime) | +| `-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)
'host': Run the container in the Docker host's cgroup namespace
'private': Run the container in its own private cgroup namespace
'': Use the cgroup namespace as configured by the
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-interval` | `duration` | `0s` | Time between running the check during the start period (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) | +| `--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: [:]) | +| `--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 | + + + + diff --git a/docs/reference/commandline/diff.md b/docs/reference/commandline/diff.md new file mode 100644 index 0000000000..36185898a6 --- /dev/null +++ b/docs/reference/commandline/diff.md @@ -0,0 +1,12 @@ +# docker diff + + +Inspect changes to files or directories on a container's filesystem + +### Aliases + +`docker container diff`, `docker diff` + + + + diff --git a/docs/reference/commandline/events.md b/docs/reference/commandline/events.md new file mode 100644 index 0000000000..a5012cd6b7 --- /dev/null +++ b/docs/reference/commandline/events.md @@ -0,0 +1,21 @@ +# docker events + + +Get real time events from the server + +### Aliases + +`docker system events`, `docker events` + +### Options + +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `-f`, `--filter` | `filter` | | Filter output based on conditions provided | +| `--format` | `string` | | Format output using a custom template:
'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 | +| `--since` | `string` | | Show all events created since timestamp | +| `--until` | `string` | | Stream events until this timestamp | + + + + diff --git a/docs/reference/commandline/exec.md b/docs/reference/commandline/exec.md new file mode 100644 index 0000000000..67bf20a137 --- /dev/null +++ b/docs/reference/commandline/exec.md @@ -0,0 +1,26 @@ +# docker exec + + +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: `[:]`) | +| `-w`, `--workdir` | `string` | | Working directory inside the container | + + + + diff --git a/docs/reference/commandline/export.md b/docs/reference/commandline/export.md new file mode 100644 index 0000000000..558f2b87e9 --- /dev/null +++ b/docs/reference/commandline/export.md @@ -0,0 +1,18 @@ +# docker export + + +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 | + + + + diff --git a/docs/reference/commandline/history.md b/docs/reference/commandline/history.md new file mode 100644 index 0000000000..7ffc950335 --- /dev/null +++ b/docs/reference/commandline/history.md @@ -0,0 +1,21 @@ +# docker history + + +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:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'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 | +| `-H`, `--human` | | | Print sizes and dates in human readable format | +| `--no-trunc` | | | Don't truncate output | +| `-q`, `--quiet` | | | Only show image IDs | + + + + diff --git a/docs/reference/commandline/images.md b/docs/reference/commandline/images.md new file mode 100644 index 0000000000..1fa9f6a319 --- /dev/null +++ b/docs/reference/commandline/images.md @@ -0,0 +1,23 @@ +# docker images + + +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:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'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 | +| `--no-trunc` | | | Don't truncate output | +| `-q`, `--quiet` | | | Only show image IDs | + + + + diff --git a/docs/reference/commandline/import.md b/docs/reference/commandline/import.md new file mode 100644 index 0000000000..1b3eec0224 --- /dev/null +++ b/docs/reference/commandline/import.md @@ -0,0 +1,20 @@ +# docker import + + +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 | + + + + diff --git a/docs/reference/commandline/info.md b/docs/reference/commandline/info.md new file mode 100644 index 0000000000..c155096a91 --- /dev/null +++ b/docs/reference/commandline/info.md @@ -0,0 +1,18 @@ +# docker info + + +Display system-wide information + +### Aliases + +`docker system info`, `docker info` + +### Options + +| Name | Type | Default | Description | +|:-----------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `-f`, `--format` | `string` | | Format output using a custom template:
'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 | + + + + diff --git a/docs/reference/commandline/kill.md b/docs/reference/commandline/kill.md new file mode 100644 index 0000000000..27f8974973 --- /dev/null +++ b/docs/reference/commandline/kill.md @@ -0,0 +1,18 @@ +# docker kill + + +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 | + + + + diff --git a/docs/reference/commandline/load.md b/docs/reference/commandline/load.md new file mode 100644 index 0000000000..778d263077 --- /dev/null +++ b/docs/reference/commandline/load.md @@ -0,0 +1,19 @@ +# docker load + + +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 | + + + + diff --git a/docs/reference/commandline/logs.md b/docs/reference/commandline/logs.md new file mode 100644 index 0000000000..840f0562a5 --- /dev/null +++ b/docs/reference/commandline/logs.md @@ -0,0 +1,23 @@ +# docker logs + + +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) | + + + + diff --git a/docs/reference/commandline/pause.md b/docs/reference/commandline/pause.md new file mode 100644 index 0000000000..0840d7fb81 --- /dev/null +++ b/docs/reference/commandline/pause.md @@ -0,0 +1,12 @@ +# docker pause + + +Pause all processes within one or more containers + +### Aliases + +`docker container pause`, `docker pause` + + + + diff --git a/docs/reference/commandline/port.md b/docs/reference/commandline/port.md new file mode 100644 index 0000000000..4ac285e00d --- /dev/null +++ b/docs/reference/commandline/port.md @@ -0,0 +1,12 @@ +# docker port + + +List port mappings or a specific mapping for the container + +### Aliases + +`docker container port`, `docker port` + + + + diff --git a/docs/reference/commandline/ps.md b/docs/reference/commandline/ps.md new file mode 100644 index 0000000000..57fcc6199a --- /dev/null +++ b/docs/reference/commandline/ps.md @@ -0,0 +1,25 @@ +# docker ps + + +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:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'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 | +| `-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 | + + + + diff --git a/docs/reference/commandline/pull.md b/docs/reference/commandline/pull.md new file mode 100644 index 0000000000..9ea408dbff --- /dev/null +++ b/docs/reference/commandline/pull.md @@ -0,0 +1,21 @@ +# docker pull + + +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 | + + + + diff --git a/docs/reference/commandline/push.md b/docs/reference/commandline/push.md new file mode 100644 index 0000000000..16e9c19246 --- /dev/null +++ b/docs/reference/commandline/push.md @@ -0,0 +1,20 @@ +# docker push + + +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 | + + + + diff --git a/docs/reference/commandline/rename.md b/docs/reference/commandline/rename.md new file mode 100644 index 0000000000..1e813055ee --- /dev/null +++ b/docs/reference/commandline/rename.md @@ -0,0 +1,12 @@ +# docker rename + + +Rename a container + +### Aliases + +`docker container rename`, `docker rename` + + + + diff --git a/docs/reference/commandline/restart.md b/docs/reference/commandline/restart.md new file mode 100644 index 0000000000..2c6681cd2a --- /dev/null +++ b/docs/reference/commandline/restart.md @@ -0,0 +1,19 @@ +# docker restart + + +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 | + + + + diff --git a/docs/reference/commandline/rm.md b/docs/reference/commandline/rm.md new file mode 100644 index 0000000000..0c0bf05820 --- /dev/null +++ b/docs/reference/commandline/rm.md @@ -0,0 +1,20 @@ +# docker rm + + +Remove one or more containers + +### Aliases + +`docker container rm`, `docker container remove`, `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 | + + + + diff --git a/docs/reference/commandline/rmi.md b/docs/reference/commandline/rmi.md new file mode 100644 index 0000000000..574fa03114 --- /dev/null +++ b/docs/reference/commandline/rmi.md @@ -0,0 +1,19 @@ +# docker rmi + + +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 | + + + + diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md new file mode 100644 index 0000000000..f4a72ba7bf --- /dev/null +++ b/docs/reference/commandline/run.md @@ -0,0 +1,120 @@ +# docker run + + +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) | +| `--annotation` | `map` | `map[]` | Add an annotation to the container (passed through to the OCI runtime) | +| `-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)
'host': Run the container in the Docker host's cgroup namespace
'private': Run the container in its own private cgroup namespace
'': Use the cgroup namespace as configured by the
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-interval` | `duration` | `0s` | Time between running the check during the start period (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) | +| `--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: [:]) | +| `--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 | + + + + diff --git a/docs/reference/commandline/save.md b/docs/reference/commandline/save.md new file mode 100644 index 0000000000..1c9f9c53db --- /dev/null +++ b/docs/reference/commandline/save.md @@ -0,0 +1,18 @@ +# docker save + + +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 | + + + + diff --git a/docs/reference/commandline/start.md b/docs/reference/commandline/start.md new file mode 100644 index 0000000000..d4ea72a7c1 --- /dev/null +++ b/docs/reference/commandline/start.md @@ -0,0 +1,22 @@ +# docker 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 | + + + + diff --git a/docs/reference/commandline/stats.md b/docs/reference/commandline/stats.md new file mode 100644 index 0000000000..f1fec24e49 --- /dev/null +++ b/docs/reference/commandline/stats.md @@ -0,0 +1,21 @@ +# docker stats + + +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:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'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 | +| `--no-stream` | | | Disable streaming stats and only pull the first result | +| `--no-trunc` | | | Do not truncate output | + + + + diff --git a/docs/reference/commandline/stop.md b/docs/reference/commandline/stop.md new file mode 100644 index 0000000000..16934813c5 --- /dev/null +++ b/docs/reference/commandline/stop.md @@ -0,0 +1,19 @@ +# docker stop + + +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 | + + + + diff --git a/docs/reference/commandline/tag.md b/docs/reference/commandline/tag.md new file mode 100644 index 0000000000..4e980570a1 --- /dev/null +++ b/docs/reference/commandline/tag.md @@ -0,0 +1,12 @@ +# docker tag + + +Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE + +### Aliases + +`docker image tag`, `docker tag` + + + + diff --git a/docs/reference/commandline/top.md b/docs/reference/commandline/top.md new file mode 100644 index 0000000000..b35f492031 --- /dev/null +++ b/docs/reference/commandline/top.md @@ -0,0 +1,12 @@ +# docker top + + +Display the running processes of a container + +### Aliases + +`docker container top`, `docker top` + + + + diff --git a/docs/reference/commandline/unpause.md b/docs/reference/commandline/unpause.md new file mode 100644 index 0000000000..f8d69ef879 --- /dev/null +++ b/docs/reference/commandline/unpause.md @@ -0,0 +1,12 @@ +# docker unpause + + +Unpause all processes within one or more containers + +### Aliases + +`docker container unpause`, `docker unpause` + + + + diff --git a/docs/reference/commandline/update.md b/docs/reference/commandline/update.md new file mode 100644 index 0000000000..60557bdbfb --- /dev/null +++ b/docs/reference/commandline/update.md @@ -0,0 +1,31 @@ +# docker update + + +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 | + + + + diff --git a/docs/reference/commandline/wait.md b/docs/reference/commandline/wait.md new file mode 100644 index 0000000000..79dbf1507f --- /dev/null +++ b/docs/reference/commandline/wait.md @@ -0,0 +1,12 @@ +# docker wait + + +Block until one or more containers stop, then print their exit codes + +### Aliases + +`docker container wait`, `docker wait` + + + +