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","pull"], { image: "<image>" });
console.log(JSON.stringify(result));From the command line
$ mark docker pull --image <string>
As data, in a program
{ "$proc": ["docker", "pull"], "input": { "image": "<image>" } }JSON Schemas
{
"input": {
"type": "object",
"properties": {
"image": {
"type": "string",
"description": "Image to pull"
},
"tag": {
"description": "Image tag (default: latest)",
"type": "string"
},
"cwd": {
"description": "Working directory",
"type": "string"
},
"timeout": {
"description": "Timeout in milliseconds",
"type": "number"
}
},
"required": [
"image"
]
},
"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": {}
}
}