Skip to content

Commit 603b3e2

Browse files
authored
docs: update NemoClaw/OpenClaw references (#1529)
1 parent 0cef265 commit 603b3e2

11 files changed

Lines changed: 21 additions & 70 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Docker-backed GPU sandboxes auto-select CDI when available and otherwise fall ba
153153
| [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`. |
154154
| [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`. |
155155
| [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`. |
156-
| [OpenClaw](https://openclaw.ai/) | [Community](https://github.com/NVIDIA/OpenShell-Community) | Launch with `openshell sandbox create --from openclaw`. |
156+
| [OpenClaw](https://openclaw.ai/) | [NemoClaw](https://github.com/NVIDIA/NemoClaw) | Run OpenClaw more securely inside NVIDIA OpenShell with managed inference using NemoClaw. |
157157
| [Ollama](https://ollama.com/) | [Community](https://github.com/NVIDIA/OpenShell-Community) | Launch with `openshell sandbox create --from ollama`. |
158158

159159
## Key Commands
@@ -191,7 +191,7 @@ The TUI gives you a live, keyboard-driven view of your gateway and sandboxes. Na
191191
Use `--from` to create sandboxes from the [OpenShell Community](https://github.com/NVIDIA/OpenShell-Community) catalog, a local directory, or a container image:
192192

193193
```bash
194-
openshell sandbox create --from openclaw # community catalog
194+
openshell sandbox create --from gemini # community catalog
195195
openshell sandbox create --from ./my-sandbox-dir # local Dockerfile
196196
openshell sandbox create --from registry.io/img:v1 # container image
197197
```

crates/openshell-cli/src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1153,7 +1153,7 @@ enum SandboxCommands {
11531153
#[arg(long, add = ArgValueCompleter::new(completers::complete_sandbox_names))]
11541154
name: Option<String>,
11551155

1156-
/// Sandbox source: a community sandbox name (e.g., `openclaw`), a path
1156+
/// Sandbox source: a community sandbox name (e.g., `ollama`), a path
11571157
/// to a Dockerfile or directory containing one, or a full container
11581158
/// image reference (e.g., `myregistry.com/img:tag`).
11591159
///

crates/openshell-cli/src/run.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2018,7 +2018,7 @@ pub async fn sandbox_create(
20182018

20192019
// If --forward was requested, start the background port forward
20202020
// *before* running the command so that long-running processes
2021-
// (e.g. `openclaw gateway`) are reachable immediately.
2021+
// (e.g. a web gateway) are reachable immediately.
20222022
if let Some(ref spec) = forward {
20232023
sandbox_forward(
20242024
&effective_server,
@@ -7412,7 +7412,7 @@ mod tests {
74127412
for image in [
74137413
"ghcr.io/nvidia/openshell-community/sandboxes/base:latest",
74147414
"registry.example.com/gpu/team/base:latest",
7415-
"registry.example.com/team/openclaw:latest",
7415+
"registry.example.com/team/notebook:latest",
74167416
"cuda-toolkit:latest",
74177417
"registry.example.com/team/graphics:latest",
74187418
] {
@@ -7524,43 +7524,43 @@ mod tests {
75247524
fn service_url_for_gateway_uses_external_gateway_port() {
75257525
assert_eq!(
75267526
service_url_for_gateway(
7527-
"https://quiet-flamingo--openclaw.navigator.openshell.localhost:8080/",
7527+
"https://quiet-flamingo--notebook.navigator.openshell.localhost:8080/",
75287528
"https://127.0.0.1:31886"
75297529
),
7530-
"https://quiet-flamingo--openclaw.navigator.openshell.localhost:31886/"
7530+
"https://quiet-flamingo--notebook.navigator.openshell.localhost:31886/"
75317531
);
75327532
}
75337533

75347534
#[test]
75357535
fn service_url_for_gateway_omits_default_external_port() {
75367536
assert_eq!(
75377537
service_url_for_gateway(
7538-
"https://quiet-flamingo--openclaw.navigator.openshell.localhost:8080/",
7538+
"https://quiet-flamingo--notebook.navigator.openshell.localhost:8080/",
75397539
"https://gateway.example.com"
75407540
),
7541-
"https://quiet-flamingo--openclaw.navigator.openshell.localhost/"
7541+
"https://quiet-flamingo--notebook.navigator.openshell.localhost/"
75427542
);
75437543
}
75447544

75457545
#[test]
75467546
fn service_url_for_gateway_preserves_service_scheme() {
75477547
assert_eq!(
75487548
service_url_for_gateway(
7549-
"http://quiet-flamingo--openclaw.navigator.openshell.localhost:8080/",
7549+
"http://quiet-flamingo--notebook.navigator.openshell.localhost:8080/",
75507550
"https://127.0.0.1:31886"
75517551
),
7552-
"http://quiet-flamingo--openclaw.navigator.openshell.localhost:31886/"
7552+
"http://quiet-flamingo--notebook.navigator.openshell.localhost:31886/"
75537553
);
75547554
}
75557555

75567556
#[test]
75577557
fn service_url_for_gateway_uses_gateway_default_port() {
75587558
assert_eq!(
75597559
service_url_for_gateway(
7560-
"http://quiet-flamingo--openclaw.navigator.openshell.localhost:8080/",
7560+
"http://quiet-flamingo--notebook.navigator.openshell.localhost:8080/",
75617561
"https://gateway.example.com"
75627562
),
7563-
"http://quiet-flamingo--openclaw.navigator.openshell.localhost:443/"
7563+
"http://quiet-flamingo--notebook.navigator.openshell.localhost:443/"
75647564
);
75657565
}
75667566

crates/openshell-cli/src/ssh.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1574,8 +1574,8 @@ mod tests {
15741574
"/sandbox/file.txt"
15751575
);
15761576
assert_eq!(
1577-
validate_sandbox_source_path("/sandbox/.openclaw/workspace/hello.txt").unwrap(),
1578-
"/sandbox/.openclaw/workspace/hello.txt"
1577+
validate_sandbox_source_path("/sandbox/.agent/workspace/hello.txt").unwrap(),
1578+
"/sandbox/.agent/workspace/hello.txt"
15791579
);
15801580
assert_eq!(
15811581
validate_sandbox_source_path("/sandbox").unwrap(),

docs/about/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ OpenShell supports a range of agent deployment patterns.
4444

4545
| Use Case | Description |
4646
|-----------------------------|----------------------------------------------------------------------------------------------------------|
47-
| Secure coding agents | Run Claude Code, OpenCode, or OpenClaw with constrained file and network access. |
47+
| Secure coding agents | Run Claude Code, OpenCode, Codex, or GitHub Copilot CLI with constrained file and network access. |
4848
| Private enterprise development | Route inference to self-hosted or private backends while keeping sensitive context under your control. |
4949
| Compliance and audit | Treat policy YAML as version-controlled security controls that can be reviewed and audited. |
5050
| Reusable environments | Use community sandbox images or bring your own containerized runtime. |

docs/about/supported-agents.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ description: "AI agent frameworks and runtimes compatible with OpenShell sandbox
66
keywords: "Generative AI, Cybersecurity, AI Agents, Sandboxing, Claude, Codex, Cursor"
77
position: 5
88
---
9-
The following table summarizes the agents that run in OpenShell sandboxes. All agent sandbox images are maintained in the [OpenShell Community](https://github.com/NVIDIA/OpenShell-Community) repository. Agents in the base image are auto-configured when passed as the trailing command to `openshell sandbox create`.
9+
The following table summarizes the agents that run in OpenShell sandboxes. Most agent sandbox images are maintained in the [OpenShell Community](https://github.com/NVIDIA/OpenShell-Community) repository. Agents in the base image are auto-configured when passed as the trailing command to `openshell sandbox create`.
1010

1111
| Agent | Source | Default Policy | Notes |
1212
|---|---|---|---|
1313
| [Claude Code](https://docs.anthropic.com/en/docs/claude-code) | [`base`](https://github.com/NVIDIA/OpenShell-Community/tree/main/sandboxes/base) | Full coverage | Works out of the box. Requires `ANTHROPIC_API_KEY`. |
1414
| [OpenCode](https://opencode.ai/) | [`base`](https://github.com/NVIDIA/OpenShell-Community/tree/main/sandboxes/base) | Partial coverage | Pre-installed. Add `opencode.ai` endpoint and OpenCode binary paths to the policy for full functionality. |
1515
| [Codex](https://developers.openai.com/codex) | [`base`](https://github.com/NVIDIA/OpenShell-Community/tree/main/sandboxes/base) | No coverage | Pre-installed. Requires a custom policy with OpenAI endpoints and Codex binary paths. Requires `OPENAI_API_KEY`. |
1616
| [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) | Full coverage | Pre-installed. Works out of the box. Requires `GITHUB_TOKEN` or `COPILOT_GITHUB_TOKEN`. |
17-
| [OpenClaw](https://openclaw.ai/) | [`openclaw`](https://github.com/NVIDIA/OpenShell-Community/tree/main/sandboxes/openclaw) | Bundled | Agent orchestration layer. Launch with `openshell sandbox create --from openclaw`. |
17+
| [OpenClaw](https://openclaw.ai/) | [NemoClaw](https://github.com/NVIDIA/NemoClaw) | Blueprint-managed | Run OpenClaw more securely inside NVIDIA OpenShell with managed inference using NemoClaw. |
1818
| [Ollama](https://ollama.com/) | [`ollama`](https://github.com/NVIDIA/OpenShell-Community/tree/main/sandboxes/ollama) | Bundled | Run cloud and local models. Includes Claude Code, Codex, and OpenCode. Launch with `openshell sandbox create --from ollama`. |
1919

2020
For base image details and `--from` usage, refer to [Sandboxes](/sandboxes/manage-sandboxes#base-sandbox-container).

docs/get-started/quickstart.mdx

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -90,17 +90,6 @@ If `OPENAI_API_KEY` is set in your environment, the CLI picks it up automaticall
9090
If not, you can configure it from inside the sandbox after it launches.
9191
</Tab>
9292

93-
<Tab title="OpenClaw">
94-
95-
Run the following command to create a sandbox with OpenClaw:
96-
97-
```shell
98-
openshell sandbox create --from openclaw
99-
```
100-
101-
The `--from` flag pulls a pre-built sandbox container with its bundled policy and optional skills.
102-
</Tab>
103-
10493
<Tab title="Base Sandbox">
10594

10695
Use the `--from` flag to create a sandbox from the base container:

docs/sandboxes/manage-sandboxes.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,12 @@ Use `--from` to create a sandbox from the base image, another pre-built sandbox
6161
6262
```shell
6363
openshell sandbox create --from base
64-
openshell sandbox create --from openclaw
6564
openshell sandbox create --from ollama
6665
openshell sandbox create --from ./my-sandbox-dir
6766
openshell sandbox create --from my-registry.example.com/my-image:latest
6867
```
6968
70-
Bare names such as `base`, `openclaw`, and `ollama` resolve to images under `ghcr.io/nvidia/openshell-community/sandboxes`. Set `OPENSHELL_COMMUNITY_REGISTRY` when you need to use an internal mirror.
69+
Bare names such as `base` and `ollama` resolve to images under `ghcr.io/nvidia/openshell-community/sandboxes`. Set `OPENSHELL_COMMUNITY_REGISTRY` when you need to use an internal mirror.
7170
7271
Local directories and Dockerfiles require a local gateway because the CLI builds
7372
through the local Docker daemon. Use a registry image reference for remote

docs/security/best-practices.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ For the full policy YAML schema, refer to the [Policy Schema](/reference/policy-
1616
For the architecture of each enforcement layer, refer to [How OpenShell Works](/about/how-it-works).
1717

1818
<Note>
19-
If you use [NemoClaw](https://github.com/NVIDIA/NemoClaw) to run OpenClaw assistants, its [Security Best Practices](https://docs.nvidia.com/nemoclaw/latest/security/best-practices.html) guide covers additional entrypoint-level controls, policy presets, provider trust tiers, and posture profiles specific to the NemoClaw blueprint.
19+
If you use [NemoClaw](https://github.com/NVIDIA/NemoClaw), its [Security Best Practices](https://docs.nvidia.com/nemoclaw/latest/security/best-practices.html) guide covers additional entrypoint-level controls, policy presets, provider trust tiers, and posture profiles specific to the NemoClaw blueprint.
2020

2121
</Note>
2222

examples/openclaw.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)