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","ps"], {});
console.log(JSON.stringify(result));From the command line
$ mark docker ps
As data, in a program
{ "$proc": ["docker", "ps"], "input": {} }JSON Schemas
{
"input": {
"type": "object",
"properties": {
"all": {
"description": "Show all containers (default shows just running)",
"type": "boolean"
},
"filter": {
"description": "Filter containers",
"type": "string"
},
"format": {
"description": "Format output",
"type": "string"
},
"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": {}
}
}