Skip to main content

SandboxOS CLI - Command-line interface for managing sandboxes

Project description

SandboxOS CLI

sandboxos (short alias: sbx) is the command-line interface for managing sandboxes. It's built for the common day-to-day flows:

  • create and manage sandboxes
  • run commands inside a sandbox
  • read and modify sandbox files
  • inspect runtime egress policy
  • collect low-level diagnostics
  • install sandbox skills for coding agents

It uses the OpenSandbox Python SDK (opensandbox) under the hood and is the shortest path from a terminal to a working sandbox workflow.

Install

pip install sandboxos

or with a tool installer:

uv tool install sandboxos
# or
pipx install sandboxos

Confirm the install:

sandboxos --help
sandboxos --version

Configuration

The CLI reads connection settings, in order of precedence:

  1. Command-line flags (--api-key, --domain, --protocol, ...)
  2. Environment variables (SANDBOXOS_API_KEY, SANDBOXOS_DOMAIN, SANDBOXOS_PROTOCOL, SANDBOXOS_REQUEST_TIMEOUT, SANDBOXOS_USE_SERVER_PROXY)
  3. Config file at ~/.sandboxos/config.toml
sandboxos config init
sandboxos config set connection.domain localhost:8080
sandboxos config set connection.protocol http
sandboxos config set connection.api_key <your-api-key>
sandboxos config show -o json

Point at a non-default config for a whole invocation:

sandboxos --config /tmp/dev.toml config show -o json

Quick start

# Create a sandbox
sandboxos sandbox create --image python:3.12 --timeout 30m -o json

# Run a command inside it (payload after --)
sandboxos command run <sandbox-id> -o raw -- python -c "print(1 + 1)"

# Read/write a file
sandboxos file write <sandbox-id> /workspace/hello.txt -c "hello" -o json
sandboxos file cat   <sandbox-id> /workspace/hello.txt -o raw

# Clean up
sandboxos sandbox kill <sandbox-id> -o json

Command groups

  • sandboxos sandbox — lifecycle management
  • sandboxos command — command execution and persistent sessions
  • sandboxos file — file and directory operations
  • sandboxos egress — runtime egress policy
  • sandboxos diagnostics — stable diagnostics logs and events
  • sandboxos devops — experimental legacy diagnostics
  • sandboxos config — local CLI configuration
  • sandboxos skills — bundled skills for AI tools

Run sandboxos <group> --help for details.

Output formats

Output selection is command-scoped via -o: table (default), json, yaml, raw. Not every command supports every format — use --help on the specific command when in doubt.

Requirements

  • Python 3.10+
  • A reachable OpenSandbox server
  • The opensandbox SDK (installed automatically)

License & attribution

Licensed under the Apache License, Version 2.0. See LICENSE.

SandboxOS CLI is a rebranded derivative of the OpenSandbox CLI (https://github.com/alibaba/OpenSandbox), Copyright 2026 Alibaba Group Holding Ltd. See NOTICE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sandboxos-0.1.0.tar.gz (43.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sandboxos-0.1.0-py3-none-any.whl (64.5 kB view details)

Uploaded Python 3

File details

Details for the file sandboxos-0.1.0.tar.gz.

File metadata

  • Download URL: sandboxos-0.1.0.tar.gz
  • Upload date:
  • Size: 43.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for sandboxos-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3ddfa79f7d00aa3428c98f048349db41f7b3b556c4e7a12a38e00b8bdfe128f8
MD5 d3d1f19e9a29279d0dfc6398c859eed3
BLAKE2b-256 28d48d7a6d0217542f0a846f6fc55f2a61a08df285377ab6cd8919110d58c6d4

See more details on using hashes here.

File details

Details for the file sandboxos-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: sandboxos-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 64.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for sandboxos-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 53fc881f3e40fa9495821fc1cd2c153a0e7665c233b510ebfd4afcea28d9bd47
MD5 98013e624481e9d615cb29f613bd733e
BLAKE2b-256 807fffb897c759cab9a1acb471ff177f70e44e1107e2deeae0fbf8006eaa71fb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page