Skip to main content

​
Prerequisites

An OpenComputer API key and the SDK installed. See Introduction for install instructions. 
export OPENCOMPUTER_API_KEY=your-api-key
Grab your API key from app.opencomputer.dev

​
Create Your First Sandbox

import { Sandbox } from "@opencomputer/sdk";

const sandbox = await Sandbox.create();

// Run a command inside the sandbox
const result = await sandbox.commands.run("echo 'Hello World from OpenSandbox!'");
console.log(result.stdout);

await sandbox.kill();
Running this will print: 
Hello World from OpenSandbox!
Your sandboxes stay alive as long as you need them. They don’t shut down after a command finishes — you can keep running commands, installing packages, and building projects for hours or days. Sandboxes only stop when you explicitly kill them or when the idle timeout expires (default 5 minutes, configurable).

​
Next Steps

Elastic Compute

Scale memory and CPU at runtime based on workload

Upload & Download Files

Read, write, and transfer files to and from sandboxes

Custom Sandboxes

Build custom environments with your own packages and tools

Checkpoints

Snapshot and fork VMs for parallel experimentation