`pnpm.run`

Run package scripts using pnpm

CLI

Package: @procedures/pnpm · README
Path: ["pnpm","run"]
CLI: mark pnpm run --script <string>
As data: {"$proc":["pnpm","run"],"input":{}}

Use it

In TypeScript

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

const client = new Client(new LocalTransport({ registry: PROCEDURE_REGISTRY }));
const result = await client.exec(["pnpm","run"], { script: "<script>" });
console.log(JSON.stringify(result));

From the command line

$ mark pnpm run --script <string>

As data, in a program

{ "$proc": ["pnpm", "run"], "input": { "script": "<script>" } }

Input

Field	Type	Required	Description
`script`	`string`	yes	Script name to run
`args`	`string[]`	no	Additional arguments to pass to the script
`cwd`	`string`	no	Working directory
`timeout`	`number`	no	Timeout in milliseconds

Output

Field	Type	Required	Description
`exitCode`	`number`	yes	The exit code of pnpm (0 is success)
`stdout`	`string`	yes	The standard output of pnpm
`stderr`	`string`	yes	The standard error of pnpm
`success`	`boolean`	yes	True when the exit code is 0
`duration`	`number`	yes	The time of the command, in milliseconds

JSON Schemas

{
  "input": {
    "type": "object",
    "properties": {
      "script": {
        "type": "string",
        "description": "Script name to run"
      },
      "args": {
        "description": "Additional arguments to pass to the script",
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "cwd": {
        "description": "Working directory",
        "type": "string"
      },
      "timeout": {
        "description": "Timeout in milliseconds",
        "type": "number"
      }
    },
    "required": [
      "script"
    ]
  },
  "output": {
    "type": "object",
    "properties": {
      "exitCode": {
        "type": "number",
        "description": "The exit code of pnpm (0 is success)"
      },
      "stdout": {
        "type": "string",
        "description": "The standard output of pnpm"
      },
      "stderr": {
        "type": "string",
        "description": "The standard error of pnpm"
      },
      "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": {}
  }
}