Hello World

What You’ll Learn

Creating a sandbox with Sandbox.create()
Running a shell command with sbx.commands.run()
Reading command output via result.stdout and result.exit_code
Using the async API with AsyncSandbox (Python)
Proper cleanup with try/finally and sbx.kill()

Prerequisites

Code Walkthrough

Python
TypeScript

Import both the synchronous and asynchronous sandbox classes:

from declaw import AsyncSandbox, Sandbox

Synchronous usage — create a sandbox, run a command, clean up:

def sync_example() -> None:
    sbx = Sandbox.create(template="base", timeout=300)
    try:
        print(f"Sandbox created: {sbx.sandbox_id}")

        result = sbx.commands.run('echo "Hello from Declaw sandbox!"')
        print(f"stdout: {result.stdout}")
        print(f"exit_code: {result.exit_code}")
    finally:
        sbx.kill()
        print("Sandbox killed.")

Async usage — identical flow using await:

async def async_example() -> None:
    sbx = await AsyncSandbox.create(template="base", timeout=300)
    try:
        print(f"Sandbox created: {sbx.sandbox_id}")

        result = await sbx.run_command('echo "Hello from async Declaw sandbox!"')
        print(f"stdout: {result.stdout}")
        print(f"exit_code: {result.exit_code}")
    finally:
        await sbx.kill()
        print("Sandbox killed.")

Run both from main():

import asyncio

def main() -> None:
    sync_example()
    asyncio.run(async_example())

Import the Sandbox class:

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

Create a sandbox, run a command, and clean up in a try/finally block:

async function main(): Promise<void> {
  const sbx = await Sandbox.create({ template: "base", timeout: 300 });
  try {
    console.log(`Sandbox created: ${sbx.sandboxId}`);

    const result = await sbx.commands.run('echo "Hello from Declaw sandbox!"');
    console.log(`stdout: ${result.stdout}`);
    console.log(`exit_code: ${result.exitCode}`);
  } finally {
    await sbx.kill();
    console.log("Sandbox killed.");
  }
}

main().catch(console.error);

The TypeScript SDK uses camelCase properties (sandboxId, exitCode) while Python uses snake_case (sandbox_id, exit_code).

Expected Output

==================================================
Declaw Hello World Example
==================================================

--- Sync: Creating Sandbox ---
Sandbox created: sbx_abc123

--- Sync: Running Command ---
stdout: Hello from Declaw sandbox!
exit_code: 0

--- Sync: Cleaning Up ---
Sandbox killed.

--- Async: Creating Sandbox ---
Sandbox created: sbx_def456

--- Async: Running Command ---
stdout: Hello from async Declaw sandbox!
exit_code: 0

--- Async: Cleaning Up ---
Sandbox killed.

==================================================
Done!
==================================================

Overview Sandbox Lifecycle

Getting Started

Built-in Templates

Commands

PTY

OpenAI Agents

Filesystem

Volumes

Network Policies

PII Protection

Security Features

LLM Providers

Framework Integrations

Agent-in-Sandbox

Real-World Patterns

Security Demos

What You’ll Learn

Prerequisites

Code Walkthrough

Expected Output

​What You’ll Learn

​Prerequisites

​Code Walkthrough

​Expected Output

What You’ll Learn

Prerequisites

Code Walkthrough

Expected Output