Skip to content

Sandbox

View as Markdown

Sandbox provides a durable environment for running commands and working with files in a Project. Its compute can stop and resume. Explicit Volume mounts preserve files across Sessions.

Why use Sandbox?

An agent or developer often needs a working environment across several commands or sessions. Sandbox gives that work a stable identity, with explicit controls for starting compute, preserving files, and inspecting execution history.

What you can do

  • Create an environment from an OCI image and execute commands in it.
  • Start, stop, or restart its compute Session.
  • Inspect Sessions and manage supported Snapshots.
  • Mount Volumes where files must persist, or use an environment without mounts for disposable work.

Core concepts

A Sandbox is the environment that lasts until you delete it. A Session is one period of running compute. A Volume mount connects a persistent Volume to an explicit path in the Sandbox.

New Sandboxes have no Volume mounts by default. Use --mounts to map paths such as /home to existing Volume IDs. Files outside mounted paths do not persist across Sessions. Deleting a Sandbox retains its mounted Volumes. Executing a command can start or resume compute when needed.

Use Sandbox

Read the CLI reference for commands or the API reference for resources, request fields, and responses.