Browse code
add menu.md, make index.md command line reference, update typos/minor errors in cli docs
Signed-off-by: Charles Smith <charles.smith@docker.com>
Charles Smith authored on 2016/06/29 03:53:39Showing 6 changed files
- docs/reference/commandline/index.md
- docs/reference/commandline/menu.md
- docs/reference/commandline/network_ls.md
- docs/reference/commandline/node_demote.md
- docs/reference/commandline/node_inspect.md
- docs/reference/commandline/swarm_update.md
| ... | ... |
@@ -1,11 +1,11 @@ |
| 1 | 1 |
<!-- [metadata]> |
| 2 | 2 |
+++ |
| 3 |
-title = "Command line reference" |
|
| 3 |
+title = "Docker commands" |
|
| 4 | 4 |
description = "Docker's CLI command description and usage" |
| 5 | 5 |
keywords = ["Docker, Docker documentation, CLI, command line"] |
| 6 | 6 |
[menu.main] |
| 7 |
-identifier= "smn_cli" |
|
| 8 |
-parent = "engine_ref" |
|
| 7 |
+identifier= "smn_cli_guide" |
|
| 8 |
+parent = "smn_cli" |
|
| 9 | 9 |
weight=-70 |
| 10 | 10 |
+++ |
| 11 | 11 |
<![end-metadata]--> |
| ... | ... |
@@ -14,103 +14,129 @@ weight=-70 |
| 14 | 14 |
|
| 15 | 15 |
# The Docker commands |
| 16 | 16 |
|
| 17 |
-This section contains reference information on using Docker's command line client. Each command has a reference page along with samples. If you are unfamiliar with the command line, you should start by reading about how to [Use the Docker command line](cli.md). |
|
| 17 |
+This section contains reference information on using Docker's command line |
|
| 18 |
+client. Each command has a reference page along with samples. If you are |
|
| 19 |
+unfamiliar with the command line, you should start by reading about how to [Use |
|
| 20 |
+the Docker command line](cli.md). |
|
| 18 | 21 |
|
| 19 |
-You start the Docker daemon with the command line. How you start the daemon affects your Docker containers. For that reason you should also make sure to read the [`dockerd`](dockerd.md) reference page. |
|
| 22 |
+You start the Docker daemon with the command line. How you start the daemon |
|
| 23 |
+affects your Docker containers. For that reason you should also make sure to |
|
| 24 |
+read the [`dockerd`](dockerd.md) reference page. |
|
| 20 | 25 |
|
| 21 | 26 |
### Docker management commands |
| 22 | 27 |
|
| 23 |
-* [dockerd](dockerd.md) |
|
| 24 |
-* [info](info.md) |
|
| 25 |
-* [inspect](inspect.md) |
|
| 26 |
-* [version](version.md) |
|
| 28 |
+| Command | Description | |
|
| 29 |
+|:--------|:-------------------------------------------------------------------| |
|
| 30 |
+| [dockerd](dockerd.md) | Launch the Docker daemon | |
|
| 31 |
+| [info](info.md) | Display system-wide information | |
|
| 32 |
+| [inspect](inspect.md)| Return low-level information on a container or image | |
|
| 33 |
+| [version](version.md) | Show the Docker version information | |
|
| 34 |
+ |
|
| 27 | 35 |
|
| 28 | 36 |
### Image commands |
| 29 | 37 |
|
| 30 |
-* [build](build.md) |
|
| 31 |
-* [commit](commit.md) |
|
| 32 |
-* [export](export.md) |
|
| 33 |
-* [history](history.md) |
|
| 34 |
-* [images](images.md) |
|
| 35 |
-* [import](import.md) |
|
| 36 |
-* [load](load.md) |
|
| 37 |
-* [rmi](rmi.md) |
|
| 38 |
-* [save](save.md) |
|
| 39 |
-* [tag](tag.md) |
|
| 38 |
+| Command | Description | |
|
| 39 |
+|:--------|:-------------------------------------------------------------------| |
|
| 40 |
+| [build](build.md) | Build an image from a Dockerfile | |
|
| 41 |
+| [commit](commit.md) | Create a new image from a container's changes | |
|
| 42 |
+| [export](export.md) | Export a container's filesystem as a tar archive | |
|
| 43 |
+| [history](history.md) | Show the history of an image | |
|
| 44 |
+| [images](images.md) | List images | |
|
| 45 |
+| [import](import.md) | Import the contents from a tarball to create a filesystem image | |
|
| 46 |
+| [load](load.md) | Load an image from a tar archive or STDIN | |
|
| 47 |
+| [rmi](rmi.md) | Remove one or more images | |
|
| 48 |
+| [save](save.md) | Save images to a tar archive | |
|
| 49 |
+| [tag](tag.md) | Tag an image into a repository | |
|
| 40 | 50 |
|
| 41 | 51 |
### Container commands |
| 42 | 52 |
|
| 43 |
-* [attach](attach.md) |
|
| 44 |
-* [cp](cp.md) |
|
| 45 |
-* [create](create.md) |
|
| 46 |
-* [diff](diff.md) |
|
| 47 |
-* [events](events.md) |
|
| 48 |
-* [exec](exec.md) |
|
| 49 |
-* [kill](kill.md) |
|
| 50 |
-* [logs](logs.md) |
|
| 51 |
-* [pause](pause.md) |
|
| 52 |
-* [port](port.md) |
|
| 53 |
-* [ps](ps.md) |
|
| 54 |
-* [rename](rename.md) |
|
| 55 |
-* [restart](restart.md) |
|
| 56 |
-* [rm](rm.md) |
|
| 57 |
-* [run](run.md) |
|
| 58 |
-* [start](start.md) |
|
| 59 |
-* [stats](stats.md) |
|
| 60 |
-* [stop](stop.md) |
|
| 61 |
-* [top](top.md) |
|
| 62 |
-* [unpause](unpause.md) |
|
| 63 |
-* [update](update.md) |
|
| 64 |
-* [wait](wait.md) |
|
| 53 |
+| Command | Description | |
|
| 54 |
+|:--------|:-------------------------------------------------------------------| |
|
| 55 |
+| [attach](attach.md) | Attach to a running container | |
|
| 56 |
+| [cp](cp.md) | Copy files/folders from a container to a HOSTDIR or to STDOUT | |
|
| 57 |
+| [create](create.md) | Create a new container | |
|
| 58 |
+| [diff](diff.md) | Inspect changes on a container's filesystem | |
|
| 59 |
+| [events](events.md) | Get real time events from the server | |
|
| 60 |
+| [exec](exec.md) | Run a command in a running container | |
|
| 61 |
+| [kill](kill.md) | Kill a running container | |
|
| 62 |
+| [logs](logs.md) | Fetch the logs of a container | |
|
| 63 |
+| [pause](pause.md) | Pause all processes within a container | |
|
| 64 |
+| [port](port.md) | List port mappings or a specific mapping for the container | |
|
| 65 |
+| [ps](ps.md) | List containers | |
|
| 66 |
+| [rename](rename.md) | Rename a container | |
|
| 67 |
+| [restart](restart.md) | Restart a running container | |
|
| 68 |
+| [rm](rm.md) | Remove one or more containers | |
|
| 69 |
+| [run](run.md) | Run a command in a new container | |
|
| 70 |
+| [start](start.md) | Start one or more stopped containers | |
|
| 71 |
+| [stats](stats.md) | Display a live stream of container(s) resource usage statistics | |
|
| 72 |
+| [stop](stop.md) | Stop a running container | |
|
| 73 |
+| [top](top.md) | Display the running processes of a container | |
|
| 74 |
+| [unpause](unpause.md) | Unpause all processes within a container | |
|
| 75 |
+| [update](update.md) | Update configuration of one or more containers | |
|
| 76 |
+| [wait](wait.md) | Block until a container stops, then print its exit code | |
|
| 65 | 77 |
|
| 66 | 78 |
### Hub and registry commands |
| 67 | 79 |
|
| 68 |
-* [login](login.md) |
|
| 69 |
-* [logout](logout.md) |
|
| 70 |
-* [pull](pull.md) |
|
| 71 |
-* [push](push.md) |
|
| 72 |
-* [search](search.md) |
|
| 80 |
+| Command | Description | |
|
| 81 |
+|:--------|:-------------------------------------------------------------------| |
|
| 82 |
+| [login](login.md) | Register or log in to a Docker registry | |
|
| 83 |
+| [logout](logout.md) | Log out from a Docker registry | |
|
| 84 |
+| [pull](pull.md) | Pull an image or a repository from a Docker registry | |
|
| 85 |
+| [push](push.md) | Push an image or a repository to a Docker registry | |
|
| 86 |
+| [search](search.md) | Search the Docker Hub for images | |
|
| 73 | 87 |
|
| 74 | 88 |
### Network and connectivity commands |
| 75 | 89 |
|
| 76 |
-* [network_connect](network_connect.md) |
|
| 77 |
-* [network_create](network_create.md) |
|
| 78 |
-* [network_disconnect](network_disconnect.md) |
|
| 79 |
-* [network_inspect](network_inspect.md) |
|
| 80 |
-* [network_ls](network_ls.md) |
|
| 81 |
-* [network_rm](network_rm.md) |
|
| 90 |
+| Command | Description | |
|
| 91 |
+|:--------|:-------------------------------------------------------------------| |
|
| 92 |
+| [network connect](network_connect.md) | Connect a container to a network | |
|
| 93 |
+| [network create](network_create.md) | Create a new network | |
|
| 94 |
+| [network disconnect](network_disconnect.md) | Disconnect a container from a network | |
|
| 95 |
+| [network inspect](network_inspect.md) | Display information about a network | |
|
| 96 |
+| [network ls](network_ls.md) | Lists all the networks the Engine `daemon` knows about | |
|
| 97 |
+| [network rm](network_rm.md) | Removes one or more networks | |
|
| 98 |
+ |
|
| 82 | 99 |
|
| 83 | 100 |
### Shared data volume commands |
| 84 | 101 |
|
| 85 |
-* [volume_create](volume_create.md) |
|
| 86 |
-* [volume_inspect](volume_inspect.md) |
|
| 87 |
-* [volume_ls](volume_ls.md) |
|
| 88 |
-* [volume_rm](volume_rm.md) |
|
| 102 |
+| Command | Description | |
|
| 103 |
+|:--------|:-------------------------------------------------------------------| |
|
| 104 |
+| [volume create](volume_create.md) | Creates a new volume where containers can consume and store data | |
|
| 105 |
+| [volume inspect](volume_inspect.md) | Display information about a volume | |
|
| 106 |
+| [volume ls](volume_ls.md) | Lists all the volumes Docker knows about | |
|
| 107 |
+| [volume rm](volume_rm.md) | Remove one or more volumes | |
|
| 108 |
+ |
|
| 89 | 109 |
|
| 90 | 110 |
### Swarm node commands |
| 91 | 111 |
|
| 92 |
-* [node_accept](node_accept.md) |
|
| 93 |
-* [node_promote](node_promote.md) |
|
| 94 |
-* [node_demote](node_demote.md) |
|
| 95 |
-* [node_inspect](node_inspect.md) |
|
| 96 |
-* [node_update](node_update.md) |
|
| 97 |
-* [node_tasks](node_tasks.md) |
|
| 98 |
-* [node_ls](node_ls.md) |
|
| 99 |
-* [node_rm](node_rm.md) |
|
| 112 |
+| Command | Description | |
|
| 113 |
+|:--------|:-------------------------------------------------------------------| |
|
| 114 |
+| [node accept](node_accept.md) | Accept a node into the swarm | |
|
| 115 |
+| [node promote](node_promote.md) | Promote a node that is pending a promotion to manager | |
|
| 116 |
+| [node demote](node_demote.md) | Demotes an existing manager so that it is no longer a manager | |
|
| 117 |
+| [node inspect](node_inspect.md) | Inspect a node in the swarm | |
|
| 118 |
+| [node update](node_update.md) | Update attributes for a node | |
|
| 119 |
+| [node tasks](node_tasks.md) | List tasks running on a node | |
|
| 120 |
+| [node ls](node_ls.md) | List nodes in the swarm | |
|
| 121 |
+| [node rm](node_rm.md) | Remove a node from the swarm | |
|
| 100 | 122 |
|
| 101 | 123 |
### Swarm swarm commands |
| 102 | 124 |
|
| 103 |
-* [swarm init](swarm_init.md) |
|
| 104 |
-* [swarm join](swarm_join.md) |
|
| 105 |
-* [swarm leave](swarm_leave.md) |
|
| 106 |
-* [swarm update](swarm_update.md) |
|
| 125 |
+| Command | Description | |
|
| 126 |
+|:--------|:-------------------------------------------------------------------| |
|
| 127 |
+| [swarm init](swarm_init.md) | Initialize a Swarm | |
|
| 128 |
+| [swarm join](swarm_join.md) | Join a Swarm as a manager node or worker node | |
|
| 129 |
+| [swarm leave](swarm_leave.md) | Remove the current node from the swarm | |
|
| 130 |
+| [swarm update](swarm_update.md) | Update attributes of a swarm | |
|
| 107 | 131 |
|
| 108 | 132 |
### Swarm service commands |
| 109 | 133 |
|
| 110 |
-* [service create](service_create.md) |
|
| 111 |
-* [service inspect](service_inspect.md) |
|
| 112 |
-* [service ls](service_ls.md) |
|
| 113 |
-* [service rm](service_rm.md) |
|
| 114 |
-* [service scale](service_scale.md) |
|
| 115 |
-* [service tasks](service_tasks.md) |
|
| 116 |
-* [service update](service_update.md) |
|
| 134 |
+| Command | Description | |
|
| 135 |
+|:--------|:-------------------------------------------------------------------| |
|
| 136 |
+| [service create](service_create.md) | Create a new service | |
|
| 137 |
+| [service inspect](service_inspect.md) | Inspect a service | |
|
| 138 |
+| [service ls](service_ls.md) | List services in the swarm | |
|
| 139 |
+| [service rm](service_rm.md) | Reemove a swervice from the swarm | |
|
| 140 |
+| [service scale](service_scale.md) | Set the number of replicas for the desired state of the service | |
|
| 141 |
+| [service tasks](service_tasks.md) | List the tasks of a service | |
|
| 142 |
+| [service update](service_update.md) | Update the attributes of a service | |
| 117 | 143 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,26 @@ |
| 0 |
+<!-- [metadata]> |
|
| 1 |
+title = "Command line reference" |
|
| 2 |
+description = "Docker's CLI command description and usage" |
|
| 3 |
+keywords = ["Docker, Docker documentation, CLI, command line"] |
|
| 4 |
+[menu.main] |
|
| 5 |
+identifier= "smn_cli" |
|
| 6 |
+parent = "engine_ref" |
|
| 7 |
+weight=-75 |
|
| 8 |
+<![end-metadata]--> |
|
| 9 |
+ |
|
| 10 |
+ |
|
| 11 |
+ |
|
| 12 |
+# The Docker commands |
|
| 13 |
+ |
|
| 14 |
+This section contains reference information on using Docker's command line |
|
| 15 |
+client. Each command has a reference page along with samples. If you are |
|
| 16 |
+unfamiliar with the command line, you should start by reading about how to |
|
| 17 |
+[Use the Docker command line](cli.md). |
|
| 18 |
+ |
|
| 19 |
+You start the Docker daemon with the command line. How you start the daemon |
|
| 20 |
+affects your Docker containers. For that reason you should also make sure to |
|
| 21 |
+read the [`dockerd`](dockerd.md) reference page. |
|
| 22 |
+ |
|
| 23 |
+For a list of Docker commands see [Command line reference guide](index.md). |
| ... | ... |
@@ -12,7 +12,7 @@ parent = "smn_cli" |
| 12 | 12 |
|
| 13 | 13 |
Usage: docker network ls [OPTIONS] |
| 14 | 14 |
|
| 15 |
- Lists all the networks created by the user |
|
| 15 |
+ List networks |
|
| 16 | 16 |
-f, --filter=[] Filter output based on conditions provided |
| 17 | 17 |
--help Print usage |
| 18 | 18 |
--no-trunc Do not truncate the output |
| ... | ... |
@@ -35,10 +35,10 @@ Use the `--no-trunc` option to display the full network id: |
| 35 | 35 |
```bash |
| 36 | 36 |
docker network ls --no-trunc |
| 37 | 37 |
NETWORK ID NAME DRIVER |
| 38 |
-18a2866682b85619a026c81b98a5e375bd33e1b0936a26cc497c283d27bae9b3 none null |
|
| 39 |
-c288470c46f6c8949c5f7e5099b5b7947b07eabe8d9a27d79a9cbf111adcbf47 host host |
|
| 40 |
-7b369448dccbf865d397c8d2be0cda7cf7edc6b0945f77d2529912ae917a0185 bridge bridge |
|
| 41 |
-95e74588f40db048e86320c6526440c504650a1ff3e9f7d60a497c4d2163e5bd foo bridge |
|
| 38 |
+18a2866682b85619a026c81b98a5e375bd33e1b0936a26cc497c283d27bae9b3 none null |
|
| 39 |
+c288470c46f6c8949c5f7e5099b5b7947b07eabe8d9a27d79a9cbf111adcbf47 host host |
|
| 40 |
+7b369448dccbf865d397c8d2be0cda7cf7edc6b0945f77d2529912ae917a0185 bridge bridge |
|
| 41 |
+95e74588f40db048e86320c6526440c504650a1ff3e9f7d60a497c4d2163e5bd foo bridge |
|
| 42 | 42 |
63d1ff1f77b07ca51070a8c227e962238358bd310bde1529cf62e6c307ade161 dev bridge |
| 43 | 43 |
``` |
| 44 | 44 |
|
| ... | ... |
@@ -46,7 +46,7 @@ c288470c46f6c8949c5f7e5099b5b7947b07eabe8d9a27d79a9cbf111adcbf47 host |
| 46 | 46 |
|
| 47 | 47 |
The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there |
| 48 | 48 |
is more than one filter, then pass multiple flags (e.g. `--filter "foo=bar" --filter "bif=baz"`). |
| 49 |
-Multiple filter flags are combined as an `OR` filter. For example, |
|
| 49 |
+Multiple filter flags are combined as an `OR` filter. For example, |
|
| 50 | 50 |
`-f type=custom -f type=builtin` returns both `custom` and `builtin` networks. |
| 51 | 51 |
|
| 52 | 52 |
The currently supported filters are: |
| ... | ... |
@@ -105,7 +105,7 @@ The following filter matches networks with the `usage` label regardless of its v |
| 105 | 105 |
```bash |
| 106 | 106 |
$ docker network ls -f "label=usage" |
| 107 | 107 |
NETWORK ID NAME DRIVER |
| 108 |
-db9db329f835 test1 bridge |
|
| 108 |
+db9db329f835 test1 bridge |
|
| 109 | 109 |
f6e212da9dfd test2 bridge |
| 110 | 110 |
``` |
| 111 | 111 |
|
| ... | ... |
@@ -14,7 +14,7 @@ parent = "smn_cli" |
| 14 | 14 |
|
| 15 | 15 |
Demote a node as manager in the swarm |
| 16 | 16 |
|
| 17 |
-Demotes an existing Manager so that it is no longer a manager. This command targets a docker engine that is a manager in the swarm cluster. |
|
| 17 |
+Demotes an existing manager so that it is no longer a manager. This command targets a docker engine that is a manager in the swarm cluster. |
|
| 18 | 18 |
|
| 19 | 19 |
|
| 20 | 20 |
```bash |