Ruby SDK Filesystem reference

See Filesystem for usage examples.

Sandbox

sandbox.fs

sandbox.fs # => Microsandbox::Filesystem

Get the filesystem helper for this sandbox.

Returns

Microsandbox::Filesystem

Guest filesystem operations.

Filesystem

These helpers also have direct sandbox equivalents: sandbox.fs_read, fs_write, fs_mkdir, fs_list, fs_stat, fs_exists?, fs_copy, fs_rename, fs_remove, fs_remove_dir, fs_copy_from_host, and fs_copy_to_host, with the same arguments and return values.

fs.read()

fs.read(path) # => String

Example

puts sandbox.fs.read("/tmp/message.txt")

Read file bytes.

Parameters

pathString

Guest path.

Returns

String

File contents as bytes.

fs.write()

fs.write(path, data) # => nil

Example

sandbox.fs.write("/tmp/message.txt", "hello")

Write a Ruby string as bytes.

Parameters

pathString

Guest path.

dataString

File contents as bytes.

Returns

nil

No return value.

fs.mkdir()

fs.mkdir(path) # => nil

Create a guest directory.

Parameters

pathString

Guest path.

Returns

nil

No return value.

fs.list()

fs.list(path) # => Array<Hash>

List directory entries.

Parameters

pathString

Guest path.

Returns

Array<Hash>

Directory entries.

fs.stat()

fs.stat(path) # => Hash

Read metadata.

Parameters

pathString

Guest path.

Returns

Hash

File metadata.

fs.exists?()

fs.exists?(path) # => Boolean

Check whether a path exists.

Parameters

pathString

Guest path.

Returns

Boolean

Whether the path exists.

fs.copy()

fs.copy(from, to) # => nil

Copy within the guest.

Parameters

fromString

Source guest path.

toString

Destination guest path.

Returns

nil

No return value.

fs.rename()

fs.rename(from, to) # => nil

Rename within the guest.

Parameters

fromString

Source guest path.

toString

Destination guest path.

Returns

nil

No return value.

fs.remove()

fs.remove(path) # => nil

Remove a file.

Parameters

pathString

Guest path.

Returns

nil

No return value.

fs.remove_dir()

fs.remove_dir(path) # => nil

Remove a directory.

Parameters

pathString

Guest path.

Returns

nil

No return value.

fs.copy_from_host()

fs.copy_from_host(host_path, guest_path) # => nil

Transfer from host to guest.

Parameters

host_pathString

Path on the host.

guest_pathString

Path inside the guest.

Returns

nil

No return value.

fs.copy_to_host()

fs.copy_to_host(guest_path, host_path) # => nil

Example

sandbox.fs.copy_to_host("/tmp/message.txt", "./message.txt")

Transfer from guest to host.

Parameters

guest_pathString

Path inside the guest.

host_pathString

Path on the host.

Returns

nil

No return value.

Metadata

Hashes use string keys. Optional timestamps are omitted when unavailable. Ruby does not expose streaming filesystem handles.

Fields

”path”String

Entry path; returned by list.

”kind”String

file, directory, symlink, or other.

”size”Integer

Size in bytes.

”mode”Integer

File mode.

”uid”, “gid”Integer

Owner and group IDs.

”modified”, “accessed”String

RFC 3339 timestamps, when available.

”readonly”Boolean

Returned by stat.

”created”String

Creation timestamp, when available from stat.

Getting Started

SDKs

CLI

Filesystem

Sandbox

sandbox.fs

Filesystem

fs.read()

fs.write()

fs.mkdir()

fs.list()

fs.stat()

fs.exists?()

fs.copy()

fs.rename()

fs.remove()

fs.remove_dir()

fs.copy_from_host()

fs.copy_to_host()

Metadata

​Sandbox

​sandbox.fs

​Filesystem

​fs.read()

​fs.write()

​fs.mkdir()

​fs.list()

​fs.stat()

​fs.exists?()

​fs.copy()

​fs.rename()

​fs.remove()

​fs.remove_dir()

​fs.copy_from_host()

​fs.copy_to_host()

​Metadata

Sandbox

sandbox.fs

Filesystem

fs.read()

fs.write()

fs.mkdir()

fs.list()

fs.stat()

fs.exists?()

fs.copy()

fs.rename()

fs.remove()

fs.remove_dir()

fs.copy_from_host()

fs.copy_to_host()

Metadata