You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: remove Docker/K3s/Kubernetes references from all documentation
Update README to reflect completed Apple Container migration: move
feat/apple-container and fix/ci-swift-bridge-dependency from In Progress
to merged status table, rewrite How It Works to describe native gateway
and container bridge architecture, remove GPU passthrough section, add
container-bridge to architecture table.
Remove K3s/Kubernetes/Docker references from: architecture docs
(sandbox-connect, sandbox-providers), agent configs (arch-doc-writer),
skill docs (update-docs), project docs (AGENTS.md, CONTRIBUTING.md),
and agent memory (arch-doc-writer MEMORY.md).
Copy file name to clipboardExpand all lines: README.md
+9-29Lines changed: 9 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,30 +13,23 @@ This is an active fork of [NVIDIA/OpenShell](https://github.com/NVIDIA/OpenShell
13
13
14
14
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.
15
15
16
-
> **Fork status: active development.** The Apple Container migration is in progress. Security hardening has landed across 8 merged PRs. This fork tracks upstream and periodically syncs.
16
+
> **Fork status: Apple Container migration complete.**Docker and K3s/Kubernetes have been fully removed. The gateway runs as a native macOS process and sandboxes are Apple Container VMs. Security hardening has landed across 8 merged PRs. This fork tracks upstream and periodically syncs.
| CI |`fix/ci-swift-bridge-dependency`| Clone Apple Container for Swift bridge build |
41
34
42
35
## Quickstart
@@ -67,7 +60,7 @@ Both methods install the latest stable release from upstream by default. To inst
67
60
openshell sandbox create -- claude # or opencode, codex, copilot
68
61
```
69
62
70
-
A gateway is created automatically on first use. To deploy on a remote host instead, pass `--remote user@host` to the create command.
63
+
A gateway is created automatically on first use.
71
64
72
65
The sandbox container includes the following tools by default:
73
66
@@ -126,7 +119,7 @@ OpenShell isolates each sandbox in its own container with policy-enforced egress
126
119
|**Policy Engine**| Enforces filesystem, network, and process constraints from application layer down to kernel. |
127
120
|**Privacy Router**| Privacy-aware LLM routing that keeps sensitive context on sandbox compute. |
128
121
129
-
Under the hood, all these components run as a [K3s](https://k3s.io/) Kubernetes cluster inside a container — no separate K8s install required. On this fork, the container runtime is [Apple Container](https://github.com/apple/container)on macOS (replacing the upstream Docker dependency). The `openshell gateway` commands take care of provisioning the container and cluster.
122
+
On this fork, the gateway runs as a native macOS process and each sandbox is an [Apple Container](https://github.com/apple/container)VM. A Swift-based container bridge translates gRPC sandbox lifecycle calls into Apple Container API operations. The `openshell gateway` commands manage the gateway process and container bridge daemon.
130
123
131
124
## Protection Layers
132
125
@@ -145,20 +138,6 @@ Policies are declarative YAML files. Static sections (filesystem, process) are l
145
138
146
139
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.
147
140
148
-
## GPU Support (Experimental)
149
-
150
-
> **Experimental** — GPU passthrough works on supported hosts but is under active development. Expect rough edges and breaking changes.
151
-
152
-
OpenShell can pass host GPUs into sandboxes for local inference, fine-tuning, or any GPU workload. Add `--gpu` when creating a sandbox:
153
-
154
-
```bash
155
-
openshell sandbox create --gpu --from [gpu-enabled-sandbox] -- claude
156
-
```
157
-
158
-
The CLI auto-bootstraps a GPU-enabled gateway on first use, auto-selecting CDI when available. GPU intent is also inferred automatically for community images with `gpu` in the name.
159
-
160
-
**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 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.
161
-
162
141
## Supported Agents
163
142
164
143
| Agent | Source | Notes |
@@ -188,7 +167,7 @@ See the full [CLI reference](https://github.com/NVIDIA/OpenShell/blob/main/docs/
188
167
189
168
## Terminal UI
190
169
191
-
OpenShell includes a real-time terminal dashboard for monitoring gateways, sandboxes, and providers — inspired by [k9s](https://k9scli.io/).
170
+
OpenShell includes a real-time terminal dashboard for monitoring gateways, sandboxes, and providers.
The TUI gives you a live, keyboard-driven view of your cluster. Navigate with `Tab` to switch panels, `j`/`k` to move through lists, `Enter` to select, and `:` for command mode. Cluster health and sandbox status auto-refresh every two seconds.
180
+
The TUI gives you a live, keyboard-driven view of your gateways 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.
202
181
203
182
## Community Sandboxes and BYOC
204
183
@@ -244,7 +223,8 @@ All implementation work is human-gated — agents propose plans, humans approve,
0 commit comments