--- title: Execution "og:title": Ruby SDK Execution reference description: Run commands and collect output with the Ruby SDK. --- See [Commands](/sandboxes/commands) for usage examples. ## Sandbox #### sandbox.exec() ```ruby sandbox.exec(command, args = [], **options) # => ExecOutput ``` ```ruby output = sandbox.exec("printf", ["hello\n"], timeout: 10) puts output.stdout raise "Command failed" unless output.success? ``` Run an executable and collect its output. Shell syntax is not interpreted. Ruby does not expose streaming execution handles.

Parameters

commandString
Executable to run.
argsArray<String>
Command arguments; defaults to an empty array.
cwdString
Guest working directory.
userString
Guest user.
envHash
Environment variables.
timeoutNumeric
Finite, non-negative timeout in seconds.
stdinString | :null | :pipe
Input bytes or stdin mode. Ruby does not expose a writable streaming handle.
ttyBoolean
Allocate a pseudo-terminal.
rlimitsHash
Resource names mapped to non-negative integer limits.

Returns

ExecOutput
Collected stdout, stderr, and exit status.
#### sandbox.shell() ```ruby sandbox.shell(script, **options) # => ExecOutput ``` ```ruby output = sandbox.shell("ls /tmp && echo done") puts output.stdout ``` Run a script through the sandbox's configured shell. Accepts the same per-call options as `exec()`.

Parameters

scriptString
Shell script to execute.
optionsHash
The cwd, user, env, timeout, stdin, tty, and rlimits options documented above.

Returns

ExecOutput
Collected stdout, stderr, and exit status.
#### sandbox.logs() ```ruby sandbox.logs(**options) # => Array ``` ```ruby sandbox.logs(tail: 100, sources: [:stdout, :stderr]).each do |entry| puts entry.data end ``` Collect log entries from the connected sandbox. This does not subscribe to a stream.

Parameters

tailInteger
Optional maximum number of recent entries.
sourcesArray<Symbol | String>
Optional filter: stdout, stderr, output, or system.

Returns

Array<LogEntry>
Collected log entries.
## ExecOutput #### output.stdout ```ruby output.stdout # => String ```

Returns

String
Collected output bytes.
#### output.stderr ```ruby output.stderr # => String ```

Returns

String
Collected output bytes.
#### output.stdout_bytes ```ruby output.stdout_bytes # => String ```

Returns

String
Binary output aliases.
#### output.stderr_bytes ```ruby output.stderr_bytes # => String ```

Returns

String
Binary output aliases.
#### output.exit_code ```ruby output.exit_code # => Integer ```

Returns

Integer
Process exit code.
#### output.success? ```ruby output.success? # => Boolean ```

Returns

Boolean
Whether execution succeeded.
#### output.to_h() ```ruby output.to_h # => Hash ```

Returns

Hash
String keys: stdout, stderr, exit_code, success.
## LogEntry #### entry.timestamp ```ruby entry.timestamp # => String ```

Returns

String
RFC 3339 timestamp.
#### entry.source ```ruby entry.source # => String ```

Returns

String
Log source.
#### entry.data ```ruby entry.data # => String ```

Returns

String
Raw log bytes.
#### entry.to_h() ```ruby entry.to_h # => Hash ```

Returns

Hash
String keys matching the members above.