Define and run multi-container applications with Docker
Go to file
Lorena Rangel d4b15d833b
Merge pull request #1721 from ndeloof/install
clarify compose 2 install as a CLI plugin
2021-05-31 15:57:01 +02:00
.github split compose-cli "docker" and composeV2 cli-plugin release processes 2021-05-27 12:46:39 +02:00
aci Merge pull request #1673 from steele/support-wsl1-azure-login 2021-05-21 11:24:57 +02:00
api improve container events watch robustness 2021-05-26 14:04:38 +02:00
cli Merge pull request #1707 from docker/up_follow 2021-05-31 10:54:40 +02:00
docs Update compose docs 2021-05-05 17:37:08 +02:00
ecs Add cp command 2021-05-01 18:20:52 -07:00
internal split compose-cli "docker" and composeV2 cli-plugin release processes 2021-05-27 12:46:39 +02:00
kube build: Update golangci-lint 2021-05-19 15:00:53 +00:00
local Merge pull request #1707 from docker/up_follow 2021-05-31 10:54:40 +02:00
packaging packaging: Add EULA 2020-09-22 15:04:16 +02:00
scripts split compose-cli "docker" and composeV2 cli-plugin release processes 2021-05-27 12:46:39 +02:00
utils attach to containers added by "scale" 2021-05-25 22:59:57 +02:00
.dockerignore packaging: Add EULA 2020-09-22 15:04:16 +02:00
.gitattributes Removed test requiring linux containers 2020-06-11 12:58:58 +02:00
.gitignore Add Azure sovereign cloud support 2021-02-15 18:38:59 -08:00
.golangci.yml build: Update golangci-lint 2021-05-19 15:00:53 +00:00
BUILDING.md Remove example backend. 2021-01-19 11:29:48 +01:00
CHANGELOG.md Rename docker/api -> docker/compose-cli 2020-08-21 17:28:39 +02:00
CONTRIBUTING.md contributing: Tidy and clarify 2020-09-03 15:54:20 +02:00
Dockerfile split compose-cli "docker" and composeV2 cli-plugin release processes 2021-05-27 12:46:39 +02:00
INSTALL.md install: Fix Linux install instructions and script 2020-09-25 17:01:00 +02:00
LICENSE Add LICENSE and NOTICE files 2020-08-17 10:20:49 +02:00
MAINTAINERS maintainers: Fix typo 2020-12-24 12:26:52 +01:00
Makefile split compose-cli "docker" and composeV2 cli-plugin release processes 2021-05-27 12:46:39 +02:00
NOTICE Update copyright 2020-09-22 12:13:00 +02:00
README.md clarify compose 2 install as a CLI plugin 2021-05-31 11:56:32 +02:00
builder.Makefile split compose-cli "docker" and composeV2 cli-plugin release processes 2021-05-27 12:46:39 +02:00
go.mod support compose file set by COMPOSE_FILE env var 2021-05-20 15:41:41 +02:00
go.sum support compose file set by COMPOSE_FILE env var 2021-05-20 15:41:41 +02:00
import-restrictions.yaml Remove example backend. 2021-01-19 11:29:48 +01:00
main.go split compose-cli "docker" and composeV2 cli-plugin release processes 2021-05-27 12:46:39 +02:00

README.md

Docker Compose CLI

Actions Status Actions Status

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 (ECS) or Microsoft Azure Container Instances (ACI) using the Docker commands you already know.

Note: Compose CLI is released under the 1.x tag, until "Compose v2" gets a new home

Compose v2 (a.k.a "Local Docker Compose")

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 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

Note: Compose v2 is released under the 2.x tag, until "Compose v2" gets a new home

Compose v2 can be installed manually as a CLI plugin, by downloading latest v2.x release from https://github.com/docker/compose-cli/releases for your architecture and move into ~/.docker/cli-plugins/docker-compose


## Getting started

To get started with Compose CLI, all you need is:

* Windows: The Stable or Edge release of
  [Docker Desktop](https://hub.docker.com/editions/community/docker-ce-desktop-windows)
* macOS: The Stable or Edge release of
  [Docker Desktop](https://hub.docker.com/editions/community/docker-ce-desktop-mac)
* Linux:
  [Install script](INSTALL.md)
* An [AWS](https://aws.amazon.com) or [Azure](https://azure.microsoft.com)
  account in order to use the Compose Cloud integration

Please create [issues](https://github.com/docker/compose-cli/issues) to leave feedback.

## Examples

* 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/)
* 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/)

## Development

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.

Before contributing, please read the [contribution guidelines](CONTRIBUTING.md)
which includes conventions used in this project.