OpenShell README

The project's README from github.com/NVIDIA/OpenShell. As one markdown file: README.md.

OpenShell

License PyPI Security Policy Documentation Project Status

OpenShell is the safe, private runtime for autonomous AI agents. It provides sandboxed execution environments that protect your data, credentials, and infrastructure — governed by declarative YAML policies that prevent unauthorized file access, data exfiltration, and uncontrolled network activity.

OpenShell is built agent-first. It ships public agent skills for using and operating OpenShell, plus separate repository-aware workflows for contributors and maintainers.

Quickstart

Prerequisites

Install

Binary (recommended):

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

The installer installs the latest stable release by default. To install a specific version, set OPENSHELL_VERSION. A dev release is also available that tracks the latest commit on main.

The openshell package on PyPI provides the Python SDK only. It does not install the openshell CLI. Add the SDK to a Python project with uv:

uv add openshell

Helm chart:

Experimental — the Kubernetes deployment path is under active development. Expect rough edges and breaking changes.

Deploy the OpenShell gateway into a Kubernetes cluster from the OCI chart published to GHCR:

helm install openshell oci://ghcr.io/nvidia/openshell/helm-chart

See deploy/helm/openshell/README.md for available versions, dev tag conventions, and configuration.

For deploying OpenShell on OpenShift, see deploy/helm/openshell/README.md#install-on-openshift.

Create a sandbox

openshell sandbox create -- claude  # or opencode, codex, copilot

The sandbox container includes the following tools by default:

Category Tools
Agent claude, opencode, codex, copilot
Language python (3.14), node (22)
Developer gh, git, vim, nano
Networking ping, dig, nslookup, nc, traceroute, netstat

For more details see https://github.com/NVIDIA/OpenShell-Community/tree/main/sandboxes/base.

See network policy in action

Every sandbox starts with minimal outbound access. You open additional access with a short YAML policy that the proxy enforces at the HTTP method and path level, without restarting anything.

# 1. Create a sandbox (starts with minimal outbound access)
openshell sandbox create

# 2. Inside the sandbox — blocked
sandbox$ curl -sS https://api.github.com/zen
curl: (56) Received HTTP code 403 from proxy after CONNECT

# 3. Back on the host — apply a read-only GitHub API policy
sandbox$ exit
openshell policy set demo --policy examples/sandbox-policy-quickstart/policy.yaml --wait

# 4. Reconnect — GET allowed, POST blocked by L7
openshell sandbox connect demo
sandbox$ curl -sS https://api.github.com/zen
Anything added dilutes everything else.

sandbox$ curl -sS -X POST https://api.github.com/repos/octocat/hello-world/issues -d '{"title":"oops"}'
{"error":"policy_denied","detail":"POST /repos/octocat/hello-world/issues not permitted by policy"}

See the full walkthrough or run the automated demo:

bash examples/sandbox-policy-quickstart/demo.sh

How It Works

OpenShell isolates each sandbox in its own container with policy-enforced egress routing. A lightweight gateway coordinates sandbox lifecycle, and every outbound connection is intercepted by the policy engine, which does one of three things:

Component Role
Gateway Control-plane API that coordinates sandbox lifecycle and acts as the auth boundary.
Sandbox Isolated runtime with container supervision and policy-enforced egress routing.
Policy Engine Enforces filesystem, network, and process constraints from application layer down to kernel.
Provider Access Profile-defined endpoints, binary policy, and endpoint-bound credential injection for model APIs and other services.

OpenShell runs a gateway control plane that manages sandbox lifecycle through a configured compute driver. Supported compute platforms include Docker, Podman, MicroVM, and Kubernetes.

Protection Layers

OpenShell applies defense in depth across four policy domains:

Layer What it protects When it applies
Filesystem Prevents reads/writes outside allowed paths. Locked at sandbox creation.
Network Blocks unauthorized outbound connections. Hot-reloadable at runtime.
Process Blocks privilege escalation and dangerous syscalls. Locked at sandbox creation.
Providers Grants endpoint-bound credentials and network access. Hot-reloadable at runtime.

Policies are declarative YAML files. Static sections (filesystem, process) are locked at creation; network policy and provider attachments can be updated on a running sandbox.

Providers

Agents need credentials — API keys, tokens, service accounts. OpenShell manages these as providers: named credential bundles that are injected into sandboxes at creation. The CLI auto-discovers credentials for recognized agents (Claude, Codex, OpenCode, Copilot) from your shell environment, or you can create providers explicitly with openshell provider create. Credentials never leak into the sandbox filesystem; they are injected as environment variables at runtime.

Inference access uses the same provider workflow. Attach an inference-capable provider to a sandbox, call the provider's native endpoint, and select the model in the client. Provider profiles contribute the endpoint policy and bind credential placeholders to the authorized destination.

