mirror of https://github.com/docker/docs.git
82 lines
3.5 KiB
Markdown
82 lines
3.5 KiB
Markdown
---
|
|
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/
|
|
---
|
|
|
|
{{< include "compose-eol.md" >}}
|
|
|
|
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:
|
|
--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)
|
|
- [Try Compose](../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](../compose-file/_index.md)
|