← All procedures

docker.compose.up

Start services with docker compose

MCPCLI
Package
@procedures/docker · README
Path
["docker","compose","up"]
CLI
mark docker compose up
MCP tool
docker.compose.up on the dev-tools server
As data
{"$proc":["docker","compose","up"],"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","up"], {});
console.log(JSON.stringify(result));

From the command line

$ mark docker compose up

As data, in a program

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

Input

FieldTypeRequiredDefaultDescription
filestringnoCompose file path
servicesstring[]noServices to start (default: all)
detachbooleannoDetached mode
buildbooleannoBuild images before starting
forceRecreatebooleannoForce recreate containers
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"
      },
      "services": {
        "description": "Services to start (default: all)",
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "detach": {
        "description": "Detached mode",
        "type": "boolean"
      },
      "build": {
        "description": "Build images before starting",
        "type": "boolean"
      },
      "forceRecreate": {
        "description": "Force recreate containers",
        "type": "boolean"
      },
      "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": {}
  }
}