Run a one-shot command.

Executes a command to completion and returns its stdout, stderr, exit code, and duration. Supports configurable timeout and output size limits.

POST /v1/processes/run

Run a one-shot command.

cURL

curl --request POST \
  --url http://localhost:2468/v1/processes/run \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "<string>",
  "args": [
    "<string>"
  ],
  "cwd": "<string>",
  "env": {},
  "maxOutputBytes": 1,
  "timeoutMs": 1
}
'

200

{
  "durationMs": 1,
  "stderr": "<string>",
  "stderrTruncated": true,
  "stdout": "<string>",
  "stdoutTruncated": true,
  "timedOut": true,
  "exitCode": 123
}

Body

application/json

command · string · required

args · string[]

cwd · string | null

env · object

Show child attributes

maxOutputBytes · integer | null

Required range: x >= 0

timeoutMs · integer<int64> | null

Required range: x >= 0

Response

200

application/json

One-off command result

durationMs · integer<int64> · required

Required range: x >= 0

stderr · string · required

stderrTruncated · boolean · required

stdout · string · required

stdoutTruncated · boolean · required

timedOut · boolean · required

exitCode · integer<int32> | null