Options for running a command in a sandbox.
interface RunOptionsWorking directory for command execution.
Environment variables to set for the command.
Idle timeout in seconds. If the command has no connected clients for this duration, it is killed. Defaults to 300 (5 minutes). Set to -1 for no idle timeout.
If true, kill the command immediately when the last client disconnects. Defaults to false (command continues running and can be reconnected to).
Callback invoked with each stderr chunk during streaming execution. When provided, WebSocket streaming is used.
Callback invoked with each stdout chunk during streaming execution. When provided, WebSocket streaming is used.
If true, allocate a pseudo-terminal (PTY) for the command. Useful for commands that require a TTY (e.g., interactive programs, commands that use terminal control codes). Defaults to false.
Shell to use for command execution. Defaults to "/bin/bash".
How long (in seconds) a finished command's session is kept for reconnection. Defaults to 600 (10 minutes). Set to -1 to keep indefinitely.
Whether to wait for the command to complete before returning. When true (default), returns an ExecutionResult. When false, returns a CommandHandle for streaming output.