Ruby SDK Execution reference

See Commands for usage examples.

Sandbox

sandbox.exec()

sandbox.exec(command, args = [], **options) # => ExecOutput

Example

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()

sandbox.shell(script, **options) # => ExecOutput

Example

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()

sandbox.logs(**options) # => Array<LogEntry>

Example

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

output.stdout # => String

Returns

String

Collected output bytes.

output.stderr

output.stderr # => String

Returns

String

Collected output bytes.

output.stdout_bytes

output.stdout_bytes # => String

Returns

String

Binary output aliases.

output.stderr_bytes

output.stderr_bytes # => String

Returns

String

Binary output aliases.

output.exit_code

output.exit_code # => Integer

Returns

Integer

Process exit code.

output.success?

output.success? # => Boolean

Returns

Boolean

Whether execution succeeded.

output.to_h()

output.to_h # => Hash

Returns

Hash

String keys: stdout, stderr, exit_code, success.

LogEntry

entry.timestamp

entry.timestamp # => String

Returns

String

RFC 3339 timestamp

entry.source

entry.source # => String

Returns

String

Log source

entry.data

entry.data # => String

Returns

String

Raw log bytes

entry.to_h()

entry.to_h # => Hash

Returns

Hash

String keys matching the members above

Getting Started

SDKs

CLI

Execution

Sandbox

sandbox.exec()

sandbox.shell()

sandbox.logs()

ExecOutput

output.stdout

output.stderr

output.stdout_bytes

output.stderr_bytes

output.exit_code

output.success?

output.to_h()

LogEntry

entry.timestamp

entry.source

entry.data

entry.to_h()

​Sandbox

​sandbox.exec()

​sandbox.shell()

​sandbox.logs()

​ExecOutput

​output.stdout

​output.stderr

​output.stdout_bytes

​output.stderr_bytes

​output.exit_code

​output.success?

​output.to_h()

​LogEntry

​entry.timestamp

​entry.source

​entry.data

​entry.to_h()

Sandbox

sandbox.exec()

sandbox.shell()

sandbox.logs()

ExecOutput

output.stdout

output.stderr

output.stdout_bytes

output.stderr_bytes

output.exit_code

output.success?

output.to_h()

LogEntry

entry.timestamp

entry.source

entry.data

entry.to_h()