openshell 0.0.113__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- openshell/__init__.py +46 -0
- openshell/_proto/__init__.py +15 -0
- openshell/_proto/datamodel_pb2.py +77 -0
- openshell/_proto/datamodel_pb2.pyi +129 -0
- openshell/_proto/datamodel_pb2_grpc.py +24 -0
- openshell/_proto/inference_pb2.py +72 -0
- openshell/_proto/inference_pb2.pyi +149 -0
- openshell/_proto/inference_pb2_grpc.py +236 -0
- openshell/_proto/openshell_pb2.py +698 -0
- openshell/_proto/openshell_pb2.pyi +2377 -0
- openshell/_proto/openshell_pb2_grpc.py +3119 -0
- openshell/_proto/options_pb2.py +37 -0
- openshell/_proto/options_pb2.pyi +22 -0
- openshell/_proto/options_pb2_grpc.py +24 -0
- openshell/_proto/sandbox_pb2.py +123 -0
- openshell/_proto/sandbox_pb2.pyi +390 -0
- openshell/_proto/sandbox_pb2_grpc.py +24 -0
- openshell/openshell_test.py +11 -0
- openshell/py.typed +0 -0
- openshell/release_formula_test.py +170 -0
- openshell/sandbox.py +1701 -0
- openshell/sandbox_test.py +1983 -0
- openshell-0.0.113.dist-info/METADATA +307 -0
- openshell-0.0.113.dist-info/RECORD +27 -0
- openshell-0.0.113.dist-info/WHEEL +5 -0
- openshell-0.0.113.dist-info/licenses/LICENSE +191 -0
- openshell-0.0.113.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,307 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: openshell
|
|
3
|
+
Version: 0.0.113
|
|
4
|
+
Summary: OpenShell is the safe, private runtime for autonomous AI agents.
|
|
5
|
+
Author: NVIDIA Inc.
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: source, https://github.com/NVIDIA/OpenShell
|
|
8
|
+
Project-URL: documentation, https://docs.nvidia.com/openshell/latest/
|
|
9
|
+
Keywords: agent,sandbox,nvidia
|
|
10
|
+
Classifier: Development Status :: 3 - Alpha
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: Intended Audience :: Science/Research
|
|
13
|
+
Classifier: Intended Audience :: Information Technology
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
19
|
+
Classifier: Topic :: Security
|
|
20
|
+
Classifier: Topic :: Scientific/Engineering
|
|
21
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
22
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
23
|
+
Classifier: Operating System :: MacOS :: MacOS X
|
|
24
|
+
Requires-Python: >=3.11
|
|
25
|
+
Description-Content-Type: text/markdown
|
|
26
|
+
License-File: LICENSE
|
|
27
|
+
Requires-Dist: cloudpickle>=3.0
|
|
28
|
+
Requires-Dist: grpcio>=1.60
|
|
29
|
+
Requires-Dist: httpx>=0.27
|
|
30
|
+
Requires-Dist: protobuf>=4.25
|
|
31
|
+
Dynamic: license-file
|
|
32
|
+
|
|
33
|
+
<!-- markdownlint-disable MD033 MD041 -->
|
|
34
|
+
|
|
35
|
+
<picture>
|
|
36
|
+
<source media="(prefers-color-scheme: dark)" srcset="docs/brand/assets/openshell-banner-dark.png">
|
|
37
|
+
<source media="(prefers-color-scheme: light)" srcset="docs/brand/assets/openshell-banner-light.png">
|
|
38
|
+
<img alt="OpenShell" src="docs/brand/assets/openshell-banner-light.png" width="430">
|
|
39
|
+
</picture>
|
|
40
|
+
|
|
41
|
+
<!-- markdownlint-enable MD033 MD041 -->
|
|
42
|
+
|
|
43
|
+
[](https://github.com/NVIDIA/OpenShell/blob/main/LICENSE)
|
|
44
|
+
[](https://pypi.org/project/openshell/)
|
|
45
|
+
[](SECURITY.md)
|
|
46
|
+
[](https://docs.nvidia.com/openshell/latest/index.html)
|
|
47
|
+
[](https://docs.nvidia.com/openshell/latest/about/release-notes.html)
|
|
48
|
+
|
|
49
|
+
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.
|
|
50
|
+
|
|
51
|
+
OpenShell is built agent-first. The project ships with agent skills for everything from gateway troubleshooting to policy generation, and we expect contributors to use them.
|
|
52
|
+
|
|
53
|
+
## Quickstart
|
|
54
|
+
|
|
55
|
+
### Prerequisites
|
|
56
|
+
|
|
57
|
+
- **A supported host** — Linux, macOS (Apple Silicon), or Windows with WSL 2 (experimental).
|
|
58
|
+
- **A local runtime** — Docker, Podman, or host virtualization enabled for MicroVM-backed sandboxes.
|
|
59
|
+
|
|
60
|
+
### Install
|
|
61
|
+
|
|
62
|
+
**Binary (recommended):**
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
curl -LsSf https://raw.githubusercontent.com/NVIDIA/OpenShell/main/install.sh | sh
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
The installer installs the latest stable release by default. To install a specific version, set `OPENSHELL_VERSION`. A [`dev` release](https://github.com/NVIDIA/OpenShell/releases/tag/dev) is also available that tracks the latest commit on `main`.
|
|
69
|
+
|
|
70
|
+
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](https://docs.astral.sh/uv/):
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
uv add openshell
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
**Helm chart:**
|
|
77
|
+
|
|
78
|
+
> **Experimental** — the Kubernetes deployment path is under active development. Expect rough edges and breaking changes.
|
|
79
|
+
|
|
80
|
+
Deploy the OpenShell gateway into a Kubernetes cluster from the OCI chart published to GHCR:
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
helm install openshell oci://ghcr.io/nvidia/openshell/helm-chart
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
See [`deploy/helm/openshell/README.md`](deploy/helm/openshell/README.md) for available versions, dev tag conventions, and configuration.
|
|
87
|
+
|
|
88
|
+
For deploying OpenShell on OpenShift, see [`deploy/helm/openshell/README.md#install-on-openshift`](deploy/helm/openshell/README.md#install-on-openshift).
|
|
89
|
+
|
|
90
|
+
### Create a sandbox
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
openshell sandbox create -- claude # or opencode, codex, copilot
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
The sandbox container includes the following tools by default:
|
|
97
|
+
|
|
98
|
+
| Category | Tools |
|
|
99
|
+
| ---------- | -------------------------------------------------------- |
|
|
100
|
+
| Agent | `claude`, `opencode`, `codex`, `copilot` |
|
|
101
|
+
| Language | `python` (3.14), `node` (22) |
|
|
102
|
+
| Developer | `gh`, `git`, `vim`, `nano` |
|
|
103
|
+
| Networking | `ping`, `dig`, `nslookup`, `nc`, `traceroute`, `netstat` |
|
|
104
|
+
|
|
105
|
+
For more details see https://github.com/NVIDIA/OpenShell-Community/tree/main/sandboxes/base.
|
|
106
|
+
|
|
107
|
+
### See network policy in action
|
|
108
|
+
|
|
109
|
+
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.
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
# 1. Create a sandbox (starts with minimal outbound access)
|
|
113
|
+
openshell sandbox create
|
|
114
|
+
|
|
115
|
+
# 2. Inside the sandbox — blocked
|
|
116
|
+
sandbox$ curl -sS https://api.github.com/zen
|
|
117
|
+
curl: (56) Received HTTP code 403 from proxy after CONNECT
|
|
118
|
+
|
|
119
|
+
# 3. Back on the host — apply a read-only GitHub API policy
|
|
120
|
+
sandbox$ exit
|
|
121
|
+
openshell policy set demo --policy examples/sandbox-policy-quickstart/policy.yaml --wait
|
|
122
|
+
|
|
123
|
+
# 4. Reconnect — GET allowed, POST blocked by L7
|
|
124
|
+
openshell sandbox connect demo
|
|
125
|
+
sandbox$ curl -sS https://api.github.com/zen
|
|
126
|
+
Anything added dilutes everything else.
|
|
127
|
+
|
|
128
|
+
sandbox$ curl -sS -X POST https://api.github.com/repos/octocat/hello-world/issues -d '{"title":"oops"}'
|
|
129
|
+
{"error":"policy_denied","detail":"POST /repos/octocat/hello-world/issues not permitted by policy"}
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
See the [full walkthrough](examples/sandbox-policy-quickstart/) or run the automated demo:
|
|
133
|
+
|
|
134
|
+
```bash
|
|
135
|
+
bash examples/sandbox-policy-quickstart/demo.sh
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## How It Works
|
|
139
|
+
|
|
140
|
+
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:
|
|
141
|
+
|
|
142
|
+
- **Allows** — the destination and binary match a policy block.
|
|
143
|
+
- **Routes for inference** — strips caller credentials, injects backend credentials, and forwards to the managed model.
|
|
144
|
+
- **Denies** — blocks the request and logs it.
|
|
145
|
+
|
|
146
|
+
| Component | Role |
|
|
147
|
+
| ------------------ | -------------------------------------------------------------------------------------------- |
|
|
148
|
+
| **Gateway** | Control-plane API that coordinates sandbox lifecycle and acts as the auth boundary. |
|
|
149
|
+
| **Sandbox** | Isolated runtime with container supervision and policy-enforced egress routing. |
|
|
150
|
+
| **Policy Engine** | Enforces filesystem, network, and process constraints from application layer down to kernel. |
|
|
151
|
+
| **Privacy Router** | Privacy-aware LLM routing that keeps sensitive context on sandbox compute. |
|
|
152
|
+
|
|
153
|
+
OpenShell runs a gateway control plane that manages sandbox lifecycle through a configured compute driver. Supported compute platforms include Docker, Podman, MicroVM, and Kubernetes.
|
|
154
|
+
|
|
155
|
+
## Protection Layers
|
|
156
|
+
|
|
157
|
+
OpenShell applies defense in depth across four policy domains:
|
|
158
|
+
|
|
159
|
+
| Layer | What it protects | When it applies |
|
|
160
|
+
| ---------- | --------------------------------------------------- | --------------------------- |
|
|
161
|
+
| Filesystem | Prevents reads/writes outside allowed paths. | Locked at sandbox creation. |
|
|
162
|
+
| Network | Blocks unauthorized outbound connections. | Hot-reloadable at runtime. |
|
|
163
|
+
| Process | Blocks privilege escalation and dangerous syscalls. | Locked at sandbox creation. |
|
|
164
|
+
| Inference | Reroutes model API calls to controlled backends. | Hot-reloadable at runtime. |
|
|
165
|
+
|
|
166
|
+
Policies are declarative YAML files. Static sections (filesystem, process) are locked at creation; dynamic sections (network, inference) can be hot-reloaded on a running sandbox with `openshell policy set`.
|
|
167
|
+
|
|
168
|
+
## Providers
|
|
169
|
+
|
|
170
|
+
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.
|
|
171
|
+
|
|
172
|
+
## GPU Support (Experimental)
|
|
173
|
+
|
|
174
|
+
> **Experimental** — GPU passthrough works on supported hosts but is under active development. Expect rough edges and breaking changes.
|
|
175
|
+
|
|
176
|
+
OpenShell can pass host GPUs into sandboxes for local inference, fine-tuning, or any GPU workload. Add `--gpu` when creating a sandbox:
|
|
177
|
+
|
|
178
|
+
```bash
|
|
179
|
+
openshell sandbox create --gpu --from [gpu-enabled-sandbox] -- claude
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
Docker-backed GPU sandboxes auto-select CDI when available and otherwise fall back to Docker's NVIDIA GPU request path (`--gpus all`).
|
|
183
|
+
|
|
184
|
+
**Requirements:** NVIDIA drivers and the [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) 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](https://github.com/NVIDIA/OpenShell/tree/main/examples/bring-your-own-container) for building a custom sandbox image with GPU support.
|
|
185
|
+
|
|
186
|
+
## Supported Agents
|
|
187
|
+
|
|
188
|
+
| Agent | Source | Notes |
|
|
189
|
+
| ------------------------------------------------------------- | -------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
|
190
|
+
| [Claude Code](https://docs.anthropic.com/en/docs/claude-code) | [`base`](https://github.com/NVIDIA/OpenShell-Community/tree/main/sandboxes/base) | Works out of the box. Provider uses `ANTHROPIC_API_KEY`. |
|
|
191
|
+
| [OpenCode](https://opencode.ai/) | [`base`](https://github.com/NVIDIA/OpenShell-Community/tree/main/sandboxes/base) | Works out of the box. Provider uses `OPENAI_API_KEY` or `OPENROUTER_API_KEY`. |
|
|
192
|
+
| [Codex](https://developers.openai.com/codex) | [`base`](https://github.com/NVIDIA/OpenShell-Community/tree/main/sandboxes/base) | Works out of the box. Provider uses `OPENAI_API_KEY`. |
|
|
193
|
+
| [GitHub Copilot CLI](https://docs.github.com/en/copilot/github-copilot-in-the-cli) | [`base`](https://github.com/NVIDIA/OpenShell-Community/tree/main/sandboxes/base) | Works out of the box. Provider uses `GITHUB_TOKEN` or `COPILOT_GITHUB_TOKEN`. |
|
|
194
|
+
| [OpenClaw](https://openclaw.ai/) | [NemoClaw](https://github.com/NVIDIA/NemoClaw) | Run OpenClaw more securely inside NVIDIA OpenShell with managed inference using NemoClaw. |
|
|
195
|
+
| [Hermes Agent](https://github.com/NousResearch/hermes-agent) | [NemoClaw](https://github.com/NVIDIA/NemoClaw) | Run Hermes Agent more securely inside NVIDIA OpenShell with managed inference using NemoClaw. |
|
|
196
|
+
| [Ollama](https://ollama.com/) | [Community](https://github.com/NVIDIA/OpenShell-Community) | Launch with `openshell sandbox create --from ollama`. |
|
|
197
|
+
| [Pi](https://pi.dev/) | [Community](https://github.com/NVIDIA/OpenShell-Community) | Launch with `openshell sandbox create --from pi`. |
|
|
198
|
+
|
|
199
|
+
## Key Commands
|
|
200
|
+
|
|
201
|
+
| Command | Description |
|
|
202
|
+
| ---------------------------------------------------------- | ----------------------------------------------- |
|
|
203
|
+
| `openshell sandbox create -- <agent>` | Create a sandbox and launch an agent. |
|
|
204
|
+
| `openshell sandbox connect [name]` | SSH into a running sandbox. |
|
|
205
|
+
| `openshell sandbox list` | List all sandboxes. |
|
|
206
|
+
| `openshell provider create --type [type] --from-existing` | Create a credential provider from env vars. |
|
|
207
|
+
| `openshell policy set <name> --policy file.yaml` | Apply or update a policy on a running sandbox. |
|
|
208
|
+
| `openshell policy get <name>` | Show the active policy. |
|
|
209
|
+
| `openshell inference set --provider <p> --model <m>` | Configure the `inference.local` endpoint. |
|
|
210
|
+
| `openshell logs [name] --tail` | Stream sandbox logs. |
|
|
211
|
+
| `openshell term` | Launch the real-time terminal UI for debugging. |
|
|
212
|
+
|
|
213
|
+
See the [full documentation](https://docs.nvidia.com/openshell/latest) for command guides, tutorials, and reference material.
|
|
214
|
+
|
|
215
|
+
## Terminal UI
|
|
216
|
+
|
|
217
|
+
OpenShell includes a real-time terminal dashboard for monitoring gateways, sandboxes, and providers — inspired by [k9s](https://k9scli.io/).
|
|
218
|
+
|
|
219
|
+
```bash
|
|
220
|
+
openshell term
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
<p align="center">
|
|
224
|
+
<img src="fern/assets/images/openshell-terminal.png" alt="OpenShell Terminal UI">
|
|
225
|
+
</p>
|
|
226
|
+
|
|
227
|
+
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.
|
|
228
|
+
|
|
229
|
+
## Community Sandboxes and BYOC
|
|
230
|
+
|
|
231
|
+
Use `--from` to create sandboxes from the [OpenShell Community](https://github.com/NVIDIA/OpenShell-Community) catalog, a local directory, or a container image:
|
|
232
|
+
|
|
233
|
+
```bash
|
|
234
|
+
openshell sandbox create --from gemini # community catalog
|
|
235
|
+
openshell sandbox create --from ./my-sandbox-dir # local Dockerfile
|
|
236
|
+
openshell sandbox create --from registry.io/img:v1 # container image
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
See the [OpenShell Community](https://github.com/NVIDIA/OpenShell-Community) catalog and the [BYOC example](https://github.com/NVIDIA/OpenShell/tree/main/examples/bring-your-own-container) for details.
|
|
240
|
+
|
|
241
|
+
## Explore with Your Agent
|
|
242
|
+
|
|
243
|
+
Clone the repo and point your coding agent at it. The project includes agent skills that can answer questions, walk you through workflows, and diagnose problems — no issue filing required.
|
|
244
|
+
|
|
245
|
+
```bash
|
|
246
|
+
git clone https://github.com/NVIDIA/OpenShell.git # or git@github.com:NVIDIA/OpenShell.git
|
|
247
|
+
cd OpenShell
|
|
248
|
+
# Point your agent here — it will discover the skills in .agents/skills/ automatically
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
Your agent can load skills for CLI usage (`openshell-cli`), gateway troubleshooting (`debug-openshell-cluster`), inference troubleshooting (`debug-inference`), policy generation (`generate-sandbox-policy`), and more. See [CONTRIBUTING.md](CONTRIBUTING.md) for the full skills table.
|
|
252
|
+
|
|
253
|
+
## Built With Agents
|
|
254
|
+
|
|
255
|
+
OpenShell is developed using the same agent-driven workflows it enables. The `.agents/skills/` directory contains workflow automation that powers the project's development cycle:
|
|
256
|
+
|
|
257
|
+
- **Spike and build:** Investigate a problem with `create-spike`; a human accepts it with `state:accepted` or [roadmap](https://github.com/orgs/NVIDIA/projects/233) placement, or declines it. Accepted work can remain human-owned or enter the optional, human-gated `agent:*` planning and implementation workflow.
|
|
258
|
+
- **Triage and route:** Community issues are assessed with `triage-issue`. Agents establish technical validity and impact; humans decide whether the project should act and where the work sits on the roadmap.
|
|
259
|
+
- **Security review:** `review-security-issue` produces a severity assessment and remediation plan. `fix-security-issue` implements it.
|
|
260
|
+
- **Policy authoring:** `generate-sandbox-policy` creates YAML policies from plain-language requirements or API documentation.
|
|
261
|
+
|
|
262
|
+
All agent implementation work is human-gated: maintainers explicitly request a plan, agents propose it, maintainers approve it, and agents build. See [AGENTS.md](AGENTS.md) for the full workflow chain documentation.
|
|
263
|
+
|
|
264
|
+
## Getting Help
|
|
265
|
+
|
|
266
|
+
- **Questions and discussion:** [GitHub Discussions](https://github.com/NVIDIA/OpenShell/discussions)
|
|
267
|
+
- **Bug reports:** [GitHub Issues](https://github.com/NVIDIA/OpenShell/issues) — use the bug report template
|
|
268
|
+
- **Security vulnerabilities:** See [SECURITY.md](SECURITY.md) — do not use GitHub Issues
|
|
269
|
+
- **Agent-assisted help:** Clone the repo and use the agent skills in `.agents/skills/` for self-service diagnostics
|
|
270
|
+
|
|
271
|
+
## Learn More
|
|
272
|
+
|
|
273
|
+
- [Full Documentation](https://docs.nvidia.com/openshell/latest/index.html) — overview, architecture, tutorials, and reference
|
|
274
|
+
- [Quickstart](https://docs.nvidia.com/openshell/latest/get-started/quickstart) — detailed install and first sandbox walkthrough
|
|
275
|
+
- [GitHub Sandbox Tutorial](https://docs.nvidia.com/openshell/latest/get-started/tutorials/github-sandbox) — end-to-end scoped GitHub repo access
|
|
276
|
+
- [Architecture](https://github.com/NVIDIA/OpenShell/tree/main/architecture) — detailed architecture docs and design decisions
|
|
277
|
+
- [Roadmap](https://github.com/orgs/NVIDIA/projects/233) — planned work and project priorities
|
|
278
|
+
- [RFC Board](https://github.com/orgs/NVIDIA/projects/233/views/6) — RFC proposals tracked on the OpenShell Roadmap with the `rfc` label
|
|
279
|
+
- [Support Matrix](https://docs.nvidia.com/openshell/latest/reference/support-matrix) — platforms, versions, and kernel requirements
|
|
280
|
+
- [Brev Launchable](https://brev.nvidia.com/launchable/deploy/now?launchableID=env-3Ap3tL55zq4a8kew1AuW0FpSLsg) — try OpenShell on cloud compute without local setup
|
|
281
|
+
- [Agent Instructions](AGENTS.md) — system prompt and workflow documentation for agent contributors
|
|
282
|
+
|
|
283
|
+
## Contributing
|
|
284
|
+
|
|
285
|
+
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 maintainers accept work, 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](CONTRIBUTING.md) for the full agent skills table, contribution workflow, and development setup.
|
|
286
|
+
|
|
287
|
+
## Telemetry
|
|
288
|
+
|
|
289
|
+
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.
|
|
290
|
+
|
|
291
|
+
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.
|
|
292
|
+
|
|
293
|
+
You can also compile telemetry out entirely. Telemetry support is a default-on `telemetry` Cargo feature; building with `--no-default-features` produces binaries that contain no telemetry endpoint, no telemetry HTTP client, and no emission code. Build telemetry-free artifacts with, for example, `cargo build --release -p openshell-server --no-default-features` (gateway) and the equivalent for `openshell-sandbox` and `openshell-driver-vm`. With telemetry compiled out, the gateway emits nothing and reports telemetry disabled to the sandboxes it launches.
|
|
294
|
+
|
|
295
|
+
Telemetry events are limited to anonymous operational categories and counts, such as sandbox lifecycle outcomes, provider profile buckets, policy decision counts, and aggregate network activity denial categories. OpenShell telemetry does not collect sandbox names or IDs, hostnames, file paths, binary paths, prompts, credentials, provider names, model names, or user content.
|
|
296
|
+
|
|
297
|
+
Opting out applies only to telemetry emitted by OpenShell. Third-party services, model providers, inference endpoints, agents, or tools that you configure and use with OpenShell may have their own terms and privacy practices.
|
|
298
|
+
|
|
299
|
+
We publish aggregate usage trends from this telemetry every two weeks. See the [community telemetry reports](telemetry/README.md) for the latest summary.
|
|
300
|
+
|
|
301
|
+
## Notice and Disclaimer
|
|
302
|
+
|
|
303
|
+
This software automatically retrieves, accesses or interacts with external materials. Those retrieved materials are not distributed with this software and are governed solely by separate terms, conditions and licenses. You are solely responsible for finding, reviewing and complying with all applicable terms, conditions, and licenses, and for verifying the security, integrity and suitability of any retrieved materials for your specific use case. This software is provided "AS IS", without warranty of any kind. The author makes no representations or warranties regarding any retrieved materials, and assumes no liability for any losses, damages, liabilities or legal consequences from your use or inability to use this software or any retrieved materials. Use this software and the retrieved materials at your own risk.
|
|
304
|
+
|
|
305
|
+
## License
|
|
306
|
+
|
|
307
|
+
This project is licensed under the [Apache License 2.0](https://github.com/NVIDIA/OpenShell/blob/main/LICENSE).
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
openshell/__init__.py,sha256=Am6lwbqfA_xinqo6r5K4SVP3xkBS-rQCO1-BxCLod3k,942
|
|
2
|
+
openshell/openshell_test.py,sha256=T9tdbNu4ovGjZHVZGqAd_wuT0sKy__deiCg6lF59J4M,309
|
|
3
|
+
openshell/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
4
|
+
openshell/release_formula_test.py,sha256=hJvclpomI82P_AwWNiLzJlrxnHpds2q96lDhEiSy540,7022
|
|
5
|
+
openshell/sandbox.py,sha256=-GNZwjcn53hjr26iD6WN_1-UmWL9zkVE5P8WkowbuSc,65010
|
|
6
|
+
openshell/sandbox_test.py,sha256=ALzVi3h6fqhgY1Kqp3y9WamolKgPKlK7eD7gtGqbyro,67533
|
|
7
|
+
openshell/_proto/__init__.py,sha256=FDYnhJE8-_dQDirrvSlaWJ_MGsyWgVt7y5VC1fUpkCE,568
|
|
8
|
+
openshell/_proto/datamodel_pb2.py,sha256=khO9GymekKci82OedpoJL9xEGmiG_zADXZ-XopIkCjY,6422
|
|
9
|
+
openshell/_proto/datamodel_pb2.pyi,sha256=HJZ-GMuxxwwZ6AGJF1-MYPqS79MSeo1DAbllae_-lhg,6254
|
|
10
|
+
openshell/_proto/datamodel_pb2_grpc.py,sha256=LnAsBYw7d2SEQJt5M8D3naMRrBen6KDrdaEaB0rReFU,889
|
|
11
|
+
openshell/_proto/inference_pb2.py,sha256=_O5uYcGHCOlWhf7gSfiNygZTizzYhM471TCeHmwOB5w,7297
|
|
12
|
+
openshell/_proto/inference_pb2.pyi,sha256=qx4p386Y0nKwInzYHGqXJHMp0alBtgqIefOFeVdGeVc,7124
|
|
13
|
+
openshell/_proto/inference_pb2_grpc.py,sha256=gSXpPgFzlhPL4swa5tSGe_WC6rWwy2zDr8Qdn-wzWnM,9350
|
|
14
|
+
openshell/_proto/openshell_pb2.py,sha256=oDkYash-i0qK8MPZRKNS2_0xYkUqfyYb5pJZ8ab7rgw,111070
|
|
15
|
+
openshell/_proto/openshell_pb2.pyi,sha256=nD4kJWgaGcIgwM3RtMv_Suk5Hs_O_nbRKWjOGxvSBVc,119586
|
|
16
|
+
openshell/_proto/openshell_pb2_grpc.py,sha256=Yj4iav0hGHlXh_hM8D3NyTPWK3kYUQEX0A6HIrti_jg,127552
|
|
17
|
+
openshell/_proto/options_pb2.py,sha256=peGcjxRQ3tKgRHVTTMJUSaIPhq8jIUpoUEg4DSi5Btg,1748
|
|
18
|
+
openshell/_proto/options_pb2.pyi,sha256=5n7Y0rl7-JB7Kqwmv7lRlIzsl3GzwbdAWlHF8M7NeEo,967
|
|
19
|
+
openshell/_proto/options_pb2_grpc.py,sha256=lYhrULPNsZOraK49VF_C_qYOtZGUq0GSMnG1CpOki_c,887
|
|
20
|
+
openshell/_proto/sandbox_pb2.py,sha256=jXrwHZvLiyVNrHJl8oN7NZ6tsADV6FqKHxsYMbAhtuQ,14806
|
|
21
|
+
openshell/_proto/sandbox_pb2.pyi,sha256=p5kM8516cUgtqDa13sKg_mHxPOaSiCqeDq8G8iagXoo,20791
|
|
22
|
+
openshell/_proto/sandbox_pb2_grpc.py,sha256=CzI2M_QnbgadtnCBdW1EGBXLOB7nJRV8Q4flWNtaQ3U,887
|
|
23
|
+
openshell-0.0.113.dist-info/licenses/LICENSE,sha256=uWfRyHuTt9YevPT4c35q155UM-dD5J3_OVo2-zwycEc,10788
|
|
24
|
+
openshell-0.0.113.dist-info/METADATA,sha256=XK0yE88-gWsPGUuAJnGv1A0Klz3bwSivc2pl5X5zPUA,21961
|
|
25
|
+
openshell-0.0.113.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
|
|
26
|
+
openshell-0.0.113.dist-info/top_level.txt,sha256=TaZxAuvrnQnW57jDipmyYtl0bppQ-n8l-aQ3MGk4mZc,10
|
|
27
|
+
openshell-0.0.113.dist-info/RECORD,,
|
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to the Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by the Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding any notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
Copyright 2025-2026 NVIDIA CORPORATION & AFFILIATES
|
|
180
|
+
|
|
181
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
182
|
+
you may not use this file except in compliance with the License.
|
|
183
|
+
You may obtain a copy of the License at
|
|
184
|
+
|
|
185
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
186
|
+
|
|
187
|
+
Unless required by applicable law or agreed to in writing, software
|
|
188
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
189
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
190
|
+
See the License for the specific language governing permissions and
|
|
191
|
+
limitations under the License.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
openshell
|