mirror of https://github.com/docker/docs.git
compose: use plugin base cmd as cli overview
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
parent
547c602f50
commit
07a053763f
|
@ -60,7 +60,7 @@ underscores, and must begin with a lowercase letter or decimal digit. If the
|
||||||
`basename` of the project directory or current directory violates this
|
`basename` of the project directory or current directory violates this
|
||||||
constraint, you must use one of the other mechanisms.
|
constraint, you must use one of the other mechanisms.
|
||||||
|
|
||||||
See also the [command-line options overview](../reference/index.md#command-options-overview-and-help) and [using `-p` to specify a project name](../reference/index.md#use--p-to-specify-a-project-name).
|
See also the [command-line options overview](/reference/cli/docker/compose/_index.md#command-options-overview-and-help) and [using `-p` to specify a project name](/reference/cli/docker/compose/_index.md#use--p-to-specify-a-project-name).
|
||||||
|
|
||||||
### COMPOSE\_FILE
|
### COMPOSE\_FILE
|
||||||
|
|
||||||
|
@ -75,7 +75,7 @@ The path separator can also be customized using `COMPOSE_PATH_SEPARATOR`.
|
||||||
|
|
||||||
Example: `COMPOSE_FILE=docker-compose.yml:docker-compose.prod.yml`.
|
Example: `COMPOSE_FILE=docker-compose.yml:docker-compose.prod.yml`.
|
||||||
|
|
||||||
See also the [command-line options overview](../reference/index.md#command-options-overview-and-help) and [using `-f` to specify name and path of one or more Compose files](../reference/index.md#use--f-to-specify-name-and-path-of-one-or-more-compose-files).
|
See also the [command-line options overview](/reference/cli/docker/compose/_index.md#command-options-overview-and-help) and [using `-f` to specify name and path of one or more Compose files](/reference/cli/docker/compose/_index.md#use--f-to-specify-name-and-path-of-one-or-more-compose-files).
|
||||||
|
|
||||||
### COMPOSE\_PROFILES
|
### COMPOSE\_PROFILES
|
||||||
|
|
||||||
|
@ -90,7 +90,7 @@ For example, calling `docker compose up`with `COMPOSE_PROFILES=frontend` selects
|
||||||
Example: `COMPOSE_PROFILES=frontend,debug`
|
Example: `COMPOSE_PROFILES=frontend,debug`
|
||||||
This example enables all services matching both the `frontend` and `debug` profiles and services without a profile.
|
This example enables all services matching both the `frontend` and `debug` profiles and services without a profile.
|
||||||
|
|
||||||
See also [Using profiles with Compose](../profiles.md) and the [`--profile` command-line option](../reference/index.md#use---profile-to-specify-one-or-more-active-profiles).
|
See also [Using profiles with Compose](../profiles.md) and the [`--profile` command-line option](/reference/cli/docker/compose/_index.md#use---profile-to-specify-one-or-more-active-profiles).
|
||||||
|
|
||||||
### COMPOSE\_CONVERT\_WINDOWS\_PATHS
|
### COMPOSE\_CONVERT\_WINDOWS\_PATHS
|
||||||
|
|
||||||
|
|
|
@ -1,81 +0,0 @@
|
||||||
---
|
|
||||||
description: Overview of the Docker Compose CLI
|
|
||||||
keywords: fig, composition, compose, docker, orchestration, cli, reference, docker-compose
|
|
||||||
title: Overview of docker compose CLI
|
|
||||||
aliases:
|
|
||||||
- /compose/reference/overview/
|
|
||||||
---
|
|
||||||
|
|
||||||
This page provides usage information for the `docker compose` command.
|
|
||||||
|
|
||||||
## Command options overview and help
|
|
||||||
|
|
||||||
You can also see this information by running `docker compose --help` from the
|
|
||||||
command line.
|
|
||||||
|
|
||||||
```text
|
|
||||||
Usage: docker compose [OPTIONS] COMMAND
|
|
||||||
|
|
||||||
Define and run multi-container applications with Docker
|
|
||||||
|
|
||||||
Options:
|
|
||||||
--all-resources Include all resources, even those not used by services
|
|
||||||
--ansi string Control when to print ANSI control characters ("never"|"always"|"auto") (default "auto")
|
|
||||||
--compatibility Run compose in backward compatibility mode
|
|
||||||
--dry-run Execute command in dry run mode
|
|
||||||
--env-file stringArray Specify an alternate environment file
|
|
||||||
-f, --file stringArray Compose configuration files
|
|
||||||
--parallel int Control max parallelism, -1 for unlimited (default -1)
|
|
||||||
--profile stringArray Specify a profile to enable
|
|
||||||
--progress string Set type of progress output (auto, tty, plain, quiet) (default "auto")
|
|
||||||
--project-directory string Specify an alternate working directory
|
|
||||||
(default: the path of the, first specified, Compose file)
|
|
||||||
-p, --project-name string Project name
|
|
||||||
|
|
||||||
Commands:
|
|
||||||
attach Attach local standard input, output, and error streams to a service's running container
|
|
||||||
build Build or rebuild services
|
|
||||||
config Parse, resolve and render compose file in canonical format
|
|
||||||
cp Copy files/folders between a service container and the local filesystem
|
|
||||||
create Creates containers for a service
|
|
||||||
down Stop and remove containers, networks
|
|
||||||
events Receive real time events from containers
|
|
||||||
exec Execute a command in a running container
|
|
||||||
images List images used by the created containers
|
|
||||||
kill Force stop service containers
|
|
||||||
logs View output from containers
|
|
||||||
ls List running compose projects
|
|
||||||
pause Pause services
|
|
||||||
port Print the public port for a port binding
|
|
||||||
ps List containers
|
|
||||||
pull Pull service images
|
|
||||||
push Push service images
|
|
||||||
restart Restart service containers
|
|
||||||
rm Removes stopped service containers
|
|
||||||
run Run a one-off command on a service
|
|
||||||
scale Scale services
|
|
||||||
start Start services
|
|
||||||
stats Display a live stream of container(s) resource usage statistics
|
|
||||||
stop Stop services
|
|
||||||
top Display the running processes
|
|
||||||
unpause Unpause services
|
|
||||||
up Create and start containers
|
|
||||||
version Show the Docker Compose version information
|
|
||||||
wait Block until the first service container stops
|
|
||||||
watch Watch build context for service and rebuild/refresh containers when files are updated
|
|
||||||
|
|
||||||
|
|
||||||
Run 'docker compose COMMAND --help' for more information on a command.
|
|
||||||
```
|
|
||||||
|
|
||||||
You can use Docker Compose binary, `docker compose [-f <arg>...] [options]
|
|
||||||
[COMMAND] [ARGS...]`, to build and manage multiple services in Docker containers.
|
|
||||||
|
|
||||||
## Useful resources
|
|
||||||
|
|
||||||
- [How Compose works](../compose-application-model.md)
|
|
||||||
- [Quickstart](../gettingstarted.md)
|
|
||||||
- [Specify a project name](../project-name.md)
|
|
||||||
- [Using environment variables](../environment-variables/_index.md)
|
|
||||||
- [Working with multiple Compose files](../multiple-compose-files/_index.md)
|
|
||||||
- [Compose Specification](/reference/compose-file/_index.md)
|
|
|
@ -281,7 +281,7 @@ the way you define and share multi-service applications.
|
||||||
Related information:
|
Related information:
|
||||||
- [Compose overview](/compose/_index.md)
|
- [Compose overview](/compose/_index.md)
|
||||||
- [Compose file reference](/reference/compose-file/_index.md)
|
- [Compose file reference](/reference/compose-file/_index.md)
|
||||||
- [Compose CLI reference](/compose/reference/_index.md)
|
- [Compose CLI reference](/reference/cli/docker/compose/_index.md)
|
||||||
|
|
||||||
## Next steps
|
## Next steps
|
||||||
|
|
||||||
|
|
|
@ -71,7 +71,7 @@ $ docker compose down
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information about Compose commands, see the [Compose CLI
|
For more information about Compose commands, see the [Compose CLI
|
||||||
reference](../../compose/reference/_index.md).
|
reference](/reference/cli/docker/compose/_index.md).
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
|
|
|
@ -111,7 +111,7 @@ $ docker compose down
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information about Compose commands, see the [Compose CLI
|
For more information about Compose commands, see the [Compose CLI
|
||||||
reference](../../compose/reference/_index.md).
|
reference](/reference/cli/docker/compose/_index.md).
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
|
|
|
@ -315,7 +315,7 @@ $ docker compose down
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information about Compose commands, see the
|
For more information about Compose commands, see the
|
||||||
[Compose CLI reference](../../compose/reference/_index.md).
|
[Compose CLI reference](/reference/cli/docker/compose/_index.md).
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
|
|
|
@ -266,7 +266,7 @@ $ docker compose down
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information about Compose commands, see the [Compose CLI
|
For more information about Compose commands, see the [Compose CLI
|
||||||
reference](../../compose/reference/_index.md).
|
reference](/reference/cli/docker/compose/_index.md).
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
|
|
|
@ -112,7 +112,7 @@ $ docker compose down
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information about Compose commands, see the [Compose CLI
|
For more information about Compose commands, see the [Compose CLI
|
||||||
reference](../../compose/reference/_index.md).
|
reference](/reference/cli/docker/compose/_index.md).
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
|
|
|
@ -356,7 +356,7 @@ $ docker compose down
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information about Compose commands, see the [Compose CLI
|
For more information about Compose commands, see the [Compose CLI
|
||||||
reference](../../compose/reference/_index.md).
|
reference](/reference/cli/docker/compose/_index.md).
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
|
|
|
@ -78,7 +78,7 @@ $ docker compose down
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information about Compose commands, see the [Compose CLI
|
For more information about Compose commands, see the [Compose CLI
|
||||||
reference](../../compose/reference/_index.md).
|
reference](/reference/cli/docker/compose/_index.md).
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
|
|
|
@ -377,7 +377,7 @@ $ docker compose down
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information about Compose commands, see the [Compose CLI
|
For more information about Compose commands, see the [Compose CLI
|
||||||
reference](../../compose/reference/_index.md).
|
reference](/reference/cli/docker/compose/_index.md).
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
|
|
|
@ -20,7 +20,7 @@ grid_clis:
|
||||||
description: The CLI for Docker Compose, for building and running multi-container
|
description: The CLI for Docker Compose, for building and running multi-container
|
||||||
applications.
|
applications.
|
||||||
icon: subtitles
|
icon: subtitles
|
||||||
link: /compose/reference/
|
link: /reference/cli/docker/compose/
|
||||||
- title: Daemon CLI (dockerd)
|
- title: Daemon CLI (dockerd)
|
||||||
description: Persistent process that manages containers.
|
description: Persistent process that manages containers.
|
||||||
icon: developer_board
|
icon: developer_board
|
||||||
|
|
|
@ -6,6 +6,7 @@ aliases:
|
||||||
- /compose/reference/docker-compose/
|
- /compose/reference/docker-compose/
|
||||||
- /compose/reference/help/
|
- /compose/reference/help/
|
||||||
- /engine/reference/commandline/compose/
|
- /engine/reference/commandline/compose/
|
||||||
|
- /compose/reference/
|
||||||
layout: cli
|
layout: cli
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
@ -413,8 +413,8 @@ Reference:
|
||||||
title: docker checkpoint rm
|
title: docker checkpoint rm
|
||||||
- sectiontitle: docker compose
|
- sectiontitle: docker compose
|
||||||
section:
|
section:
|
||||||
- path: /compose/reference/
|
- path: /reference/cli/docker/compose/
|
||||||
title: overview
|
title: docker compose
|
||||||
- path: /reference/cli/docker/compose/alpha/
|
- path: /reference/cli/docker/compose/alpha/
|
||||||
title: docker compose alpha
|
title: docker compose alpha
|
||||||
- path: /reference/cli/docker/compose/alpha/dry-run/
|
- path: /reference/cli/docker/compose/alpha/dry-run/
|
||||||
|
@ -425,8 +425,6 @@ Reference:
|
||||||
title: docker compose alpha scale
|
title: docker compose alpha scale
|
||||||
- path: /reference/cli/docker/compose/alpha/viz/
|
- path: /reference/cli/docker/compose/alpha/viz/
|
||||||
title: docker compose alpha viz
|
title: docker compose alpha viz
|
||||||
- path: /reference/cli/docker/compose/
|
|
||||||
title: docker compose
|
|
||||||
- path: /reference/cli/docker/compose/build/
|
- path: /reference/cli/docker/compose/build/
|
||||||
title: docker compose build
|
title: docker compose build
|
||||||
- path: /reference/cli/docker/compose/config/
|
- path: /reference/cli/docker/compose/config/
|
||||||
|
|
Loading…
Reference in New Issue