wehub-resource-sync
e0e362d700
SDK Tests / changes (push) Successful in 2m29s
Real E2E Tests / changes (push) Successful in 2m29s
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
SDK Tests / SDK CI (push) Has been cancelled
SDK Tests / CLI Tests (push) Has been cancelled
SDK Tests / Python SDK Quality (code-interpreter) (push) Has been cancelled
SDK Tests / Python SDK Quality (sandbox) (push) Has been cancelled
SDK Tests / Python SDK Tests (code-interpreter) (push) Has been cancelled
SDK Tests / JavaScript SDK Quality And Tests (code-interpreter) (push) Has been cancelled
SDK Tests / JavaScript SDK Quality And Tests (sandbox) (push) Has been cancelled
SDK Tests / Python SDK Tests (sandbox) (push) Has been cancelled
SDK Tests / CLI Quality (push) Has been cancelled
SDK Tests / Kotlin SDK Quality And Tests (sandbox) (push) Has been cancelled
SDK Tests / Kotlin SDK Quality And Tests (code-interpreter) (push) Has been cancelled
SDK Tests / C# SDK Quality And Tests (code-interpreter) (push) Has been cancelled
SDK Tests / C# SDK Quality And Tests (sandbox) (push) Has been cancelled
SDK Tests / Go SDK Quality And Tests (push) Has been cancelled
87 lines
3.0 KiB
Markdown
87 lines
3.0 KiB
Markdown
---
|
|
title: AIO Sandbox
|
|
description: Create and access an All-in-One (AIO) Sandbox via OpenSandbox.
|
|
---
|
|
|
|
# All-in-One (AIO) Sandbox Example
|
|
|
|
This example demonstrates how to create and access an [All-in-One (AIO) Sandbox](https://github.com/agent-infra/sandbox) via OpenSandbox.
|
|
|
|
## Start OpenSandbox server [local]
|
|
|
|
You can find the latest version [here](https://github.com/agent-infra/sandbox/pkgs/container/sandbox).
|
|
|
|
You can pre-pull the target image which is used in the example.
|
|
|
|
::: info Docker runtime requirement
|
|
The server is configured with `runtime.type = "docker"` by default, so it **must** be able to connect to a running Docker daemon.
|
|
|
|
- **Docker Desktop**: ensure Docker Desktop is running, then verify with `docker version`.
|
|
- **Colima (macOS)**: start it first (`colima start`) and export the socket before starting the server:
|
|
|
|
```shell
|
|
export DOCKER_HOST="unix://${HOME}/.colima/default/docker.sock"
|
|
```
|
|
:::
|
|
|
|
```shell
|
|
# pre-pull target image
|
|
docker pull ghcr.io/agent-infra/sandbox:latest
|
|
```
|
|
|
|
Then, start the OpenSandbox server, you can obtain stdout log from terminal.
|
|
|
|
```shell
|
|
uv pip install opensandbox-server
|
|
opensandbox-server init-config ~/.sandbox.toml --example docker
|
|
opensandbox-server
|
|
```
|
|
|
|
::: tip
|
|
`opensandbox-server` runs in the foreground and will keep the current terminal session busy. The example code lives in this repository -- clone it and, in a new terminal window/tab, `cd` into the project root before running the AIO sandbox creation steps below.
|
|
|
|
If you see errors like `FileNotFoundError: [Errno 2] No such file or directory` from `docker/transport/unixconn.py`, it usually means the Docker unix socket is missing / Docker daemon is not running.
|
|
:::
|
|
|
|
## Create and Access the AIO Sandbox Instance
|
|
|
|
This example uses a fixed configuration for quick start:
|
|
- OpenSandbox server: `http://localhost:8080`
|
|
- Image: `ghcr.io/agent-infra/sandbox:latest`
|
|
- AIO port: `8080`
|
|
- Timeout: `300s`
|
|
|
|
Install dependencies with uv under project root:
|
|
|
|
```shell
|
|
uv pip install opensandbox agent-sandbox==0.0.18
|
|
```
|
|
|
|
Run the example (it will create a sandbox via OpenSandbox, wait until it's Running, then connect to it via agent-sandbox):
|
|
|
|
```shell
|
|
uv run python examples/aio-sandbox/main.py
|
|
```
|
|
|
|
Subsequently, you will instantiate an AIO sandbox, navigate to Google, capture a screenshot, and download it to your local environment.
|
|
|
|
```text
|
|
Creating AIO sandbox with image=ghcr.io/agent-infra/sandbox:latest on OpenSandbox server http://localhost:8080...
|
|
[check] sandbox ready after 7.1s
|
|
AIO portal endpoint: 127.0.0.1:56123
|
|
...
|
|
Screenshot saved to sandbox_screenshot.png
|
|
```
|
|
|
|
|
|
|
|
## More examples
|
|
|
|
For more examples of using the AIO Sandbox, refer to agent-infra/sandbox [examples](https://github.com/agent-infra/sandbox/tree/main/examples).
|
|
|
|
## References
|
|
|
|
- [AIO Sandbox](https://github.com/agent-infra/sandbox/tree/main)
|
|
- [AIO Sandbox Python SDK](https://github.com/agent-infra/sandbox/tree/main/sdk/python)
|
|
- [Source code on GitHub](https://github.com/opensandbox-group/OpenSandbox/tree/main/examples/aio-sandbox)
|