Docker-compose command compatibility list

[gtardif]

Check list of commands and flags, from docker-compose help

• build Build or rebuild services

  • Compose: support --build-arg key=val  #1360 --build-arg key=val Set build-time variables for services.
  • Add compose build flags for compatibility #1440 --compress Compress the build context using gzip
  • Add compose build flags for compatibility #1440 --force-rm Always remove intermediate containers.
  • Implement missing build flags to better align with docker-compose #1468 -m, --memory MEM Set memory limit for the build container. - not yet supported in buildkit
  • Implement missing build flags to better align with docker-compose #1468 --no-cache Do not use cache when building the image.
  • Implement missing build flags to better align with docker-compose #1468 --no-rm Do not remove intermediate containers after a successful build.
  • Add compose build flags for compatibility #1440 --parallel Build images in parallel.
  • Compose: Support compose build --progress  #1358 --progress string Set type of progress output (auto, plain, tty).
  • Compose: support compose build --pull #1359 --pull Always attempt to pull a newer version of the image.
  • Support compose build --quiet #1280 -q, --quiet Don't print anything to STDOUT

• config Validate and view the Compose file

  • Support compose config --resolve-image-digests #1286 --resolve-image-digests Pin image tags to digests.
  • --no-interpolate Don't interpolate environment variables.
  • Support compose build --quiet #1280 -q, --quiet Only validate the configuration, don't print anything.
  • --services Print the service names, one per line.
  • --volumes Print the volume names, one per line.
  • --hash="*" Print the service config hash, one per line.
  • --profiles does not exist yet in docker-compose but has been requested

• create Create services

  • Support compose create --force-recreate #1277 --force-recreate Recreate containers even if their configuration and image haven't changed. Incompatible with --no-recreate.
  • Support compose create --force-recreate #1277 --no-recreate If containers already exist, don't recreate them. Incompatible with --force-recreate.
  • Support compose up --no-build #1291 --no-build Don't build an image, even if it's missing.
  • Support compose create --build #1292 --build Build images before creating containers.

• down Stop and remove resources

  • Support compose down --rmi #1269 --rmi type Remove images.
  • Support compose down --volumes #1268 -v, --volumes Remove named volumes declared in the volumes section of the Compose file and anonymous volumes attached to containers.
  • --remove-orphans Remove containers for services not defined in the Compose file
  • Support compose down --timeout TIMEOUT #1275 -t, --timeout TIMEOUT Specify a shutdown timeout in seconds.

• introduce docker compose events #1396 events Receive real time events from containers.

  • --json Output events as a stream of json objects

• Support compose exec #1266 exec Execute a command in a running container

  • -d, --detach Detached mode: Run command in the background.
  • --privileged Give extended privileges to the process.
  • -u, --user USER Run the command as this user.
  • -T Disable pseudo-tty allocation. By default docker-compose exec allocates a TTY.
  • --index=index index of the container if there are multiple instances of a service [default: 1]
  • -e, --env KEY=VAL Set environment variables (can be used multiple times not supported in API < 1.25)
  • -w, --workdir DIR Path to workdir directory for this command.

• help Get help on a command

• images List images.

  • -q, --quiet Only display IDs

• kill Kill containers

  • -s SIGNAL SIGNAL to send to the container. Default signal is SIGKILL.

• logs View output from containers

  • Support compose logs --no-color #1270 --no-color Produce monochrome output.
  • support logs --follow #1060 -f, --follow Follow log output.
  • Support compose logs --timestamps #1272 -t, --timestamps Show timestamps.
  • --tail="all" Number of lines to show from the end of the log for each container.
  • Support compose logs --no-log-prefix #1271 --no-log-prefix Don't print prefix in logs.

• pause Pause services

• Support build.context with git URLs #1439 port Print the public port for a port binding

  • --protocol=proto tcp or udp [default: tcp]
  • --index=index index of the container if there are multiple instances of a service [default: 1]

• ps List containers

  • -q, --quiet Only display IDs
  • Support compose ps --services #1273 --services Display services
  • --filter KEY=VAL Filter services by a property
  • -a, --all Show all stopped containers (including those created by the run command)

• pull Pull service images

  • Support compose push --ignore-push-failures #1276 --ignore-pull-failures Pull what it can and ignores images with pull failures.
  • --parallel Deprecated, pull multiple images in parallel (enabled by default).
  • --no-parallel Disable parallel pulling.
  • Support compose build --quiet #1280 -q, --quiet Pull without printing progress information
  • Compose : support compose pull --include-deps #1361 --include-deps Also pull services declared as dependencies

• push Push service images

  • Support compose push --ignore-push-failures #1276 --ignore-push-failures Push what it can and ignores images with push failures.

• Support compose restart command #1389 restart Restart services

  • -t, --timeout TIMEOUT Specify a shutdown timeout in seconds. (default: 10)

• introduce compose rm command #1299 rm Remove stopped containers

  • -f, --force Don't ask to confirm removal
  • -s, --stop Stop the containers, if required, before removing
  • -v Remove any anonymous volumes attached to containers
  • -a, --all Deprecated - no effect.

