Define and run multi-container applications with Docker
Go to file
Chris Crone d543ef3064 build: Include go cache where module cache is used
Signed-off-by: Chris Crone <christopher.crone@docker.com>
2021-05-19 14:59:21 +00:00
.github rebase workflow 2021-04-14 08:02:51 +02:00
aci Merge pull request #1623 from JulienTant/1391-add-cp 2021-05-06 15:49:51 +02:00
api ps shows healthcheck only for running container 2021-05-17 10:02:47 +02:00
cli Merge pull request #1675 from ndeloof/ps_exitcode 2021-05-17 16:31:43 +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 Separate compose CLI plugin version from Cloud integration version 2021-04-27 09:16:41 +02:00
kube Add cp command 2021-05-01 18:20:52 -07:00
local Merge pull request #1679 from ndeloof/build_args 2021-05-17 16:32:38 +02:00
packaging packaging: Add EULA 2020-09-22 15:04:16 +02:00
scripts Install compose cli plugin in addition to compose-cli binary with scripted install 2021-04-23 11:34:22 +02:00
utils Handle Ctrl+C for compose CLI plugin. 2021-04-23 10:21:05 +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 Extract interface / types to allow unit tests / mock 2020-05-15 10:15:56 +02: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 build: Include go cache where module cache is used 2021-05-19 14:59:21 +00: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 Add make install to symlink cli from `make cli` 2021-02-22 15:27:11 +01:00
NOTICE Update copyright 2020-09-22 12:13:00 +02:00
README.md Update readme and clarify relation to docker-compose 2021-04-26 16:34:36 +02:00
builder.Makefile Bump compose beta version 2021-05-05 15:25:26 +02:00
go.mod pass authprovider to buildkit session in addition to driver's Auth parameter 2021-05-07 11:49:20 +02:00
go.sum pass authprovider to buildkit session in addition to driver's Auth parameter 2021-05-07 11:49:20 +02:00
import-restrictions.yaml Remove example backend. 2021-01-19 11:29:48 +01:00
main.go Separate compose CLI plugin version from Cloud integration version 2021-04-27 09:16:41 +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.

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

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.