2020-08-21 17:14:03 +02:00
|
|
|
# Docker Compose CLI
|
2020-04-06 16:40:40 +02:00
|
|
|
|
2020-08-21 17:24:53 +02:00
|
|
|
[![Actions Status](https://github.com/docker/compose-cli/workflows/Continuous%20integration/badge.svg)](https://github.com/docker/compose-cli/actions)
|
2020-09-15 12:31:33 +02:00
|
|
|
[![Actions Status](https://github.com/docker/compose-cli/workflows/Cloud%20integration%20tests/badge.svg)](https://github.com/docker/compose-cli/actions)
|
2020-05-03 15:25:50 +02:00
|
|
|
|
2020-08-21 17:14:03 +02:00
|
|
|
This CLI tool makes it easy to run containers in the cloud using either Amazon
|
|
|
|
Elastic Container Service
|
|
|
|
([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.
|
2020-04-06 16:40:40 +02:00
|
|
|
|
2020-08-21 17:14:03 +02:00
|
|
|
To get started, all you need is:
|
|
|
|
* An [AWS](https://aws.amazon.com) or [Azure](https://azure.microsoft.com)
|
|
|
|
account
|
2020-09-01 10:04:01 +02:00
|
|
|
* Windows: The Edge release of
|
2020-08-21 17:14:03 +02:00
|
|
|
[Docker Desktop](https://hub.docker.com/editions/community/docker-ce-desktop-windows)
|
|
|
|
* macOS: The Edge release of
|
|
|
|
[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)
|
2020-05-04 23:50:00 +02:00
|
|
|
|
2020-08-21 17:14:03 +02:00
|
|
|
:warning: *This CLI is currently in beta 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-04-06 16:43:36 +02:00
|
|
|
|
2020-09-01 10:04:01 +02:00
|
|
|
## Development
|
2020-04-06 16:43:36 +02: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.
|