Quickstart

# Authenticate (opens browser for WorkOS device flow)
runtools login

# Create a sandbox
runtools sandbox create --name my-first-sandbox --template base-ubuntu

# Run a command in the sandbox
runtools sandbox exec my-first-sandbox "echo Hello from RunTools!"

# SSH into the sandbox
runtools sandbox ssh my-first-sandbox

import { RunTools } from '@runtools/sdk';

const rt = new RunTools({ apiKey: process.env.RUNTOOLS_API_KEY });

// Create a sandbox
const sandbox = await rt.sandbox.create({ template: 'base-ubuntu' });
await sandbox.waitForReady();

// Execute commands
const result = await sandbox.exec('echo "Hello from RunTools!"');
console.log(result.stdout); // "Hello from RunTools!"

https://{port}-{sandboxId}.sandboxes.runtools.ai

https://3000-sandbox-abc123.sandboxes.runtools.ai

# Pause the sandbox (saves full VM state, stops billing)
runtools sandbox pause my-first-sandbox

# Later: resume in under a second
runtools sandbox resume my-first-sandbox

# Your processes are still running!

await sandbox.pause();
// ... later ...
await sandbox.resume();

# Destroy the sandbox when done
runtools sandbox destroy my-first-sandbox

npm install @runtools/sdk

runtools init my-app
cd my-app

my-app/
├── runtools.config.ts       # Project configuration
├── agents/
│   └── assistant.ts         # Example agent
├── tools/
│   └── example.ts           # Example custom tool
├── sandboxes/
│   └── dev-env.ts           # Sandbox definition
├── package.json
└── tsconfig.json

# Deploy tools and agents to your org
runtools deploy

# Create sandboxes defined in sandboxes/
runtools deploy --sandboxes-only