opensandbox-group--opensandbox/docs/getting-started/index.md

title, description

title	description
Quick Start	Get OpenSandbox running locally in minutes with Docker and Python.

Quick Start

OpenSandbox is a general-purpose sandbox platform for AI applications, offering multi-language SDKs, unified sandbox APIs, and Docker/Kubernetes runtimes.

Prerequisites

• Docker Engine 20.10+ (for local execution)
• Python 3.10+ (for the server and Python SDK)
• uv (recommended) or pip

1. Start the Server

# Generate a starter config
uvx opensandbox-server init-config ~/.sandbox.toml --example docker

# Start the server
uvx opensandbox-server

Verify the server is running:

curl http://127.0.0.1:8080/health
# → {"status": "healthy"}

2. Install an SDK

::: code-group

pip install opensandbox

npm install @alibaba-group/opensandbox

go get github.com/alibaba/OpenSandbox/sdks/sandbox/go

dotnet add package Alibaba.OpenSandbox

:::

For Kotlin/Java, see Installation.

3. Create and Use a Sandbox

import asyncio
from datetime import timedelta

from code_interpreter import CodeInterpreter, SupportedLanguage
from opensandbox import Sandbox
from opensandbox.models import WriteEntry

async def main() -> None:
    # Create a sandbox with code interpreter
    sandbox = await Sandbox.create(
        "opensandbox/code-interpreter:v1.1.0",
        entrypoint=["/opt/code-interpreter/code-interpreter.sh"],
        env={"PYTHON_VERSION": "3.11"},
        timeout=timedelta(minutes=10),
    )

    async with sandbox:
        # Execute a shell command
        execution = await sandbox.commands.run("echo 'Hello OpenSandbox!'")
        print(execution.logs.stdout[0].text)

        # Write and read a file
        await sandbox.files.write_files([
            WriteEntry(path="/tmp/hello.txt", data="Hello World", mode=644)
        ])
        content = await sandbox.files.read_file("/tmp/hello.txt")
        print(f"Content: {content}")

        # Run code via the Code Interpreter
        interpreter = await CodeInterpreter.create(sandbox)
        result = await interpreter.codes.run(
            "import sys; print(sys.version); 2 + 2",
            language=SupportedLanguage.PYTHON,
        )
        print(result.result[0].text)  # 4

        await sandbox.kill()

if __name__ == "__main__":
    asyncio.run(main())

::: tip Install the Code Interpreter SDK separately: pip install opensandbox-code-interpreter :::

4. Try the CLI

pip install opensandbox-cli

osb config init
osb config set connection.domain localhost:8080
osb config set connection.protocol http
osb sandbox create --image python:3.12 --timeout 30m -o json
osb command run <sandbox-id> -o raw -- python -c "print(1 + 1)"

Next Steps

• Installation — Detailed installation for all SDKs and runtimes
• Configuration — Server configuration reference
• Architecture — How OpenSandbox works under the hood
• Guides — Feature guides for Credential Vault, Secure Containers, and more
• Examples — Real-world usage examples