id = "docker-compose" name = "docker-compose" description = "Define and run multi-container applications (Compose v1 command)." homepage = "https://docs.docker.com/compose/" executables = ["docker-compose"] [commands] format = 1 label = "Docker Compose" description = "Common jobs: start, stop, build and read logs for a Compose project. Run in the project directory." quality = "ai-draft" base = "fig:docker-compose" parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false } [[commands.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/docker-compose.ts" license = "MIT" [[commands.field]] id = "file" label = "Compose file" type = "path" path = { kind = "file", role = "input" } option = ["--file", "-f"] multiple = true sources = ["fig"] [[commands.field]] id = "project_name" label = "Project name" type = "string" option = ["--project-name", "-p"] sources = ["fig"] [[commands.group]] id = "basic" label = "Basic" fields = ["file", "project_name"] [[commands.subcommand]] path = ["up"] label = "Create and start containers" [[commands.subcommand.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/docker-compose.ts" license = "MIT" [[commands.subcommand.field]] id = "services" label = "Services" type = "string" position = 0 multiple = true sources = ["fig"] [[commands.subcommand.field]] id = "detach" label = "Run in the background" type = "boolean" option = ["--detach", "-d"] sources = ["fig"] [[commands.subcommand.field]] id = "build" label = "Build images first" type = "boolean" option = ["--build"] sources = ["fig"] [[commands.subcommand.field]] id = "force_recreate" label = "Recreate containers" type = "boolean" option = ["--force-recreate"] sources = ["fig"] [[commands.subcommand.field]] id = "remove_orphans" label = "Remove orphan containers" type = "boolean" option = ["--remove-orphans"] effect = "delete" sources = ["fig"] [[commands.subcommand.field]] id = "wait" label = "Wait until running or healthy" type = "boolean" option = ["--wait"] sources = ["fig"] [[commands.subcommand.task]] id = "background" label = "Start in the background" set = { detach = [true] } fields = ["services", "detach", "build"] required = [] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["services", "detach", "build"] [[commands.subcommand.group]] id = "advanced" label = "Advanced" fields = ["force_recreate", "remove_orphans", "wait"] [[commands.subcommand]] path = ["down"] label = "Stop and remove containers and networks" [[commands.subcommand.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/docker-compose.ts" license = "MIT" [[commands.subcommand.field]] id = "volumes" label = "Also remove volumes" type = "boolean" option = ["--volumes", "-v"] effect = "delete" sources = ["fig"] [[commands.subcommand.field]] id = "remove_orphans" label = "Remove orphan containers" type = "boolean" option = ["--remove-orphans"] effect = "delete" sources = ["fig"] [[commands.subcommand.field]] id = "timeout" label = "Shutdown timeout (seconds)" type = "integer" option = ["--timeout", "-t"] sources = ["fig"] [[commands.subcommand.task]] id = "down" label = "Stop the project" fields = ["remove_orphans", "timeout"] required = [] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["volumes", "remove_orphans", "timeout"] [[commands.subcommand]] path = ["logs"] label = "View container logs" [[commands.subcommand.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/docker-compose.ts" license = "MIT" [[commands.subcommand.field]] id = "services" label = "Services" type = "string" position = 0 multiple = true sources = ["fig"] [[commands.subcommand.field]] id = "follow" label = "Follow output" type = "boolean" option = ["--follow", "-f"] sources = ["fig"] [[commands.subcommand.field]] id = "tail" label = "Lines from the end" type = "string" option = ["--tail"] suggestions = [{ value = "all", label = "all" }, { value = "100", label = "100" }] sources = ["fig"] [[commands.subcommand.field]] id = "timestamps" label = "Show timestamps" type = "boolean" option = ["--timestamps", "-t"] sources = ["fig"] [[commands.subcommand.field]] id = "since" label = "Since (timestamp or 42m)" type = "string" option = ["--since"] sources = ["fig"] [[commands.subcommand.task]] id = "follow" label = "Follow recent logs" set = { follow = [true], tail = ["100"] } fields = ["services", "follow", "tail", "timestamps"] required = [] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["services", "follow", "tail", "timestamps", "since"] [[commands.subcommand]] path = ["build"] label = "Build or rebuild services" [[commands.subcommand.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/docker-compose.ts" license = "MIT" [[commands.subcommand.field]] id = "services" label = "Services" type = "string" position = 0 multiple = true sources = ["fig"] [[commands.subcommand.field]] id = "no_cache" label = "Do not use cache" type = "boolean" option = ["--no-cache"] sources = ["fig"] [[commands.subcommand.field]] id = "pull" label = "Always pull newer base images" type = "boolean" option = ["--pull"] sources = ["fig"] [[commands.subcommand.field]] id = "build_arg" label = "Build argument (KEY=value)" type = "string" option = ["--build-arg"] multiple = true sources = ["fig"] [[commands.subcommand.task]] id = "clean" label = "Clean rebuild" set = { no_cache = [true], pull = [true] } fields = ["services", "no_cache", "pull"] required = [] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["services", "no_cache", "pull", "build_arg"]