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: update README to reflect persimmon16 fork identity
Rewrite README for the persimmon16/OpenShell fork: add upstream badge,
fork mission statement (Apple Container migration + security hardening),
development status tables for merged and in-progress branches, replace
Docker prerequisites with Apple Container requirements, add architecture
table, and update all URLs to point to the fork.
This is an active fork of [NVIDIA/OpenShell](https://github.com/NVIDIA/OpenShell) with two objectives:
10
+
11
+
1.**Replace Docker with [Apple Container](https://github.com/apple/container)** as the container runtime on macOS, eliminating the Docker dependency entirely.
12
+
2.**Harden security** across the CI pipeline, gateway, PKI, and sandbox stack.
8
13
9
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.
10
15
11
-
OpenShell is built agent-first. The project ships with agent skills for everything from cluster debugging to policy generation, and we expect contributors to use them.
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.
| CI |`ci/trigger-macos-e2e`| macOS e2e validation with Apple Container install |
33
+
| CI |`fix/release-auto-tag-signing`| Sign auto-tags via GitHub API, handle missing seed tag |
12
34
13
-
> **Alpha software — single-player mode.** OpenShell is proof-of-life: one developer, one environment, one gateway. We are building toward multi-tenant enterprise deployments, but the starting point is getting your own environment up and running. Expect rough edges. Bring your agent.
| CI |`fix/ci-swift-bridge-dependency`| Clone Apple Container for Swift bridge build |
14
41
15
42
## Quickstart
16
43
17
44
### Prerequisites
18
45
19
-
-**Docker** — Docker Desktop (or a Docker daemon) must be running.
46
+
-**Apple Container** — [github.com/apple/container](https://github.com/apple/container). Requires Apple silicon, macOS 15+, and Xcode 26. See the Apple Container [build instructions](https://github.com/apple/container/blob/main/BUILDING.md) to install from source.
Both methods install the latest stable release by default. To install a specific version, set `OPENSHELL_VERSION` (binary) or pin the version with `uv tool install openshell==<version>`. A [`dev` release](https://github.com/NVIDIA/OpenShell/releases/tag/dev) is also available that tracks the latest commit on `main`.
62
+
Both methods install the latest stable release from upstream by default. To install a specific version, set `OPENSHELL_VERSION` (binary) or pin the version with `uv tool install openshell==<version>`.
36
63
37
64
### Create a sandbox
38
65
@@ -99,7 +126,7 @@ OpenShell isolates each sandbox in its own container with policy-enforced egress
99
126
|**Policy Engine**| Enforces filesystem, network, and process constraints from application layer down to kernel. |
100
127
|**Privacy Router**| Privacy-aware LLM routing that keeps sensitive context on sandbox compute. |
101
128
102
-
Under the hood, all these components run as a [K3s](https://k3s.io/) Kubernetes cluster inside a single Docker container — no separate K8s install required. The `openshell gateway` commands take care of provisioning the container and cluster.
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.
103
130
104
131
## Protection Layers
105
132
@@ -128,9 +155,9 @@ OpenShell can pass host GPUs into sandboxes for local inference, fine-tuning, or
128
155
openshell sandbox create --gpu --from [gpu-enabled-sandbox] -- claude
129
156
```
130
157
131
-
The CLI auto-bootstraps a GPU-enabled gateway on first use, auto-selecting CDI when available and otherwise falling back to Docker's NVIDIA GPU request path (`--gpus all`). GPU intent is also inferred automatically for community images with `gpu` in the name.
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.
132
159
133
-
**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.
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.
134
161
135
162
## Supported Agents
136
163
@@ -187,10 +214,10 @@ See the [community sandboxes](https://github.com/NVIDIA/OpenShell/blob/main/docs
187
214
188
215
## Explore with Your Agent
189
216
190
-
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.
217
+
Clone the fork 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.
191
218
192
219
```bash
193
-
git clone https://github.com/NVIDIA/OpenShell.git # or git@github.com:NVIDIA/OpenShell.git
# Point your agent here — it will discover the skills in .agents/skills/ automatically
196
223
```
@@ -208,27 +235,42 @@ OpenShell is developed using the same agent-driven workflows it enables. The `.a
208
235
209
236
All implementation work is human-gated — agents propose plans, humans approve, agents build. See [AGENTS.md](AGENTS.md) for the full workflow chain documentation.
-[Architecture](https://github.com/NVIDIA/OpenShell/tree/main/architecture) — detailed architecture docs and design decisions
224
-
-[Support Matrix](https://github.com/NVIDIA/OpenShell/blob/main/docs/reference/support-matrix.md) — platforms, versions, and kernel requirements
225
-
-[Brev Launchable](https://brev.nvidia.com/launchable/deploy/now?launchableID=env-3Ap3tL55zq4a8kew1AuW0FpSLsg) — try OpenShell on cloud compute without local setup
265
+
-[Full Documentation](https://docs.nvidia.com/openshell/latest/index.html) — upstream overview, architecture, tutorials, and reference
266
+
-[Architecture](architecture/) — detailed architecture docs and design decisions
267
+
-[Apple Container](https://github.com/apple/container) — the macOS container runtime this fork targets
226
268
-[Agent Instructions](AGENTS.md) — system prompt and workflow documentation for agent contributors
227
269
228
270
## Contributing
229
271
230
-
OpenShell is built agent-first — your agent is your first collaborator. Before opening issues or submitting code, point your agent at the repo and let it use the skills in `.agents/skills/` to investigate, diagnose, and prototype. See [CONTRIBUTING.md](CONTRIBUTING.md) for the full agent skills table, contribution workflow, and development setup.
272
+
This fork is built agent-first — your agent is your first collaborator. See [CONTRIBUTING.md](CONTRIBUTING.md) for the full agent skills table, contribution workflow, and development setup. For upstream contributions, open PRs against [NVIDIA/OpenShell](https://github.com/NVIDIA/OpenShell).
231
273
232
274
## License
233
275
234
-
This project is licensed under the [Apache License 2.0](https://github.com/NVIDIA/OpenShell/blob/main/LICENSE).
276
+
This project is licensed under the [Apache License 2.0](LICENSE).
0 commit comments