--- title: Filesystem "og:title": Ruby SDK Filesystem reference description: Read, write, and transfer guest files with the Ruby SDK. --- See [Filesystem](/sandboxes/filesystem) for usage examples. ## Sandbox #### sandbox.fs ```ruby 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() ```ruby fs.read(path) # => String ``` ```ruby puts sandbox.fs.read("/tmp/message.txt") ``` Read file bytes.

Parameters

pathString
Guest path.

Returns

String
File contents as bytes.
#### fs.write() ```ruby fs.write(path, data) # => nil ``` ```ruby 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() ```ruby fs.mkdir(path) # => nil ``` Create a guest directory.

Parameters

pathString
Guest path.

Returns

nil
No return value.
#### fs.list() ```ruby fs.list(path) # => Array ``` List directory entries.

Parameters

pathString
Guest path.

Returns

Array<Hash>
Directory entries.
#### fs.stat() ```ruby fs.stat(path) # => Hash ``` Read metadata.

Parameters

pathString
Guest path.

Returns

Hash
File metadata.
#### fs.exists?() ```ruby fs.exists?(path) # => Boolean ``` Check whether a path exists.

Parameters

pathString
Guest path.

Returns

Boolean
Whether the path exists.
#### fs.copy() ```ruby 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() ```ruby 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() ```ruby fs.remove(path) # => nil ``` Remove a file.

Parameters

pathString
Guest path.

Returns

nil
No return value.
#### fs.remove_dir() ```ruby fs.remove_dir(path) # => nil ``` Remove a directory.

Parameters

pathString
Guest path.

Returns

nil
No return value.
#### fs.copy_from_host() ```ruby 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() ```ruby fs.copy_to_host(guest_path, host_path) # => nil ``` ```ruby 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.