GPU Support (Experimental)

Experimental — GPU passthrough works on supported hosts but is under active development. Expect rough edges and breaking changes.

OpenShell can pass host GPUs into sandboxes for local inference, fine-tuning, or any GPU workload. Add --gpu when creating a sandbox:

openshell sandbox create --gpu --from [gpu-enabled-sandbox] -- claude

Docker-backed GPU sandboxes auto-select CDI when available and otherwise fall back to Docker's NVIDIA GPU request path (--gpus all).

Requirements: NVIDIA drivers and the NVIDIA Container Toolkit must be installed on the host. The sandbox image itself must include the appropriate GPU drivers and libraries for your workload — the default base image does not. See the BYOC example for building a custom sandbox image with GPU support.

Supported Agents

Agent Source Notes
Claude Code base Works out of the box. Provider uses ANTHROPIC_API_KEY.
OpenCode base Works out of the box. Provider uses OPENAI_API_KEY or OPENROUTER_API_KEY.
Codex base Works out of the box. Provider uses OPENAI_API_KEY.
GitHub Copilot CLI base Works out of the box. Provider uses GITHUB_TOKEN or COPILOT_GITHUB_TOKEN.
OpenClaw NemoClaw Run OpenClaw more securely inside NVIDIA OpenShell with the NemoClaw blueprint.
Hermes Agent NemoClaw Run Hermes Agent more securely inside NVIDIA OpenShell with the NemoClaw blueprint.
Ollama Community Launch with openshell sandbox create --from ollama.
Pi Community Launch with openshell sandbox create --from pi.

Key Commands

Command Description
openshell sandbox create -- <agent> Create a sandbox and launch an agent.
openshell sandbox connect [name] SSH into a running sandbox.
openshell sandbox list List all sandboxes.
openshell provider create --type [type] --from-existing Create a credential provider from env vars.
openshell sandbox provider attach <sandbox> <provider> Attach a provider to a running sandbox.
openshell policy set <name> --policy file.yaml Apply or update a policy on a running sandbox.
openshell policy get <name> Show the active policy.
openshell logs [name] --tail Stream sandbox logs.
openshell term Launch the real-time terminal UI for debugging.

See the full documentation for command guides, tutorials, and reference material.

Terminal UI

OpenShell includes a real-time terminal dashboard for monitoring gateways, sandboxes, and providers — inspired by k9s.

openshell term

OpenShell Terminal UI

The TUI gives you a live, keyboard-driven view of your gateway and sandboxes. Navigate with Tab to switch panels, j/k to move through lists, Enter to select, and : for command mode. Gateway health and sandbox status auto-refresh every two seconds.

Community Sandboxes and BYOC

Use --from to create sandboxes from the OpenShell Community catalog or a container image:

openshell sandbox create --from gemini             # community catalog
docker build -t my-sandbox:latest ./my-sandbox-dir # Docker gateway
openshell sandbox create --from my-sandbox:latest  # Docker built image
podman build -t localhost/my-sandbox:latest ./my-sandbox-dir # Podman gateway
openshell sandbox create --from localhost/my-sandbox:latest  # Podman built image
openshell sandbox create --from registry.io/img:v1 # container image

Build with the container engine used by your local gateway. For a remote gateway, push the image to a registry that the gateway can pull from.

See the OpenShell Community catalog and the BYOC example for details.

Use OpenShell with Your Agent

OpenShell provides four portable skills for users and operators: CLI workflows (openshell-cli), gateway troubleshooting (debug-openshell-cluster), inference troubleshooting (debug-inference), and policy generation (generate-sandbox-policy). Install them with the Agent Skills CLI:

npx skills add NVIDIA/OpenShell

These public, installable skills live in skills/ and use the installed CLI help and published documentation as their sources of truth. They do not require an OpenShell source checkout.

Built With Agents

OpenShell is developed using the same agent-driven workflows it enables. Contributor and maintainer skills live separately in .agents/skills/; they automate work on the OpenShell repository and are not included when users install the public skills:

Agent implementation is human-directed: a user may request a phase directly, or maintainers may use the optional agent:* workflow to queue and approve planning and implementation. See AGENTS.md for the full workflow chain documentation.

Getting Help

Learn More

Contributing

OpenShell is built agent-first. Issues should include a user story, problem statement, impact, and acceptance criteria. The impact should explain the consequences of the current behavior and why existing workarounds are insufficient. Feature requests also require a workflow-level proposed design and alternatives; bug reports add reproduction steps, environment details, and relevant logs. Once work is authorized through the project workflow or a direct request, contributors should use the skills in .agents/skills/ to investigate the current code and behavior, implement the change, and verify it. If an issue contains earlier diagnostics, verify them rather than relying on them. See CONTRIBUTING.md for the full agent skills table, contribution workflow, and development setup.