• run Run a one-off command

  • -d, --detach Detached mode: Run container in the background, print new container name.
  • --name NAME Assign a name to the container
  • --entrypoint CMD Override the entrypoint of the image.
  • -e KEY=VAL Set an environment variable (can be used multiple times)
  • -l, --label KEY=VAL Add or override a label (can be used multiple times)
  • -u, --user="" Run as specified username or uid
  • Compose : support compose run --no-deps #1362 --no-deps Don't start linked services.
  • --rm Remove container after run. Ignored in detached mode.
  • Compose: support compose run --publish=[] #1363 -p, --publish=[] Publish a container's port(s) to the host
  • --service-ports Run command with the service's ports enabled and mapped to the host.
  • Support compose run --use-aliases #1364 --use-aliases Use the service's network aliases in the network(s) the container connects to.
  • Support compose run -v, --volume=[]  #1365 -v, --volume=[] Bind mount a volume (default [])
  • -T Disable pseudo-tty allocation. By default docker-compose run allocates a TTY.
  • -w, --workdir="" Working directory inside the container

• scale Set number of containers for a service deprecated

  • -t, --timeout TIMEOUT Specify a shutdown timeout in seconds. (default: 10)

• start Start services

• stop Stop services

  • -t, --timeout TIMEOUT Specify a shutdown timeout in seconds. (default: 10)

• Support compose top #1367 top Display the running processes

• unpause Unpause services

• up Create and start containers

  • -d, --detach Detached mode: Run containers in the background, print new container names. Incompatible with --abort-on-container-exit.
  • --no-color Produce monochrome output.
  • Support compose up --quiet-pull #1368 --quiet-pull Pull without printing progress information
  • Support compose up --no-deps #1369 --no-deps Don't start linked services.
  • --force-recreate Recreate containers even if their configuration and image haven't changed.
  • Support compose up --always-recreate-deps #1370 --always-recreate-deps Recreate dependent containers. Incompatible with --no-recreate.
  • --no-recreate If containers already exist, don't recreate them. Incompatible with --force-recreate and -V.
  • Support compose up --no-build #1291 --no-build Don't build an image, even if it's missing.
  • --no-start Don't start the services after creating them.
  • --build Build images before starting containers.
  • --abort-on-container-exit Stops all containers if any container was stopped. Incompatible with -d.
  • Support compose up --attach-dependencies  #1371 --attach-dependencies Attach to dependent containers.
  • Support compose up -t, --timeout TIMEOUT  #1372 -t, --timeout TIMEOUT Use this timeout in seconds for container shutdown when attached or when containers are
    already running. (default: 10)
  • Support compose up -V, --renew-anon-volumes  #1373 -V, --renew-anon-volumes Recreate anonymous volumes instead of retrieving data from the previous containers.
  • --remove-orphans Remove containers for services not defined in the Compose file.
  • --exit-code-from SERVICE Return the exit code of the selected service container. Implies --abort-on-container-exit.
  • add support for up --scale #1287 --scale SERVICE=NUM Scale SERVICE to NUM instances. Overrides the scale setting in the Compose file if present.
  • --no-log-prefix Don't print prefix in logs.

• version Show version information and quit

  • --short Shows only Compose's version number.

Common options:

• -f, --file FILE Specify an alternate compose file (default: docker-compose.yml)
• -p, --project-name NAME Specify an alternate project name (default: directory name)
• --profile NAME Specify a profile to enable
• -c, --context NAME Specify a context name at Docker cli root level
• --verbose Show more output
• --log-level LEVEL Set log level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
• --ansi (never|always|auto) Control when to print ANSI control characters Wait for users request, this might not be that useful
• --no-ansi Do not print ANSI control characters (DEPRECATED) Wait for users request, this might not be that useful
• -v, --version Print version and exit at Docker cli root level
• Support compose with docker client connection options #1293 -H, --host HOST Daemon socket to connect to
• Support compose with docker client connection options #1293 --tls Use TLS; implied by --tlsverify
• Support compose with docker client connection options #1293 --tlscacert CA_PATH Trust certs signed only by this CA
• Support compose with docker client connection options #1293 --tlscert CLIENT_CERT_PATH Path to TLS certificate file
• Support compose with docker client connection options #1293 --tlskey TLS_KEY_PATH Path to TLS key file
• Support compose with docker client connection options #1293 --tlsverify Use TLS and verify the remote
• Support compose with docker client connection options #1293 --skip-hostname-check Don't check the daemon's hostname against the name specified in the client certificate
• Support compose common flag --project-directory #1279 --project-directory PATH Specify an alternate working directory (default: the path of the Compose file)
• --compatibility If set, Compose will attempt to convert keys in v3 files to their non-Swarm equivalent (DEPRECATED)
• --env-file PATH Specify an alternate environment file

[BretFisher]

I recommend this issue be pinned!

[ndeloof]

all commands and flags (but --verbose, not applicable) are now supported, so closing