Skip to content

Commit 9610e21

Browse files
dvdksndvdksn
committed
dosc: move base command to docker.md
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
1 parent aff4649 commit 9610e21

3 files changed

Lines changed: 88 additions & 107 deletions

File tree

‎docs/reference/commandline/cli.md‎

Lines changed: 2 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -10,104 +10,8 @@ aliases:
1010
- /engine/reference/commandline/engine_update/
1111
---
1212

13-
<!-- This file is maintained within the docker/cli GitHub
14-
repository at https://github.com/docker/cli/. Make all
15-
pull requests against that repo. If you see this file in
16-
another repository, consider it read-only there, as it will
17-
periodically be overwritten by the definitive file. Pull
18-
requests which include edits to this file in other repositories
19-
will be rejected.
20-
-->
21-
22-
# docker
23-
24-
To list available commands, either run `docker` with no parameters
25-
or execute `docker help`:
26-
27-
<!---MARKER_GEN_START-->
28-
The base command for the Docker CLI.
29-
30-
### Subcommands
31-
32-
| Name | Description |
33-
| :-------------------------------- | :---------------------------------------------------------------------------- |
34-
| [`attach`](container_attach.md) | Attach local standard input, output, and error streams to a running container |
35-
| [`build`](image_build.md) | Build an image from a Dockerfile |
36-
| [`builder`](builder.md) | Manage builds |
37-
| [`checkpoint`](checkpoint.md) | Manage checkpoints |
38-
| [`commit`](container_commit.md) | Create a new image from a container's changes |
39-
| [`config`](config.md) | Manage Swarm configs |
40-
| [`container`](container.md) | Manage containers |
41-
| [`context`](context.md) | Manage contexts |
42-
| [`cp`](container_cp.md) | Copy files/folders between a container and the local filesystem |
43-
| [`create`](container_create.md) | Create a new container |
44-
| [`diff`](container_diff.md) | Inspect changes to files or directories on a container's filesystem |
45-
| [`events`](system_events.md) | Get real time events from the server |
46-
| [`exec`](container_exec.md) | Execute a command in a running container |
47-
| [`export`](container_export.md) | Export a container's filesystem as a tar archive |
48-
| [`history`](image_history.md) | Show the history of an image |
49-
| [`image`](image.md) | Manage images |
50-
| [`images`](image_ls.md) | List images |
51-
| [`import`](image_import.md) | Import the contents from a tarball to create a filesystem image |
52-
| [`info`](system_info.md) | Display system-wide information |
53-
| [`inspect`](inspect.md) | Return low-level information on Docker objects |
54-
| [`kill`](container_kill.md) | Kill one or more running containers |
55-
| [`load`](image_load.md) | Load an image from a tar archive or STDIN |
56-
| [`login`](login.md) | Log in to a registry |
57-
| [`logout`](logout.md) | Log out from a registry |
58-
| [`logs`](container_logs.md) | Fetch the logs of a container |
59-
| [`manifest`](manifest.md) | Manage Docker image manifests and manifest lists |
60-
| [`network`](network.md) | Manage networks |
61-
| [`node`](node.md) | Manage Swarm nodes |
62-
| [`pause`](container_pause.md) | Pause all processes within one or more containers |
63-
| [`plugin`](plugin.md) | Manage plugins |
64-
| [`port`](container_port.md) | List port mappings or a specific mapping for the container |
65-
| [`ps`](container_ls.md) | List containers |
66-
| [`pull`](image_pull.md) | Download an image from a registry |
67-
| [`push`](image_push.md) | Upload an image to a registry |
68-
| [`rename`](container_rename.md) | Rename a container |
69-
| [`restart`](container_restart.md) | Restart one or more containers |
70-
| [`rm`](container_rm.md) | Remove one or more containers |
71-
| [`rmi`](image_rm.md) | Remove one or more images |
72-
| [`run`](container_run.md) | Create and run a new container from an image |
73-
| [`save`](image_save.md) | Save one or more images to a tar archive (streamed to STDOUT by default) |
74-
| [`search`](search.md) | Search Docker Hub for images |
75-
| [`secret`](secret.md) | Manage Swarm secrets |
76-
| [`service`](service.md) | Manage Swarm services |
77-
| [`stack`](stack.md) | Manage Swarm stacks |
78-
| [`start`](container_start.md) | Start one or more stopped containers |
79-
| [`stats`](container_stats.md) | Display a live stream of container(s) resource usage statistics |
80-
| [`stop`](container_stop.md) | Stop one or more running containers |
81-
| [`swarm`](swarm.md) | Manage Swarm |
82-
| [`system`](system.md) | Manage Docker |
83-
| [`tag`](image_tag.md) | Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE |
84-
| [`top`](container_top.md) | Display the running processes of a container |
85-
| [`trust`](trust.md) | Manage trust on Docker images |
86-
| [`unpause`](container_unpause.md) | Unpause all processes within one or more containers |
87-
| [`update`](container_update.md) | Update configuration of one or more containers |
88-
| [`version`](version.md) | Show the Docker version information |
89-
| [`volume`](volume.md) | Manage volumes |
90-
| [`wait`](container_wait.md) | Block until one or more containers stop, then print their exit codes |
91-
92-
### Options
93-
94-
| Name | Type | Default | Description |
95-
|:---------------------------------|:---------|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------|
96-
| `--config` | `string` | `/root/.docker` | Location of client config files |
97-
| `-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`) |
98-
| `-D`, `--debug` | | | Enable debug mode |
99-
| [`-H`](#host), [`--host`](#host) | `list` | | Daemon socket to connect to |
100-
| `-l`, `--log-level` | `string` | `info` | Set the logging level (`debug`, `info`, `warn`, `error`, `fatal`) |
101-
| `--tls` | | | Use TLS; implied by --tlsverify |
102-
| `--tlscacert` | `string` | `/root/.docker/ca.pem` | Trust certs signed only by this CA |
103-
| `--tlscert` | `string` | `/root/.docker/cert.pem` | Path to TLS certificate file |
104-
| `--tlskey` | `string` | `/root/.docker/key.pem` | Path to TLS key file |
105-
| `--tlsverify` | | | Use TLS and verify the remote |
106-
107-
108-
<!---MARKER_GEN_END-->
109-
110-
## Description
13+
The base command for the Docker CLI is `docker`. For information about the
14+
available flags and subcommands, refer to the [CLI reference](docker.md)
11115

11216
Depending on your Docker system configuration, you may be required to preface
11317
each `docker` command with `sudo`. To avoid having to use `sudo` with the

‎docs/reference/commandline/docker.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# docker
2+
3+
<!---MARKER_GEN_START-->
4+
The base command for the Docker CLI.
5+
6+
### Subcommands
7+
8+
| Name | Description |
9+
|:------------------------------|:------------------------------------------------------------------------------|
10+
| [`attach`](attach.md) | Attach local standard input, output, and error streams to a running container |
11+
| [`build`](build.md) | Build an image from a Dockerfile |
12+
| [`builder`](builder.md) | Manage builds |
13+
| [`checkpoint`](checkpoint.md) | Manage checkpoints |
14+
| [`commit`](commit.md) | Create a new image from a container's changes |
15+
| [`config`](config.md) | Manage Swarm configs |
16+
| [`container`](container.md) | Manage containers |
17+
| [`context`](context.md) | Manage contexts |
18+
| [`cp`](cp.md) | Copy files/folders between a container and the local filesystem |
19+
| [`create`](create.md) | Create a new container |
20+
| [`diff`](diff.md) | Inspect changes to files or directories on a container's filesystem |
21+
| [`events`](events.md) | Get real time events from the server |
22+
| [`exec`](exec.md) | Execute a command in a running container |
23+
| [`export`](export.md) | Export a container's filesystem as a tar archive |
24+
| [`history`](history.md) | Show the history of an image |
25+
| [`image`](image.md) | Manage images |
26+
| [`images`](images.md) | List images |
27+
| [`import`](import.md) | Import the contents from a tarball to create a filesystem image |
28+
| [`info`](info.md) | Display system-wide information |
29+
| [`inspect`](inspect.md) | Return low-level information on Docker objects |
30+
| [`kill`](kill.md) | Kill one or more running containers |
31+
| [`load`](load.md) | Load an image from a tar archive or STDIN |
32+
| [`login`](login.md) | Log in to a registry |
33+
| [`logout`](logout.md) | Log out from a registry |
34+
| [`logs`](logs.md) | Fetch the logs of a container |
35+
| [`manifest`](manifest.md) | Manage Docker image manifests and manifest lists |
36+
| [`network`](network.md) | Manage networks |
37+
| [`node`](node.md) | Manage Swarm nodes |
38+
| [`pause`](pause.md) | Pause all processes within one or more containers |
39+
| [`plugin`](plugin.md) | Manage plugins |
40+
| [`port`](port.md) | List port mappings or a specific mapping for the container |
41+
| [`ps`](ps.md) | List containers |
42+
| [`pull`](pull.md) | Download an image from a registry |
43+
| [`push`](push.md) | Upload an image to a registry |
44+
| [`rename`](rename.md) | Rename a container |
45+
| [`restart`](restart.md) | Restart one or more containers |
46+
| [`rm`](rm.md) | Remove one or more containers |
47+
| [`rmi`](rmi.md) | Remove one or more images |
48+
| [`run`](run.md) | Create and run a new container from an image |
49+
| [`save`](save.md) | Save one or more images to a tar archive (streamed to STDOUT by default) |
50+
| [`search`](search.md) | Search Docker Hub for images |
51+
| [`secret`](secret.md) | Manage Swarm secrets |
52+
| [`service`](service.md) | Manage Swarm services |
53+
| [`stack`](stack.md) | Manage Swarm stacks |
54+
| [`start`](start.md) | Start one or more stopped containers |
55+
| [`stats`](stats.md) | Display a live stream of container(s) resource usage statistics |
56+
| [`stop`](stop.md) | Stop one or more running containers |
57+
| [`swarm`](swarm.md) | Manage Swarm |
58+
| [`system`](system.md) | Manage Docker |
59+
| [`tag`](tag.md) | Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE |
60+
| [`top`](top.md) | Display the running processes of a container |
61+
| [`trust`](trust.md) | Manage trust on Docker images |
62+
| [`unpause`](unpause.md) | Unpause all processes within one or more containers |
63+
| [`update`](update.md) | Update configuration of one or more containers |
64+
| [`version`](version.md) | Show the Docker version information |
65+
| [`volume`](volume.md) | Manage volumes |
66+
| [`wait`](wait.md) | Block until one or more containers stop, then print their exit codes |
67+
68+
69+
### Options
70+
71+
| Name | Type | Default | Description |
72+
|:--------------------|:---------|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------|
73+
| `--config` | `string` | `/root/.docker` | Location of client config files |
74+
| `-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`) |
75+
| `-D`, `--debug` | | | Enable debug mode |
76+
| `-H`, `--host` | `list` | | Daemon socket to connect to |
77+
| `-l`, `--log-level` | `string` | `info` | Set the logging level (`debug`, `info`, `warn`, `error`, `fatal`) |
78+
| `--tls` | | | Use TLS; implied by --tlsverify |
79+
| `--tlscacert` | `string` | `/root/.docker/ca.pem` | Trust certs signed only by this CA |
80+
| `--tlscert` | `string` | `/root/.docker/cert.pem` | Path to TLS certificate file |
81+
| `--tlskey` | `string` | `/root/.docker/key.pem` | Path to TLS key file |
82+
| `--tlsverify` | | | Use TLS and verify the remote |
83+
84+
85+
<!---MARKER_GEN_END-->
86+

0 commit comments

Comments
 (0)