Appearance
Installing sandbox
On this page you can find instructions on how to get started with sandbox, or sb in short.
Requirements
To use sb you need the following:
- Python
3.11or newer - Docker Engine with Compose
5.6.0or newer and Buildx0.17.0or newer uvfor easy installation and upgrade
Before running commands, sb checks and reports a missing or unsupported tool with the required version. It, however, never installs other tools on your host.
Security Boundary
sb provides convenience for local development. It is not intended as a security boundary to contain unsupervised rouge AI agents or other untrusted workloads. See NVIDIA/OpenShell for a production-oriented solution in that direction.
Install
You can install sb using uv from the GitHub repository using:
bash
# Install the tool from the repository.
uv tool install git+https://github.com/mihaiconstantin/sandbox.gitAt the point, sb is available in your path. You can verify the installation by printing the installed version:
bash
# Print the installed version.
sb --versionYou can upgrade an existing installation by running:
bash
# Upgrade the installed tool.
uv tool upgrade sandboxTo get started you can check out the CLI guide as show below, or keep reading the documentation.
bash
# Print the getting started guide.
sb guide