mirror of https://github.com/docker/cli.git
docs: rename cli reference aliases to canonical
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson
parent
cf9d3692a3
commit
a6774de682
|
|
@ -20,72 +20,71 @@ read the [`dockerd`](dockerd.md) reference page.
|
||||||
|
|
||||||
### Docker management commands
|
### Docker management commands
|
||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|:----------------------|:-----------------------------------------------------|
|
| :-------------------------------- | :--------------------------------------------------- |
|
||||||
| [dockerd](dockerd.md) | Launch the Docker daemon |
|
| [dockerd](dockerd.md) | Launch the Docker daemon |
|
||||||
| [info](info.md) | Display system-wide information |
|
| [inspect](inspect.md) | Return low-level information on a container or image |
|
||||||
| [inspect](inspect.md) | Return low-level information on a container or image |
|
| [system events](system_events.md) | Get real-time events from the server |
|
||||||
| [version](version.md) | Show the Docker version information |
|
| [system info](system_info.md) | Display system-wide information |
|
||||||
|
| [version](version.md) | Show the Docker version information |
|
||||||
|
|
||||||
### Image commands
|
### Image commands
|
||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|:------------------------------|:----------------------------------------------------------------|
|
| :-------------------------------- | :-------------------------------------------------------------- |
|
||||||
| [build](build.md) | Build an image from a Dockerfile |
|
| [image build](image_build.md) | Build an image from a Dockerfile |
|
||||||
| [commit](commit.md) | Create a new image from a container's changes |
|
| [image commit](image_commit.md) | Create a new image from a container's changes |
|
||||||
| [history](history.md) | Show the history of an image |
|
| [image history](image_history.md) | Show the history of an image |
|
||||||
| [images](images.md) | List images |
|
| [image import](image_import.md) | Import the contents from a tarball to create a filesystem image |
|
||||||
| [import](import.md) | Import the contents from a tarball to create a filesystem image |
|
| [image load](image_load.md) | Load an image from a tar archive or STDIN |
|
||||||
| [load](load.md) | Load an image from a tar archive or STDIN |
|
| [image ls](image_ls.md) | List images |
|
||||||
| [image prune](image_prune.md) | Remove unused images |
|
| [image prune](image_prune.md) | Remove unused images |
|
||||||
| [rmi](rmi.md) | Remove one or more images |
|
| [image rm](image_rm.md) | Remove one or more images |
|
||||||
| [save](save.md) | Save images to a tar archive |
|
| [image save](image_save.md) | Save images to a tar archive |
|
||||||
| [tag](tag.md) | Tag an image into a repository |
|
| [image tag](image_tag.md) | Tag an image into a repository |
|
||||||
|
|
||||||
### Container commands
|
### Container commands
|
||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|:--------------------------------------|:-----------------------------------------------------------------|
|
| :---------------------------------------- | :-------------------------------------------------------------- |
|
||||||
| [attach](attach.md) | Attach to a running container |
|
| [container attach](container_attach.md) | Attach to a running container |
|
||||||
| [container prune](container_prune.md) | Remove all stopped containers |
|
| [container cp](container_cp.md) | Copy files/folders from a container to a HOSTDIR or to STDOUT |
|
||||||
| [cp](cp.md) | Copy files/folders from a container to a HOSTDIR or to STDOUT |
|
| [container create](container_create.md) | Create a new container |
|
||||||
| [create](create.md) | Create a new container |
|
| [container diff](container_diff.md) | Inspect changes on a container's filesystem |
|
||||||
| [diff](diff.md) | Inspect changes on a container's filesystem |
|
| [container exec](container_exec.md) | Execute a command in a running container |
|
||||||
| [events](events.md) | Get real time events from the server |
|
| [container export](container_export.md) | Export a container's filesystem as a tar archive |
|
||||||
| [exec](exec.md) | Execute a command in a running container |
|
| [container kill](container_kill.md) | Kill a running container |
|
||||||
| [export](export.md) | Export a container's filesystem as a tar archive |
|
| [container logs](container_logs.md) | Fetch the logs of a container |
|
||||||
| [kill](kill.md) | Kill a running container |
|
| [container ls](container_ls.md) | List containers |
|
||||||
| [logs](logs.md) | Fetch the logs of a container |
|
| [container pause](container_pause.md) | Pause all processes within a container |
|
||||||
| [pause](pause.md) | Pause all processes within a container |
|
| [container port](container_port.md) | List port mappings or a specific mapping for the container |
|
||||||
| [port](port.md) | List port mappings or a specific mapping for the container |
|
| [container prune](container_prune.md) | Remove all stopped containers |
|
||||||
| [ps](ps.md) | List containers |
|
| [container rename](container_rename.md) | Rename a container |
|
||||||
| [rename](rename.md) | Rename a container |
|
| [container restart](container_restart.md) | Restart a running container |
|
||||||
| [restart](restart.md) | Restart a running container |
|
| [container rm](container_rm.md) | Remove one or more containers |
|
||||||
| [rm](rm.md) | Remove one or more containers |
|
| [container run](container_run.md) | Create and run a new container from an image |
|
||||||
| [run](run.md) | Create and run a new container from an image |
|
| [container start](container_start.md) | Start one or more stopped containers |
|
||||||
| [start](start.md) | Start one or more stopped containers |
|
| [container stats](container_stats.md) | Display a live stream of container(s) resource usage statistics |
|
||||||
| [stats](stats.md) | Display a live stream of container(s) resource usage statistics |
|
| [container stop](container_stop.md) | Stop a running container |
|
||||||
| [stop](stop.md) | Stop a running container |
|
| [container top](container_top.md) | Display the running processes of a container |
|
||||||
| [top](top.md) | Display the running processes of a container |
|
| [container unpause](container_unpause.md) | Unpause all processes within a container |
|
||||||
| [unpause](unpause.md) | Unpause all processes within a container |
|
| [container update](container_update.md) | Update configuration of one or more containers |
|
||||||
| [update](update.md) | Update configuration of one or more containers |
|
| [container wait](container_wait.md) | Block until a container stops, then print its exit code |
|
||||||
| [wait](wait.md) | Block until a container stops, then print its exit code |
|
|
||||||
|
|
||||||
### Hub and registry commands
|
### Hub and registry commands
|
||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|:--------------------|:------------------------------------------------------------------------|
|
| :------------------ | :-------------------------------- |
|
||||||
| [login](login.md) | Log in to a registry |
|
| [login](login.md) | Log in to a registry |
|
||||||
| [logout](logout.md) | Log out from a registry |
|
| [logout](logout.md) | Log out from a registry |
|
||||||
| [pull](pull.md) | Download an image from a registry |
|
| [pull](pull.md) | Download an image from a registry |
|
||||||
| [push](push.md) | Upload an image to a registry |
|
| [push](push.md) | Upload an image to a registry |
|
||||||
| [search](search.md) | Search Docker Hub for images |
|
| [search](search.md) | Search Docker Hub for images |
|
||||||
|
|
||||||
### Network and connectivity commands
|
### Network and connectivity commands
|
||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|:--------------------------------------------|:-------------------------------------------------------|
|
| :------------------------------------------ | :----------------------------------------------------- |
|
||||||
| [network connect](network_connect.md) | Connect a container to a network |
|
| [network connect](network_connect.md) | Connect a container to a network |
|
||||||
| [network create](network_create.md) | Create a new network |
|
| [network create](network_create.md) | Create a new network |
|
||||||
| [network disconnect](network_disconnect.md) | Disconnect a container from a network |
|
| [network disconnect](network_disconnect.md) | Disconnect a container from a network |
|
||||||
|
|
@ -97,7 +96,7 @@ read the [`dockerd`](dockerd.md) reference page.
|
||||||
### Shared data volume commands
|
### Shared data volume commands
|
||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|:------------------------------------|:-----------------------------------------------------------------|
|
| :---------------------------------- | :--------------------------------------------------------------- |
|
||||||
| [volume create](volume_create.md) | Creates a new volume where containers can consume and store data |
|
| [volume create](volume_create.md) | Creates a new volume where containers can consume and store data |
|
||||||
| [volume inspect](volume_inspect.md) | Display information about a volume |
|
| [volume inspect](volume_inspect.md) | Display information about a volume |
|
||||||
| [volume ls](volume_ls.md) | Lists all the volumes Docker knows about |
|
| [volume ls](volume_ls.md) | Lists all the volumes Docker knows about |
|
||||||
|
|
@ -107,7 +106,7 @@ read the [`dockerd`](dockerd.md) reference page.
|
||||||
### Swarm node commands
|
### Swarm node commands
|
||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|:--------------------------------|:--------------------------------------------------------------|
|
| :------------------------------ | :------------------------------------------------------------ |
|
||||||
| [node demote](node_demote.md) | Demotes an existing manager so that it is no longer a manager |
|
| [node demote](node_demote.md) | Demotes an existing manager so that it is no longer a manager |
|
||||||
| [node inspect](node_inspect.md) | Inspect a node in the swarm |
|
| [node inspect](node_inspect.md) | Inspect a node in the swarm |
|
||||||
| [node ls](node_ls.md) | List nodes in the swarm |
|
| [node ls](node_ls.md) | List nodes in the swarm |
|
||||||
|
|
@ -119,19 +118,19 @@ read the [`dockerd`](dockerd.md) reference page.
|
||||||
### Swarm management commands
|
### Swarm management commands
|
||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|:----------------------------------------|:----------------------------------------------|
|
| :-------------------------------------- | :-------------------------------------------- |
|
||||||
| [swarm init](swarm_init.md) | Initialize a swarm |
|
| [swarm init](swarm_init.md) | Initialize a swarm |
|
||||||
|
| [swarm join-token](swarm_join-token.md) | Display or rotate join tokens |
|
||||||
| [swarm join](swarm_join.md) | Join a swarm as a manager node or worker node |
|
| [swarm join](swarm_join.md) | Join a swarm as a manager node or worker node |
|
||||||
| [swarm leave](swarm_leave.md) | Remove the current node from the swarm |
|
| [swarm leave](swarm_leave.md) | Remove the current node from the swarm |
|
||||||
| [swarm join-token](swarm_join-token.md) | Display or rotate join tokens |
|
|
||||||
| [swarm unlock](swarm_unlock.md) | Unlock swarm |
|
|
||||||
| [swarm unlock-key](swarm_unlock-key.md) | Manage the unlock key |
|
| [swarm unlock-key](swarm_unlock-key.md) | Manage the unlock key |
|
||||||
|
| [swarm unlock](swarm_unlock.md) | Unlock swarm |
|
||||||
| [swarm update](swarm_update.md) | Update attributes of a swarm |
|
| [swarm update](swarm_update.md) | Update attributes of a swarm |
|
||||||
|
|
||||||
### Swarm service commands
|
### Swarm service commands
|
||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|:--------------------------------------|:----------------------------------------------------------------|
|
| :------------------------------------ | :-------------------------------------------------------------- |
|
||||||
| [service create](service_create.md) | Create a new service |
|
| [service create](service_create.md) | Create a new service |
|
||||||
| [service inspect](service_inspect.md) | Inspect a service |
|
| [service inspect](service_inspect.md) | Inspect a service |
|
||||||
| [service logs](service_logs.md) | Fetch the logs of a service or task |
|
| [service logs](service_logs.md) | Fetch the logs of a service or task |
|
||||||
|
|
@ -144,7 +143,7 @@ read the [`dockerd`](dockerd.md) reference page.
|
||||||
### Swarm secret commands
|
### Swarm secret commands
|
||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|:-------------------------------------|:------------------------------------------------|
|
| :----------------------------------- | :---------------------------------------------- |
|
||||||
| [secret create](secret_create.md) | Create a secret from a file or STDIN as content |
|
| [secret create](secret_create.md) | Create a secret from a file or STDIN as content |
|
||||||
| [secret inspect](service_inspect.md) | Inspect the specified secret |
|
| [secret inspect](service_inspect.md) | Inspect the specified secret |
|
||||||
| [secret ls](secret_ls.md) | List secrets in the swarm |
|
| [secret ls](secret_ls.md) | List secrets in the swarm |
|
||||||
|
|
@ -153,18 +152,18 @@ read the [`dockerd`](dockerd.md) reference page.
|
||||||
### Swarm stack commands
|
### Swarm stack commands
|
||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|:------------------------------------|:--------------------------------------------------------|
|
| :---------------------------------- | :------------------------------------------------------ |
|
||||||
|
| [stack config](stack_config.md) | Output the Compose file after merges and interpolations |
|
||||||
| [stack deploy](stack_deploy.md) | Deploy a new stack or update an existing stack |
|
| [stack deploy](stack_deploy.md) | Deploy a new stack or update an existing stack |
|
||||||
| [stack ls](stack_ls.md) | List stacks in the swarm |
|
| [stack ls](stack_ls.md) | List stacks in the swarm |
|
||||||
| [stack ps](stack_ps.md) | List the tasks in the stack |
|
| [stack ps](stack_ps.md) | List the tasks in the stack |
|
||||||
| [stack rm](stack_rm.md) | Remove the stack from the swarm |
|
| [stack rm](stack_rm.md) | Remove the stack from the swarm |
|
||||||
| [stack services](stack_services.md) | List the services in the stack |
|
| [stack services](stack_services.md) | List the services in the stack |
|
||||||
| [stack config](stack_config.md) | Output the Compose file after merges and interpolations |
|
|
||||||
|
|
||||||
### Plugin commands
|
### Plugin commands
|
||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|:------------------------------------|:------------------------------------------------|
|
| :---------------------------------- | :---------------------------------------------- |
|
||||||
| [plugin create](plugin_create.md) | Create a plugin from a rootfs and configuration |
|
| [plugin create](plugin_create.md) | Create a plugin from a rootfs and configuration |
|
||||||
| [plugin disable](plugin_disable.md) | Disable a plugin |
|
| [plugin disable](plugin_disable.md) | Disable a plugin |
|
||||||
| [plugin enable](plugin_enable.md) | Enable a plugin |
|
| [plugin enable](plugin_enable.md) | Enable a plugin |
|
||||||
|
|
@ -178,13 +177,12 @@ read the [`dockerd`](dockerd.md) reference page.
|
||||||
### Context commands
|
### Context commands
|
||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|:--------------------------------------|:-------------------------------|
|
| :------------------------------------ | :----------------------------- |
|
||||||
| [context create](context_create.md) | Create a context |
|
| [context create](context_create.md) | Create a context |
|
||||||
| [context export](context_export.md) | Export a context |
|
| [context export](context_export.md) | Export a context |
|
||||||
| [context import](context_import.md) | Import a context |
|
| [context import](context_import.md) | Import a context |
|
||||||
|
| [context inspect](context_inspect.md) | Inspect one or more contexts |
|
||||||
| [context ls](context_ls.md) | List contexts |
|
| [context ls](context_ls.md) | List contexts |
|
||||||
| [context rm](context_rm.md) | Remove one or more contexts |
|
| [context rm](context_rm.md) | Remove one or more contexts |
|
||||||
| [context update](context_update.md) | Update a context |
|
| [context update](context_update.md) | Update a context |
|
||||||
| [context use](context_use.md) | Set the current docker context |
|
| [context use](context_use.md) | Set the current docker context |
|
||||||
| [context inspect](context_inspect.md) | Inspect one or more contexts |
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -114,13 +114,13 @@ $ docker attach 0246aa4d1448
|
||||||
For more information about `docker run` flags related to foreground and
|
For more information about `docker run` flags related to foreground and
|
||||||
background modes, see:
|
background modes, see:
|
||||||
|
|
||||||
- [`docker run --detach`](commandline/run.md#detach): run container in background
|
- [`docker run --detach`](commandline/container_run.md#detach): run container in background
|
||||||
- [`docker run --attach`](commandline/run.md#attach): attach to `stdin`, `stdout`, and `stderr`
|
- [`docker run --attach`](commandline/container_run.md#attach): attach to `stdin`, `stdout`, and `stderr`
|
||||||
- [`docker run --tty`](commandline/run.md#tty): allocate a pseudo-tty
|
- [`docker run --tty`](commandline/container_run.md#tty): allocate a pseudo-tty
|
||||||
- [`docker run --interactive`](commandline/run.md#interactive): keep `stdin` open even if not attached
|
- [`docker run --interactive`](commandline/container_run.md#interactive): keep `stdin` open even if not attached
|
||||||
|
|
||||||
For more information about re-attaching to a background container, see
|
For more information about re-attaching to a background container, see
|
||||||
[`docker attach`](commandline/attach.md).
|
[`docker attach`](commandline/container_attach.md).
|
||||||
|
|
||||||
## Container identification
|
## Container identification
|
||||||
|
|
||||||
|
|
@ -135,7 +135,7 @@ You can identify a container in three ways:
|
||||||
The UUID identifier is a random ID assigned to the container by the daemon.
|
The UUID identifier is a random ID assigned to the container by the daemon.
|
||||||
|
|
||||||
The daemon generates a random string name for containers automatically. You can
|
The daemon generates a random string name for containers automatically. You can
|
||||||
also defined a custom name using [the `--name` flag](./commandline/run.md#name).
|
also defined a custom name using [the `--name` flag](./commandline/container_run.md#name).
|
||||||
Defining a `name` can be a handy way to add meaning to a container. If you
|
Defining a `name` can be a handy way to add meaning to a container. If you
|
||||||
specify a `name`, you can use it when referring to the container in a
|
specify a `name`, you can use it when referring to the container in a
|
||||||
user-defined network. This works for both background and foreground Docker
|
user-defined network. This works for both background and foreground Docker
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue