modal
    Preparing search index...

    Type Alias SandboxExecParams

    Optional parameters for Sandbox.exec().

    type SandboxExecParams = {
        env?: Record<string, string>;
        mode?: StreamMode;
        pty?: boolean;
        secrets?: Secret[];
        stderr?: StdioBehavior;
        stdout?: StdioBehavior;
        timeoutMs?: number;
        workdir?: string;
    }
    Index

    Properties

    env? mode? pty? secrets? stderr? stdout? timeoutMs? workdir?

    Properties

    env?: Record<string, string>

    Environment variables to set for the command.

    mode?: StreamMode

    Specifies text or binary encoding for input and output streams.

    pty?: boolean

    Enable a PTY for the command. When enabled, all output (stdout and stderr from the process) is multiplexed into stdout, and the stderr stream is effectively empty.

    secrets?: Secret[]

    Secrets to inject as environment variables for the commmand.

    stderr?: StdioBehavior

    Whether to pipe or ignore standard error.

    stdout?: StdioBehavior

    Whether to pipe or ignore standard output.

    timeoutMs?: number

    Timeout for the process in milliseconds. Defaults to 0 (no timeout).

    workdir?: string

    Working directory to run the command in.

    Settings

    Member Visibility

    On This Page

    Properties