Skip to main content
See Runtime setup and Cloud for setup examples.

​
Microsandbox

​
Microsandbox.version

Returns

String
SDK version.

​
Microsandbox.installed?

Returns

Boolean
Whether a complete local runtime installation is available.

​
Microsandbox.install()

Install the local runtime using the global configuration.

Returns

nil
No return value.

​
Microsandbox.default_backend_kind

Returns

String
Current backend: local or cloud.

​
Microsandbox.use_local_backend!()

Select the local backend for subsequent operations.

Returns

nil
No return value.

​
Microsandbox.set_runtime_msb_path()

Override the process-wide msb path. Set it before creating local sandboxes.

Parameters

pathString
Path to the runtime executable.

Returns

nil
No return value.

​
Microsandbox.set_runtime_libkrunfw_path()

Override the process-wide libkrunfw path. Set it before creating local sandboxes.

Parameters

pathString
Path to the kernel firmware library.

Returns

nil
No return value.

​
Microsandbox.use_cloud_backend!()

Select the cloud backend for subsequent operations.

Parameters

api_keyString
Cloud API key.
urlString | nil
Optional API URL; nil uses the default cloud endpoint.

Returns

nil
No return value.

​
Microsandbox.use_cloud_profile!()

Select a named cloud profile.

Parameters

nameString
Configured cloud profile name.

Returns

nil
No return value.