mix docker.compose (Tds v2.3.6)

View Source

CLI wrapper around docker compose for starting and stopping development services.

Commands

  • mix docker.compose up
  • mix docker.compose down

The up command always runs in detached mode (docker compose ... up -d). The down command stops all services (docker compose ... down).


Options

  • -f, --file PATH Use a specific compose file instead of the default:

    mix docker.compose up -f docker-compose.test.yml
  • -p, --profile NAME Use a specific compose profile:

    mix docker.compose up --profile mssql_amd64

Profile selection rules

If no -f/--file is provided:

  • docker-compose.yml is used
  • if no --profile is given:
    • the profile is auto-selected based on host architecture:
      • mssql_arm64 on ARM / Apple Silicon
      • mssql_amd64 on x86_64
  • if --profile is given:
    • that profile is used explicitly

If -f/--file is provided:

  • that compose file is used
  • if no --profile is given:
    • no --profile flag is passed to Docker
  • if --profile is given:
    • that profile is passed to Docker

Examples

Basic usage (auto-selected profile):

mix docker.compose up
mix docker.compose down

Custom compose file:

mix docker.compose up -f docker-compose.test.yml
mix docker.compose down -f docker-compose.test.yml

Explicit profile:

mix docker.compose up --profile mssql_amd64

Summary

Functions

Callback implementation for Mix.Task.run/1.

Functions

run(args)

Callback implementation for Mix.Task.run/1.