Telemetry

OpenShell collects anonymous telemetry to help improve the project for developers. This data is not used to track individual user behavior. It helps us understand aggregate usage of sandbox, provider, and policy workflows so we can prioritize product improvements and share usage trends with the community.

Disable telemetry at runtime by setting OPENSHELL_TELEMETRY_ENABLED=false on the gateway deployment. For Helm installs, set server.telemetryEnabled=false. OpenShell propagates this deployment setting into sandbox supervisor environments so sandbox-side telemetry collection is disabled as well.

You can also compile telemetry out entirely. Telemetry support is a default-on telemetry Cargo feature, and each crate that carries it also defines a defaults-without-telemetry alias covering every other default feature. Build telemetry-free artifacts with --no-default-features --features defaults-without-telemetry:

cargo build --release -p openshell-gateway --no-default-features --features defaults-without-telemetry
cargo build --release -p openshell-sandbox --no-default-features --features defaults-without-telemetry
cargo build --release -p openshell-driver-vm --no-default-features --features defaults-without-telemetry

The resulting binaries contain no telemetry endpoint, no telemetry HTTP client, and no emission code. With telemetry compiled out, the gateway emits nothing and reports telemetry disabled to th

OpenShell (NVIDIA/OpenShell)

Searching Database…

16.6K ·GitHub
Что это такое?OpenShell — это опенсорсная среда выполнения для запуска автономных AI-агентов внутри изолированных песочниц. Декларативные политики в YAML защищают ваши файлы, учётные данные и инфраструктуру от несанкционированного доступа и утечки данных.
Это то, что я устанавливаю себе на компьютер, или облачный сервис, в который нужно входить?Это локальный CLI ('openshell') плюс управляющий слой gateway, который управляет жизненным циклом песочниц через драйверы вычислений: Docker, Podman, MicroVM и Kubernetes. Каждая песочница — изолированный контейнер с политиками, контролирующими исходящий трафик.
Как установить и запустить свою первую песочницу?Запустите установщик — по умолчанию он ставит последнюю стабильную версию (dev-версия следует за веткой main). Затем создайте первую песочницу командой 'openshell sandbox create' — она может сразу запустить агента.
Нужно ли заранее установить Docker или Podman?Да — нужен локальный рантайм: Docker, Podman или включённая виртуализация на хосте для песочниц на базе MicroVM. Учтите, что пакет 'openshell' на PyPI содержит только Python SDK, без CLI.
Насколько развёртывание через Kubernetes стабильно для продакшена?Пока нет — развёртывание gateway через Helm-чарт экспериментальное, активно разрабатывается, так что будьте готовы к шероховатостям и несовместимым изменениям.
Работает ли это на Windows, или только Linux и Mac?Поддерживаются хосты Linux, macOS (Apple Silicon) и Windows с WSL 2 — вариант для Windows помечен как экспериментальный. Сами песочницы работают на Docker, Podman, MicroVM или Kubernetes.
Как агент не получит доступ к моим API-ключам?Ключи управляются как провайдеры — именованные наборы учётных данных, которые передаются в песочницу только как переменные окружения во время выполнения и никогда не записываются в её файловую систему. CLI сам находит учётные данные для Claude, Codex, OpenCode и Copilot в вашей оболочке.
Какие AI-агенты можно запускать внутри песочницы?Claude Code, OpenCode, Codex и GitHub Copilot CLI работают из коробки с автоматически найденными учётными данными. OpenClaw и Hermes Agent запускаются через blueprint NemoClaw, а общественные песочницы вроде Ollama или Pi — командой 'openshell sandbox create --from ollama'.
Может ли песочница использовать мой GPU для локального инференса?Да, но это экспериментальная функция: добавьте флаг --gpu при создании песочницы. На хосте нужны драйверы NVIDIA и NVIDIA Container Toolkit, а поскольку в базовом образе по умолчанию нет GPU-библиотек, большинству задач потребуется собственный образ песочницы (BYOC).
Есть ли дашборд, чтобы следить за песочницами в реальном времени?Да — команда 'openshell term' открывает терминальный интерфейс в реальном времени, вдохновлённый k9s, с живыми панелями gateways, песочниц и провайдеров. Tab переключает панели, j/k перемещаются по спискам, а состояние и здоровье обновляются автоматически каждые две секунды.
Какие инструменты уже установлены в песочнице?CLI агентов (claude, opencode, codex, copilot), Python 3.14 и Node 22, инструменты разработчика вроде gh, git, vim и nano, а также сетевые утилиты. Можно также стартовать с образа из общественного каталога или со своего через --from.
Creator
NVIDIA
Size
86.3 MB
Stars
16.6K
Age
7mo
Commits · 90 Days