1. docker
  2. Commit 039fb56e6367f835baf4d5aabbdf396d0bf1836c
Browse code

Merge pull request #32126 from vdemeester/docs-ref-cli-root-commands

Add cli reference docs for root-level commands
(cherry picked from commit cf113faca649fef70990677f0f4fd2b14e0af038)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Sebastiaan van Stijn authored on 2017/03/28 16:46:32
Showing 11 changed files
docs/reference/commandline/container.md
History View file @ 039fb56
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,61 @@
0 
+
1 
+---
2 
+title: "container"
3 
+description: "The container command description and usage"
4 
+keywords: "container"
5 
+---
6 
+
7 
+<!-- This file is maintained within the docker/docker Github
8 
+     repository at https://github.com/docker/docker/. Make all
9 
+     pull requests against that repo. If you see this file in
10 
+     another repository, consider it read-only there, as it will
11 
+     periodically be overwritten by the definitive file. Pull
12 
+     requests which include edits to this file in other repositories
13 
+     will be rejected.
14 
+-->
15 
+
16 
+# container
17 
+
18 
+```markdown
19 
+Usage:  docker container COMMAND
20 
+
21 
+Manage containers
22 
+
23 
+Options:
24 
+      --help   Print usage
25 
+
26 
+Commands:
27 
+  attach      Attach to a running container
28 
+  commit      Create a new image from a container's changes
29 
+  cp          Copy files/folders between a container and the local filesystem
30 
+  create      Create a new container
31 
+  diff        Inspect changes to files or directories on a container's filesystem
32 
+  exec        Run a command in a running container
33 
+  export      Export a container's filesystem as a tar archive
34 
+  inspect     Display detailed information on one or more containers
35 
+  kill        Kill one or more running containers
36 
+  logs        Fetch the logs of a container
37 
+  ls          List containers
38 
+  pause       Pause all processes within one or more containers
39 
+  port        List port mappings or a specific mapping for the container
40 
+  prune       Remove all stopped containers
41 
+  rename      Rename a container
42 
+  restart     Restart one or more containers
43 
+  rm          Remove one or more containers
44 
+  run         Run a command in a new container
45 
+  start       Start one or more stopped containers
46 
+  stats       Display a live stream of container(s) resource usage statistics
47 
+  stop        Stop one or more running containers
48 
+  top         Display the running processes of a container
49 
+  unpause     Unpause all processes within one or more containers
50 
+  update      Update configuration of one or more containers
51 
+  wait        Block until one or more containers stop, then print their exit codes
52 
+
53 
+Run 'docker container COMMAND --help' for more information on a command.
54 
+
55 
+```
56 
+
57 
+## Description
58 
+
59 
+Manage containers.
60 
+
docs/reference/commandline/image.md
History View file @ 039fb56
0 61 
new file mode 100644
... ... 
@@ -0,0 +1,47 @@
0 
+
1 
+---
2 
+title: "image"
3 
+description: "The image command description and usage"
4 
+keywords: "image"
5 
+---
6 
+
7 
+<!-- This file is maintained within the docker/docker Github
8 
+     repository at https://github.com/docker/docker/. Make all
9 
+     pull requests against that repo. If you see this file in
10 
+     another repository, consider it read-only there, as it will
11 
+     periodically be overwritten by the definitive file. Pull
12 
+     requests which include edits to this file in other repositories
13 
+     will be rejected.
14 
+-->
15 
+
16 
+# image
17 
+
18 
+```markdown
19 
+Usage:  docker image COMMAND
20 
+
21 
+Manage images
22 
+
23 
+Options:
24 
+      --help   Print usage
25 
+
26 
+Commands:
27 
+  build       Build an image from a Dockerfile
28 
+  history     Show the history of an image
29 
+  import      Import the contents from a tarball to create a filesystem image
30 
+  inspect     Display detailed information on one or more images
31 
+  load        Load an image from a tar archive or STDIN
32 
+  ls          List images
33 
+  prune       Remove unused images
34 
+  pull        Pull an image or a repository from a registry
35 
+  push        Push an image or a repository to a registry
36 
+  rm          Remove one or more images
37 
+  save        Save one or more images to a tar archive (streamed to STDOUT by default)
38 
+  tag         Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE
39 
+
40 
+Run 'docker image COMMAND --help' for more information on a command.
41 
+
42 
+```
43 
+
44 
+## Description
45 
+
46 
+Manage images.
docs/reference/commandline/network.md
History View file @ 039fb56
0 47 
new file mode 100644
... ... 
@@ -0,0 +1,49 @@
0 
+---
1 
+title: "network"
2 
+description: "The network command description and usage"
3 
+keywords: "network"
4 
+---
5 
+
6 
+<!-- This file is maintained within the docker/docker Github
7 
+     repository at https://github.com/docker/docker/. Make all
8 
+     pull requests against that repo. If you see this file in
9 
+     another repository, consider it read-only there, as it will
10 
+     periodically be overwritten by the definitive file. Pull
11 
+     requests which include edits to this file in other repositories
12 
+     will be rejected.
13 
+-->
14 
+
15 
+# network
16 
+
17 
+```markdown
18 
+Usage:  docker network COMMAND
19 
+
20 
+Manage networks
21 
+
22 
+Options:
23 
+      --help   Print usage
24 
+
25 
+Commands:
26 
+  connect     Connect a container to a network
27 
+  create      Create a network
28 
+  disconnect  Disconnect a container from a network
29 
+  inspect     Display detailed information on one or more networks
30 
+  ls          List networks
31 
+  prune       Remove all unused networks
32 
+  rm          Remove one or more networks
33 
+
34 
+Run 'docker network COMMAND --help' for more information on a command.
35 
+```
36 
+
37 
+## Description
38 
+
39 
+Manage networks. You can use subcommand to create, list, inspect, remove,
40 
+connect and disconnect networks.
41 
+
42 
+## Related commands
43 
+
44 
+* [network create](network_create.md)
45 
+* [network inspect](network_inspect.md)
46 
+* [network list](network_list.md)
47 
+* [network rm](network_rm.md)
48 
+* [network prune](network_prune.md)
docs/reference/commandline/node.md
History View file @ 039fb56
0 49 
new file mode 100644
... ... 
@@ -0,0 +1,42 @@
0 
+
1 
+---
2 
+title: "node"
3 
+description: "The node command description and usage"
4 
+keywords: "node"
5 
+---
6 
+
7 
+<!-- This file is maintained within the docker/docker Github
8 
+     repository at https://github.com/docker/docker/. Make all
9 
+     pull requests against that repo. If you see this file in
10 
+     another repository, consider it read-only there, as it will
11 
+     periodically be overwritten by the definitive file. Pull
12 
+     requests which include edits to this file in other repositories
13 
+     will be rejected.
14 
+-->
15 
+
16 
+# node
17 
+
18 
+```markdown
19 
+Usage:  docker node COMMAND
20 
+
21 
+Manage Swarm nodes
22 
+
23 
+Options:
24 
+      --help   Print usage
25 
+
26 
+Commands:
27 
+  demote      Demote one or more nodes from manager in the swarm
28 
+  inspect     Display detailed information on one or more nodes
29 
+  ls          List nodes in the swarm
30 
+  promote     Promote one or more nodes to manager in the swarm
31 
+  ps          List tasks running on one or more nodes, defaults to current node
32 
+  rm          Remove one or more nodes from the swarm
33 
+  update      Update a node
34 
+
35 
+Run 'docker node COMMAND --help' for more information on a command.
36 
+```
37 
+
38 
+## Description
39 
+
40 
+Manage nodes.
41 
+
docs/reference/commandline/plugin.md
History View file @ 039fb56
0 42 
new file mode 100644
... ... 
@@ -0,0 +1,44 @@
0 
+---
1 
+title: "plugin"
2 
+description: "The plugin command description and usage"
3 
+keywords: "plugin"
4 
+---
5 
+
6 
+<!-- This file is maintained within the docker/docker Github
7 
+     repository at https://github.com/docker/docker/. Make all
8 
+     pull requests against that repo. If you see this file in
9 
+     another repository, consider it read-only there, as it will
10 
+     periodically be overwritten by the definitive file. Pull
11 
+     requests which include edits to this file in other repositories
12 
+     will be rejected.
13 
+-->
14 
+
15 
+# plugin
16 
+
17 
+```markdown
18 
+Usage:  docker plugin COMMAND
19 
+
20 
+Manage plugins
21 
+
22 
+Options:
23 
+      --help   Print usage
24 
+
25 
+Commands:
26 
+  create      Create a plugin from a rootfs and configuration. Plugin data directory must contain config.json and rootfs directory.
27 
+  disable     Disable a plugin
28 
+  enable      Enable a plugin
29 
+  inspect     Display detailed information on one or more plugins
30 
+  install     Install a plugin
31 
+  ls          List plugins
32 
+  push        Push a plugin to a registry
33 
+  rm          Remove one or more plugins
34 
+  set         Change settings for a plugin
35 
+  upgrade     Upgrade an existing plugin
36 
+
37 
+Run 'docker plugin COMMAND --help' for more information on a command.
38 
+
39 
+```
40 
+
41 
+## Description
42 
+
43 
+Manage plugins.
docs/reference/commandline/secret.md
History View file @ 039fb56
0 44 
new file mode 100644
... ... 
@@ -0,0 +1,45 @@
0 
+---
1 
+title: "secret"
2 
+description: "The secret command description and usage"
3 
+keywords: "secret"
4 
+---
5 
+
6 
+<!-- This file is maintained within the docker/docker Github
7 
+     repository at https://github.com/docker/docker/. Make all
8 
+     pull requests against that repo. If you see this file in
9 
+     another repository, consider it read-only there, as it will
10 
+     periodically be overwritten by the definitive file. Pull
11 
+     requests which include edits to this file in other repositories
12 
+     will be rejected.
13 
+-->
14 
+
15 
+# secret
16 
+
17 
+```markdown
18 
+Usage:  docker secret COMMAND
19 
+
20 
+Manage Docker secrets
21 
+
22 
+Options:
23 
+      --help   Print usage
24 
+
25 
+Commands:
26 
+  create      Create a secret from a file or STDIN as content
27 
+  inspect     Display detailed information on one or more secrets
28 
+  ls          List secrets
29 
+  rm          Remove one or more secrets
30 
+
31 
+Run 'docker secret COMMAND --help' for more information on a command.
32 
+
33 
+```
34 
+
35 
+## Description
36 
+
37 
+Manage secrets.
38 
+
39 
+## Related commands
40 
+
41 
+* [secret create](secret_create.md)
42 
+* [secret inspect](secret_inspect.md)
43 
+* [secret list](secret_list.md)
44 
+* [secret rm](secret_rm.md)
docs/reference/commandline/service.md
History View file @ 039fb56
0 45 
new file mode 100644
... ... 
@@ -0,0 +1,42 @@
0 
+---
1 
+title: "service"
2 
+description: "The service command description and usage"
3 
+keywords: "service"
4 
+---
5 
+
6 
+<!-- This file is maintained within the docker/docker Github
7 
+     repository at https://github.com/docker/docker/. Make all
8 
+     pull requests against that repo. If you see this file in
9 
+     another repository, consider it read-only there, as it will
10 
+     periodically be overwritten by the definitive file. Pull
11 
+     requests which include edits to this file in other repositories
12 
+     will be rejected.
13 
+-->
14 
+
15 
+# service
16 
+
17 
+```markdown
18 
+Usage:  docker service COMMAND
19 
+
20 
+Manage services
21 
+
22 
+Options:
23 
+      --help   Print usage
24 
+
25 
+Commands:
26 
+  create      Create a new service
27 
+  inspect     Display detailed information on one or more services
28 
+  logs        Fetch the logs of a service
29 
+  ls          List services
30 
+  ps          List the tasks of a service
31 
+  rm          Remove one or more services
32 
+  scale       Scale one or multiple replicated services
33 
+  update      Update a service
34 
+
35 
+Run 'docker service COMMAND --help' for more information on a command.
36 
+```
37 
+
38 
+## Description
39 
+
40 
+Manage services.
41 
+
docs/reference/commandline/stack.md
History View file @ 039fb56
0 42 
new file mode 100644
... ... 
@@ -0,0 +1,39 @@
0 
+---
1 
+title: "stack"
2 
+description: "The stack command description and usage"
3 
+keywords: "stack"
4 
+---
5 
+
6 
+<!-- This file is maintained within the docker/docker Github
7 
+     repository at https://github.com/docker/docker/. Make all
8 
+     pull requests against that repo. If you see this file in
9 
+     another repository, consider it read-only there, as it will
10 
+     periodically be overwritten by the definitive file. Pull
11 
+     requests which include edits to this file in other repositories
12 
+     will be rejected.
13 
+-->
14 
+
15 
+# stack
16 
+
17 
+```markdown
18 
+Usage:  docker stack COMMAND
19 
+
20 
+Manage Docker stacks
21 
+
22 
+Options:
23 
+      --help   Print usage
24 
+
25 
+Commands:
26 
+  deploy      Deploy a new stack or update an existing stack
27 
+  ls          List stacks
28 
+  ps          List the tasks in the stack
29 
+  rm          Remove the stack
30 
+  services    List the services in the stack
31 
+
32 
+Run 'docker stack COMMAND --help' for more information on a command.
33 
+```
34 
+
35 
+## Description
36 
+
37 
+Manage stacks.
38 
+
docs/reference/commandline/swarm.md
History View file @ 039fb56
0 39 
new file mode 100644
... ... 
@@ -0,0 +1,40 @@
0 
+---
1 
+title: "swarm"
2 
+description: "The swarm command description and usage"
3 
+keywords: "swarm"
4 
+---
5 
+
6 
+<!-- This file is maintained within the docker/docker Github
7 
+     repository at https://github.com/docker/docker/. Make all
8 
+     pull requests against that repo. If you see this file in
9 
+     another repository, consider it read-only there, as it will
10 
+     periodically be overwritten by the definitive file. Pull
11 
+     requests which include edits to this file in other repositories
12 
+     will be rejected.
13 
+-->
14 
+
15 
+# swarm
16 
+
17 
+```markdown
18 
+Usage:  docker swarm COMMAND
19 
+
20 
+Manage Swarm
21 
+
22 
+Options:
23 
+      --help   Print usage
24 
+
25 
+Commands:
26 
+  init        Initialize a swarm
27 
+  join        Join a swarm as a node and/or manager
28 
+  join-token  Manage join tokens
29 
+  leave       Leave the swarm
30 
+  unlock      Unlock swarm
31 
+  unlock-key  Manage the unlock key
32 
+  update      Update the swarm
33 
+
34 
+Run 'docker swarm COMMAND --help' for more information on a command.
35 
+```
36 
+
37 
+## Description
38 
+
39 
+Manage the swarm.
docs/reference/commandline/system.md
History View file @ 039fb56
0 40 
new file mode 100644
... ... 
@@ -0,0 +1,37 @@
0 
+---
1 
+title: "system"
2 
+description: "The system command description and usage"
3 
+keywords: "system"
4 
+---
5 
+
6 
+<!-- This file is maintained within the docker/docker Github
7 
+     repository at https://github.com/docker/docker/. Make all
8 
+     pull requests against that repo. If you see this file in
9 
+     another repository, consider it read-only there, as it will
10 
+     periodically be overwritten by the definitive file. Pull
11 
+     requests which include edits to this file in other repositories
12 
+     will be rejected.
13 
+-->
14 
+
15 
+# system
16 
+
17 
+```markdown
18 
+Usage:  docker system COMMAND
19 
+
20 
+Manage Docker
21 
+
22 
+Options:
23 
+      --help   Print usage
24 
+
25 
+Commands:
26 
+  df          Show docker disk usage
27 
+  events      Get real time events from the server
28 
+  info        Display system-wide information
29 
+  prune       Remove unused data
30 
+
31 
+Run 'docker system COMMAND --help' for more information on a command.
32 
+```
33 
+
34 
+## Description
35 
+
36 
+Manage docker.
docs/reference/commandline/volume.md
History View file @ 039fb56
0 37 
new file mode 100644
... ... 
@@ -0,0 +1,48 @@
0 
+---
1 
+title: "volume"
2 
+description: "The volume command description and usage"
3 
+keywords: "volume"
4 
+---
5 
+
6 
+<!-- This file is maintained within the docker/docker Github
7 
+     repository at https://github.com/docker/docker/. Make all
8 
+     pull requests against that repo. If you see this file in
9 
+     another repository, consider it read-only there, as it will
10 
+     periodically be overwritten by the definitive file. Pull
11 
+     requests which include edits to this file in other repositories
12 
+     will be rejected.
13 
+-->
14 
+
15 
+# volume
16 
+
17 
+```markdown
18 
+Usage:  docker volume COMMAND
19 
+
20 
+Manage volumes
21 
+
22 
+Options:
23 
+      --help   Print usage
24 
+
25 
+Commands:
26 
+  create      Create a volume
27 
+  inspect     Display detailed information on one or more volumes
28 
+  ls          List volumes
29 
+  prune       Remove all unused volumes
30 
+  rm          Remove one or more volumes
31 
+
32 
+Run 'docker volume COMMAND --help' for more information on a command.
33 
+```
34 
+
35 
+## Description
36 
+
37 
+Manage volumes. You can use subcommand to create, list, inspect, remove
38 
+volumes.
39 
+
40 
+## Related commands
41 
+
42 
+* [volume create](volume_create.md)
43 
+* [volume inspect](volume_inspect.md)
44 
+* [volume list](volume_list.md)
45 
+* [volume rm](volume_rm.md)
46 
+* [volume prune](volume_prune.md)
47 
+* [Understand Data Volumes](https://docs.docker.com/engine/tutorials/dockervolumes/)