Define and run multi-container applications with Docker
Go to file
Nicolas De Loof b6552cd935
add support for detach keys on compose run|exec
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2021-06-29 17:27:43 +02:00
.github pending label auto-removal on new comment 2021-06-24 09:51:58 +02:00
aci prefer canonical `compose.yaml` file name 2021-06-22 11:23:57 +02:00
api Move compose v2 implementation under pkg/compose with dependencies 2021-06-15 15:52:48 +02:00
cli Look for docker cli next to the current executable 2021-06-22 10:39:04 +02:00
cmd pass --force and --volumes options to backend 2021-06-25 13:46:34 +02: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 split compose-cli "docker" and composeV2 cli-plugin release processes 2021-05-27 12:46:39 +02:00
kube Move compose v2 implementation under pkg/compose with dependencies 2021-06-15 15:52:48 +02:00
local introduce `convergence` to hold per-service Containers and prevent race conditions 2021-06-25 13:18:00 +02:00
packaging packaging: Add EULA 2020-09-22 15:04:16 +02:00
pkg add support for detach keys on compose run|exec 2021-06-29 17:27:43 +02:00
scripts split compose-cli "docker" and composeV2 cli-plugin release processes 2021-05-27 12:46:39 +02:00
utils Move compose v2 implementation under pkg/compose with dependencies 2021-06-15 15:52:48 +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 add support for detach keys on compose run|exec 2021-06-29 17:27:43 +02:00
BUILDING.md Remove example backend. 2021-01-19 11:29:48 +01: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 Fix readme: remove extra single quotes 2021-05-31 16:41:42 +02:00
builder.Makefile move compose-plugin commands under /cmd 2021-06-15 15:52:48 +02:00
go.mod don't create unecessary resources 2021-06-24 10:11:41 +02:00
go.sum test 2021-06-24 10:11:01 +02:00
import-restrictions.yaml Remove example backend. 2021-01-19 11:29:48 +01: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:

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.