e0e362d700
SDK Tests / SDK CI (push) Blocked by required conditions
SDK Tests / changes (push) Successful in 2m29s
Real E2E Tests / changes (push) Successful in 2m29s
SDK Tests / Python SDK Tests (sandbox) (push) Waiting to run
SDK Tests / CLI Quality (push) Waiting to run
SDK Tests / CLI Tests (push) Waiting to run
SDK Tests / Python SDK Quality (code-interpreter) (push) Waiting to run
SDK Tests / Python SDK Quality (sandbox) (push) Waiting to run
SDK Tests / Python SDK Tests (code-interpreter) (push) Waiting to run
SDK Tests / JavaScript SDK Quality And Tests (code-interpreter) (push) Waiting to run
SDK Tests / JavaScript SDK Quality And Tests (sandbox) (push) Waiting to run
SDK Tests / Kotlin SDK Quality And Tests (sandbox) (push) Waiting to run
SDK Tests / Kotlin SDK Quality And Tests (code-interpreter) (push) Waiting to run
SDK Tests / C# SDK Quality And Tests (code-interpreter) (push) Waiting to run
SDK Tests / C# SDK Quality And Tests (sandbox) (push) Waiting to run
SDK Tests / Go SDK Quality And Tests (push) Waiting to run
Deploy Docs Pages / build (push) Has been cancelled
Deploy Docs Pages / deploy (push) Has been cancelled
Real E2E Tests / JavaScript E2E (docker bridge) (push) Has been cancelled
Real E2E Tests / Python E2E (docker bridge) (push) Has been cancelled
Real E2E Tests / Java E2E (docker bridge) (push) Has been cancelled
Real E2E Tests / C# E2E (docker bridge) (push) Has been cancelled
Real E2E Tests / Go E2E (docker bridge) (push) Has been cancelled
Real E2E Tests / Real E2E CI (push) Has been cancelled
2.5 KiB
2.5 KiB
title, description
| title | description |
|---|---|
| Installation | Install OpenSandbox server, SDKs, CLI, and MCP server across all supported languages and platforms. |
Installation
Server
The OpenSandbox server is a FastAPI-based service that manages sandbox lifecycles. It supports Docker and Kubernetes runtimes.
# Install from PyPI
uv pip install opensandbox-server
# Or with pip
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.
::: code-group
pip install opensandbox
npm install @alibaba-group/opensandbox
dependencies {
implementation("com.alibaba.opensandbox:sandbox:{latest_version}")
}
<dependency>
<groupId>com.alibaba.opensandbox</groupId>
<artifactId>sandbox</artifactId>
<version>{latest_version}</version>
</dependency>
go get github.com/alibaba/OpenSandbox/sdks/sandbox/go
dotnet add package Alibaba.OpenSandbox
:::
For detailed SDK usage, see the SDK documentation.
Code Interpreter SDKs
Higher-level SDKs for multi-language code execution inside sandboxes.
::: code-group
pip install opensandbox-code-interpreter
npm install @alibaba-group/opensandbox-code-interpreter
dependencies {
implementation("com.alibaba.opensandbox:code-interpreter:{latest_version}")
}
dotnet add package Alibaba.OpenSandbox.CodeInterpreter
:::
CLI
The osb CLI provides terminal-based sandbox management.
pip install opensandbox-cli
# or
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 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.