Get Started

Quickstart

View as Markdown

This page gets you from zero to a running, policy-enforced sandbox in two commands.

Prerequisites

Before you begin, make sure you have:

  • Docker Desktop running on your machine.

For a complete list of requirements, refer to Support Matrix.

Install the OpenShell CLI

Run the install script:

$curl -LsSf https://raw.githubusercontent.com/NVIDIA/OpenShell/main/install.sh | sh

If you prefer uv:

$uv tool install -U openshell

After installing the CLI, run openshell --help in your terminal to see the full CLI reference, including all commands and flags.

You can also clone the NVIDIA OpenShell GitHub repository and use the /openshell-cli skill to load the CLI reference into your agent.

Create Your First OpenShell Sandbox

Create a sandbox and launch an agent inside it. Choose the tab that matches your agent:

Run the following command to create a sandbox with Claude Code:

$openshell sandbox create -- claude

The CLI prompts you to create a provider from local credentials. Type yes to continue. If ANTHROPIC_API_KEY is set in your environment, the CLI picks it up automatically. If not, you can configure it from inside the sandbox after it launches.

Deploy a Gateway (Optional)

Running openshell sandbox create without a gateway auto-bootstraps a local one. To start the gateway explicitly or deploy to a remote host, choose the tab that matches your setup.

Deploy an OpenShell gateway on Brev by clicking Deploy on the OpenShell Launchable.

After the instance starts running, find the gateway URL in the Brev console under Using Secure Links. Copy the shareable URL for port 8080, which is the gateway endpoint.

$openshell gateway add https://<your-port-8080-url>.brevlab.com
$openshell status