Interfaces
CommandStartOpts
Options for commands.run.
Properties
Section titled “Properties”background?
Section titled “background?”
optionalbackground?:boolean
Start detached and resolve with a CommandHandle at once.
optionalcwd?:string
Working directory (default /work; relative paths resolve against /work).
optionalenvs?:Record<string,string>
Added to the sandbox-level envs.
onStderr?
Section titled “onStderr?”
optionalonStderr?: (data) =>void
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
onStdout?
Section titled “onStdout?”
optionalonStdout?: (data) =>void
Output callbacks, called as data arrives. A character whose bytes arrive in two pieces is delivered whole, with the later piece. Foreground only (for background commands, pass them to handle.wait()).
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
stdin?
Section titled “stdin?”
optionalstdin?:string|Uint8Array<ArrayBufferLike>
Sent to the command, then closed (at most 16 MiB). Foreground only.
timeoutMs?
Section titled “timeoutMs?”
optionaltimeoutMs?:number
Kill the command after this long (ms, default 60000; 0 = no limit). Foreground only.
