2020-08-21 17:14:03 +02:00
# Docker Compose CLI
2020-04-06 10:40:40 -04:00
2020-08-21 17:24:53 +02:00
[](https://github.com/docker/compose-cli/actions)
2021-01-05 17:37:31 +01:00
[](https://github.com/docker/compose-cli/actions)
2020-05-03 15:25:50 +02:00
2021-04-26 16:34:36 +02:00
This Compose CLI tool makes it easy to run Docker containers and Docker Compose applications:
* locally as a command in the docker CLI, using `docker compose ...` comands.
* in the cloud using either Amazon Elastic Container Service
2020-08-21 17:14:03 +02:00
([ECS ](https://aws.amazon.com/ecs ))
or Microsoft Azure Container Instances
([ACI ](https://azure.microsoft.com/services/container-instances ))
using the Docker commands you already know.
2021-05-27 12:10:37 +02:00
**Note: Compose CLI is released under the 1.x tag, until "Compose v2" gets a new home**
2020-04-06 10:40:40 -04:00
2021-05-27 12:10:37 +02:00
## Compose v2 (a.k.a "Local Docker Compose")
2021-04-26 16:34:36 +02:00
The `docker compose` local command is meant to be the next major version for docker-compose, and it supports the same commands and flags, in order to be used as a drop-in replacement.
[Here ](https://github.com/docker/compose-cli/issues/1283 ) is a checklist of docker-compose commands and flags that are implemented in `docker compose` .
This `docker compose` local command :
* has a better integration with the rest of the docker ecosystem (being written in go, it's easier to share functionality with the Docker CLI and other Docker libraries)
* is quicker and uses more parallelism to run multiple tasks in parallel. It also uses buildkit by default
* includes additional commands, like `docker compose ls` to list current compose projects
2021-05-27 12:10:37 +02:00
**Note: Compose v2 is released under the 2.x tag, until "Compose v2" gets a new home**
2021-04-26 16:34:36 +02:00
## Getting started
To get started with Compose CLI, all you need is:
2021-01-06 11:05:05 +01:00
2020-09-24 17:53:44 +01:00
* Windows: The Stable or Edge release of
2020-08-21 17:14:03 +02:00
[Docker Desktop ](https://hub.docker.com/editions/community/docker-ce-desktop-windows )
2020-09-24 17:53:44 +01:00
* macOS: The Stable or Edge release of
2020-08-21 17:14:03 +02:00
[Docker Desktop ](https://hub.docker.com/editions/community/docker-ce-desktop-mac )
* Linux:
2020-08-25 12:31:48 +02:00
[Install script ](INSTALL.md )
2021-04-26 16:34:36 +02:00
* An [AWS ](https://aws.amazon.com ) or [Azure ](https://azure.microsoft.com )
account in order to use the Compose Cloud integration
2020-05-04 23:50:00 +02:00
2020-11-02 10:26:58 +01:00
Please create [issues ](https://github.com/docker/compose-cli/issues ) to leave feedback.
2020-05-04 23:50:00 +02:00
2020-08-21 17:14:03 +02:00
## Examples
2020-05-04 23:50:00 +02:00
2020-08-21 17:14:03 +02:00
* ECS: [Deploying Wordpress to the cloud ](https://www.docker.com/blog/deploying-wordpress-to-the-cloud/ )
* ACI: [Deploying a Minecraft server to the cloud ](https://www.docker.com/blog/deploying-a-minecraft-docker-server-to-the-cloud/ )
2020-11-02 10:26:58 +01:00
* ACI: [Setting Up Cloud Deployments Using Docker, Azure and Github Actions ](https://www.docker.com/blog/setting-up-cloud-deployments-using-docker-azure-and-github-actions/ )
2020-04-06 10:43:36 -04:00
2020-09-01 10:04:01 +02:00
## Development
2020-04-06 10:43:36 -04:00
2020-09-01 10:04:01 +02:00
See the instructions in [BUILDING.md ](BUILDING.md ) for how to build the CLI and
run its tests; including the end to end tests for local containers, ACI, and
ECS.
The guide also includes instructions for releasing the CLI.
2020-07-06 09:40:35 +02:00
2020-09-01 10:04:01 +02:00
Before contributing, please read the [contribution guidelines ](CONTRIBUTING.md )
which includes conventions used in this project.
