Define and run multi-container applications with Docker

docker docker-compose go golang orchestration

Go to file

Nicolas De loof bfa6312f63 Merge pull request #1825 from thaJeztah/bump_term2 go.mod: update moby/term and Azure/go-ansiterm		2021-06-21 22:37:39 +02:00
.github	…
aci	Move compose v2 implementation under pkg/compose with dependencies	2021-06-15 15:52:48 +02:00
api	Add docker compose logs --until option	2021-06-16 08:55:53 +08:00
cli	Add docker compose logs --until option	2021-06-16 08:55:53 +08:00
cmd	Merge branch 'main' of github.com:docker/compose-cli into docker_compose_logs_since_option	2021-06-16 08:57:02 +08:00
docs	move compose-plugin commands under /cmd	2021-06-15 15:52:48 +02:00
ecs	Move compose v2 implementation under pkg/compose with dependencies	2021-06-15 15:52:48 +02:00
internal	…
kube	Move compose v2 implementation under pkg/compose with dependencies	2021-06-15 15:52:48 +02:00
local	set container links and external links in network	2021-06-17 15:51:14 +02:00
packaging	…
pkg	don't apply restart_policy on `compose run`	2021-06-21 08:25:41 +02:00
scripts	…
utils	Move compose v2 implementation under pkg/compose with dependencies	2021-06-15 15:52:48 +02:00
.dockerignore	…
.gitattributes	…
.gitignore	…
.golangci.yml	…
BUILDING.md	…
CONTRIBUTING.md	…
Dockerfile	…
INSTALL.md	…
LICENSE	…
MAINTAINERS	…
Makefile	…
NOTICE	…
README.md	…
builder.Makefile	move compose-plugin commands under /cmd	2021-06-15 15:52:48 +02:00
go.mod	go.mod: update moby/term and Azure/go-ansiterm	2021-06-21 14:24:52 +02:00
go.sum	go.mod: update moby/term and Azure/go-ansiterm	2021-06-21 14:24:52 +02:00
import-restrictions.yaml	…

README.md

Docker Compose CLI

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
macOS: The Stable or Edge release of Docker Desktop
Linux: Install script
An AWS or Azure account in order to use the Compose Cloud integration

Please create issues to leave feedback.

Examples

Development

See the instructions in 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 which includes conventions used in this project.