Installation

Server

The OpenSandbox server is a FastAPI-based service that manages sandbox lifecycles. It supports Docker and Kubernetes runtimes.

pip

pip install opensandbox-server

uv

uv pip install opensandbox-server

Requirements:

• Python 3.10+
• Docker Engine 20.10+ (Docker runtime) or Kubernetes 1.21.1+ (Kubernetes runtime)
• Linux, macOS, or Windows with WSL2

See Configuration for server setup.

SDKs

Sandbox SDKs

The core SDKs for sandbox lifecycle management, command execution, and file operations.

Python

pip install opensandbox

JavaScript/TypeScript

npm install @alibaba-group/opensandbox

Kotlin/Java (Gradle)

dependencies {
    implementation(platform("com.alibaba.opensandbox:sandbox-bom:{latest_version}"))
    implementation("com.alibaba.opensandbox:sandbox")
}

Kotlin/Java (Maven)

<dependency>
    <groupId>com.alibaba.opensandbox</groupId>
    <artifactId>sandbox</artifactId>
    <version>{latest_version}</version>
</dependency>

Go

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

C#/.NET

dotnet add package Alibaba.OpenSandbox

For detailed SDK usage, see the SDK documentation.

Choose a published SDK version for your application. Replace {latest_version} in the JVM examples with that version; use the BOM when combining JVM modules such as sandbox and sandbox-pool-redis. See the release index.

Feature availability differs by language. See the capability matrix, Client Pool, and SDK Tracing.

CLI

The osb CLI provides terminal-based sandbox management.

pip

pip install opensandbox-cli

uv

uv tool install opensandbox-cli

See the CLI reference for the full command set.

MCP Server

The MCP server exposes sandbox operations to MCP-capable clients like Claude Code and Cursor.

pip

pip install opensandbox-mcp

uv

uv pip install opensandbox-mcp

opensandbox-mcp --domain localhost:8080 --protocol http

Minimal stdio config for MCP clients:

{
  "mcpServers": {
    "opensandbox": {
      "command": "opensandbox-mcp",
      "args": ["--domain", "localhost:8080", "--protocol", "http"]
    }
  }
}

See the MCP documentation for client-specific setup.