Run a command
Use executions when an agent or backend needs to run a command without opening SSH. Execution is asynchronous: create returns immediately, you poll until , then fetch output.Create
Start an execution. Returns immediately.Parameters
Parameters
string
required
The machine to run the command on.
string[]
required
argv array. The first element is the executable; the rest are arguments.string
Bytes to pipe to the process’s stdin.
object
Extra environment variables for this process.
string
default:"/root"
Working directory.
integer
Hard kill after this many milliseconds.
Retrieve
Get the current state of an execution. Use this to poll until terminal.Parameters
Parameters
List
List executions on a machine, newest first.Parameters
Parameters
Delete
Cancel a running execution. No-op if already terminated.Parameters
Parameters
Events
Per-execution event log: stdout/stderr chunks plus lifecycle transitions. Cursor-paginated.Parameters
Parameters
Output
Output returns the command’s capturedstdout and stderr after the execution finishes.
