← All procedures

docker.compose.down

Stop services with docker compose

MCPCLI
Package
@procedures/docker · README
Path
["docker","compose","down"]
CLI
mark docker compose down
MCP tool
docker.compose.down on the dev-tools server
As data
{"$proc":["docker","compose","down"],"input":{}}

Use it

In TypeScript

import { Client, LocalTransport, PROCEDURE_REGISTRY } from "@procedures/client";
import "@procedures/docker"; // registers its procedures

const client = new Client(new LocalTransport({ registry: PROCEDURE_REGISTRY }));
const result = await client.exec(["docker","compose","down"], {});
console.log(JSON.stringify(result));

From the command line

$ mark docker compose down

As data, in a program

{ "$proc": ["docker", "compose", "down"], "input": {} }

Input

FieldTypeRequiredDefaultDescription
filestringnoCompose file path
volumesbooleannoRemove volumes
removeOrphansbooleannoRemove orphan containers
rmi"all" | "local"noRemove images (all, local)
cwdstringnoWorking directory
timeoutnumbernoTimeout in milliseconds

Output

FieldTypeRequiredDefaultDescription
exitCodenumberyesThe exit code of docker (0 is success)
stdoutstringyesThe standard output of docker
stderrstringyesThe standard error of docker, or the error message when docker did not start
successbooleanyesTrue when the exit code is 0
durationnumberyesThe time of the command, in milliseconds
JSON Schemas
{
  "input": {
    "type": "object",
    "properties": {
      "file": {
        "description": "Compose file path",
        "type": "string"
      },
      "volumes": {
        "description": "Remove volumes",
        "type": "boolean"
      },
      "removeOrphans": {
        "description": "Remove orphan containers",
        "type": "boolean"
      },
      "rmi": {
        "description": "Remove images (all, local)",
        "type": "string",
        "enum": [
          "all",
          "local"
        ]
      },
      "cwd": {
        "description": "Working directory",
        "type": "string"
      },
      "timeout": {
        "description": "Timeout in milliseconds",
        "type": "number"
      }
    }
  },
  "output": {
    "type": "object",
    "properties": {
      "exitCode": {
        "type": "number",
        "description": "The exit code of docker (0 is success)"
      },
      "stdout": {
        "type": "string",
        "description": "The standard output of docker"
      },
      "stderr": {
        "type": "string",
        "description": "The standard error of docker, or the error message when docker did not start"
      },
      "success": {
        "type": "boolean",
        "description": "True when the exit code is 0"
      },
      "duration": {
        "type": "number",
        "description": "The time of the command, in milliseconds"
      }
    },
    "required": [
      "exitCode",
      "stdout",
      "stderr",
      "success",
      "duration"
    ],
    "additionalProperties": {}
  }
}