Interface BoxExecuteCommandsParams

interface BoxExecuteCommandsParams {
    commands: string | string[];
    envs?: unknown;
    timeout?: string;
    workingDir?: string;
}

Properties

commands: string | string[]

The command to run. Can be a single string or an array of strings

envs?: unknown

The environment variables to run the command

timeout?: string

The timeout of the command. If the command times out, the exit code will be 124. For example: 'timeout 5s sleep 10s' will result in exit code 124.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: "500ms", "30s", "5m", "1h" Default: 30s

workingDir?: string

The working directory of the command. It not provided, the command will be run in the box.config.workingDir directory.