Skip to main content

Installation

Note: The SDK is ESM-only. Use Node 18+ with "type": "module" (or .mjs/.mts) and top-level await, or use const { Sandbox } = await import("@opencomputer/sdk"); const { Image, Snapshots } = await import("@opencomputer/sdk/node"); in CommonJS.

Modules

Sandbox

Create, connect, and manage sandbox lifecycle

Usage & Tags

Query usage, group by tag, and manage sandbox tags

Exec

Run commands and manage exec sessions

Sandbox agent

Start and manage an agent session inside a sandbox (low-level; deprecated)

Filesystem

Read, write, and manage files

PTY

Interactive terminal sessions

Image

Declarative sandbox image builder

Snapshots

Pre-built sandbox environments

Secret Stores

Manage secrets and egress control