docker-compose

Define and run multi-container applications with Docker

Subcommands

NameDescription
buildBuild or rebuild services
config, convertConverts the compose file to platform's canonical format
cpCopy files/folders between a service container and the local filesystem
createCreates containers for a service
downStop and remove containers, networks
eventsReceive real time events from containers
execExecute a command in a running container
imagesList images used by the created containers
killForce stop service containers
logsView output from containers
lsList running compose projects
pausePause services
portPrint the public port for a port binding
psList containers
pullPull service images
pushPush service images
restartRestart containers
rmRemoves stopped service containers
runRun a one-off command on a service
startStart services
stopStop services
topDisplay the running processes
unpauseUnpause services
upCreate and start containers
versionShow the Docker Compose version information

Options

NameDescription
--ansi <ansi>Control when to print ANSI control characters ("never"|"always"|"auto")
--compatibilityRun compose in backward compatibility mode
--env-file <env-file>Specify an alternate environment file
--file, -f <file>
  • Repeatable ♾
--no-ansiDo not print ANSI control characters (DEPRECATED)
--profile <profile>
  • Repeatable ♾
--project-directory <project-directory>Specify an alternate working directory (default: the path of the, first specified, Compose file)
--project-name, -p <project-name>Project name
--verboseShow more output
--workdir <workdir>DEPRECATED! USE --project-directory INSTEAD. Specify an alternate working directory (default: the path of the, first specified, Compose file)