Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/about/how-it-works.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ When the agent tries to reach an unlisted host, OpenShell blocks the request and
- Refer to the [Architecture](../reference/architecture) for the full technical structure, including file layouts and the blueprint lifecycle.
- Refer to [Inference Options](../inference/inference-options) for detailed provider configuration.
- For details on the baseline rules, refer to [Network Policies](../reference/network-policies).
- For container-level hardening, refer to [Sandbox Hardening](../deployment/sandbox-hardening).
- For container-level hardening, refer to [Sandbox Hardening](../manage-sandboxes/sandbox-hardening).

</AgentOnly>
<AgentOnly variant="hermes">
Expand Down
4 changes: 2 additions & 2 deletions docs/about/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ NemoClaw v0.0.55 improves local Ollama onboarding reliability, plugin secret-sca
NemoClaw v0.0.54 updates messaging activation, Windows WSL onboarding, NemoHermes dashboard access, and sandbox repair paths:

- Generated OpenClaw config now marks Telegram, Discord, Slack, and WhatsApp as enabled at the channel level. Selected messaging plugins are pinned during the image build, and `channels add` verifies Telegram, Discord, and Slack bridge startup after the rebuild instead of leaving silent channel failures for later debugging. For more information, refer to [Messaging Channels](../manage-sandboxes/messaging-channels).
- The Windows bootstrap flow waits for Ubuntu account creation before touching Docker settings, enables Docker Desktop WSL integration for the target distro, avoids changing the global WSL default distro, and adds WSL-specific Docker reachability hints during onboarding. For more information, refer to [Prepare Windows for NemoClaw](../get-started/windows-preparation).
- The Windows bootstrap flow waits for Ubuntu account creation before touching Docker settings, enables Docker Desktop WSL integration for the target distro, avoids changing the global WSL default distro, and adds WSL-specific Docker reachability hints during onboarding. For more information, refer to [Prepare Windows for NemoClaw](../get-started/prerequisites/windows-preparation).
Comment thread
miyoungc marked this conversation as resolved.
- Windows-host Ollama setup inside WSL now requires the Docker Desktop WSL integration path. NemoClaw still shows Windows-host Ollama options when it detects them, but labels the Docker Desktop requirement and blocks unsupported native Docker-in-WSL selections before it tries to start or install Ollama. For more information, refer to [Use a Local Inference Server](../inference/use-local-inference).
- NemoHermes can expose the optional native Hermes web dashboard separately from the OpenAI-compatible API. Set `NEMOCLAW_HERMES_DASHBOARD=1` before onboarding to start and forward the dashboard on port `9119`, with `NEMOCLAW_HERMES_DASHBOARD_PORT` and `NEMOCLAW_HERMES_DASHBOARD_TUI` available for port and TUI tab control. For more information, refer to [NemoClaw Quickstart with Hermes](../get-started/quickstart-hermes).
- NemoHermes can expose the optional native Hermes web dashboard separately from the OpenAI-compatible API. Set `NEMOCLAW_HERMES_DASHBOARD=1` before onboarding to start and forward the dashboard on port `9119`, with `NEMOCLAW_HERMES_DASHBOARD_PORT` and `NEMOCLAW_HERMES_DASHBOARD_TUI` available for port and TUI tab control. For more information, refer to [NemoClaw Quickstart with Hermes](../../hermes/get-started/quickstart-hermes).
- Onboarding diagnostics include more copy-paste-ready recovery hints. Invalid sandbox names now include a `Try: <suggested-slug>` line when NemoClaw can derive a valid name, and non-interactive NVIDIA Endpoints setup prints the exact `export NVIDIA_API_KEY=nvapi-...` shape when the key is missing. For more information, refer to [NemoClaw CLI Commands Reference](../reference/commands).
- Homebrew stays on the Linuxbrew prefix while exposing installed formula commands in sandbox shell sessions, the `/nemoclaw` slash command activates at OpenClaw startup again, Hermes rebuilds tolerate older release tarballs that lack optional UI package lockfiles, and device scope-upgrade approvals recover without being pinned to the old gateway-scoped request. For more information, refer to [Common NemoClaw Integration Policy Examples](../network-policy/integration-policy-examples).
- The host-gateway allowance for OpenClaw `web_fetch` is confined to the trusted proxy path, while strict and direct paths continue to block host-gateway names. Hermes Provider onboarding skips the host-side smoke probe only for OAuth-backed setup and keeps direct validation for Nous API key setup. For more information, refer to [NemoClaw Inference Options](../inference/inference-options).
Expand Down
12 changes: 6 additions & 6 deletions docs/deployment/brev-web-ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This flow provisions a remote VM, configures inference, starts OpenClaw inside a

<Note>
Use this guide when you want to try NemoClaw without installing the CLI or using a local GPU.
If you want to manage the remote host from a terminal, see [Deploy to a Remote GPU Instance](/deployment/deploy-to-remote-gpu).
If you want to manage the remote host from a terminal, see [Deploy to a Remote GPU Instance](deploy-to-remote-gpu).
</Note>

## What This Flow Creates
Expand Down Expand Up @@ -155,8 +155,8 @@ Check the Brev UI for the current hourly price before leaving the instance runni

After your agent is running, explore these related tasks:

- [Set Up Messaging Channels](/manage-sandboxes/messaging-channels) to learn how to connect Telegram, Slack, or Discord.
- [Switch Inference Providers](/inference/switch-inference-providers) to learn how to change the model provider after setup.
- [Monitor Sandbox Activity](/monitoring/monitor-sandbox-activity) to learn how to inspect sandbox health and logs.
- [Deploy to a Remote GPU Instance](/deployment/deploy-to-remote-gpu) to learn how to deploy NemoClaw to a remote GPU instance using the CLI.
- [Troubleshooting](/reference/troubleshooting) to learn how to fix common setup and runtime issues.
- [Set Up Messaging Channels](../manage-sandboxes/messaging-channels) to learn how to connect Telegram, Slack, or Discord.
- [Switch Inference Providers](../inference/switch-inference-providers) to learn how to change the model provider after setup.
- [Monitor Sandbox Activity](../monitoring/monitor-sandbox-activity) to learn how to inspect sandbox health and logs.
- [Deploy to a Remote GPU Instance](deploy-to-remote-gpu) to learn how to deploy NemoClaw to a remote GPU instance using the CLI.
- [Troubleshooting](../reference/troubleshooting) to learn how to fix common setup and runtime issues.
8 changes: 4 additions & 4 deletions docs/deployment/deploy-to-remote-gpu.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ nemoclaw onboard
```

If onboard ends with `Sandbox '<name>' was created but did not become ready within 180s`, onboard deletes the partially-created sandbox first, so the next attempt with the raised budget starts from a clean state.
For the inference-probe budget that runs earlier in onboarding, see [`NEMOCLAW_LOCAL_INFERENCE_TIMEOUT`](/inference/use-local-inference#timeout-configuration).
For the inference-probe budget that runs earlier in onboarding, see [`NEMOCLAW_LOCAL_INFERENCE_TIMEOUT`](../inference/use-local-inference#timeout-configuration).

## Proxy Configuration

Expand Down Expand Up @@ -163,6 +163,6 @@ nemoclaw deploy <instance-name>

## Related Topics

- [Set Up Messaging Channels](/manage-sandboxes/messaging-channels) to connect Telegram, Discord, or Slack through OpenShell-managed channel messaging.
- [Monitor Sandbox Activity](/monitoring/monitor-sandbox-activity) for sandbox monitoring tools.
- [Commands](/reference/commands) for the full `deploy` command reference.
- [Set Up Messaging Channels](../manage-sandboxes/messaging-channels) to connect Telegram, Discord, or Slack through OpenShell-managed channel messaging.
- [Monitor Sandbox Activity](../monitoring/monitor-sandbox-activity) for sandbox monitoring tools.
- [Commands](../reference/commands) for the full `deploy` command reference.
10 changes: 5 additions & 5 deletions docs/deployment/install-openclaw-plugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ Plugins still run inside the sandbox policy boundary. If a plugin needs network
egress, add or update a policy preset for the required hostnames and binaries
before rebuilding the sandbox.

For example, see [Network Policies](/reference/network-policies) for
policy concepts and [Customize Network Policy](/network-policy/customize-network-policy)
For example, see [Network Policies](../reference/network-policies) for
policy concepts and [Customize Network Policy](../network-policy/customize-network-policy)
for custom preset workflows.

## Common Mistakes
Expand All @@ -94,9 +94,9 @@ other NemoClaw extension paths.

## Next Steps

- Review [Sandbox Hardening](/deployment/sandbox-hardening) before adding plugin code to a
- Review [Sandbox Hardening](sandbox-hardening) before adding plugin code to a
Comment thread
miyoungc marked this conversation as resolved.
shared or long-lived sandbox.
- Review [Network Policies](/reference/network-policies) to plan plugin
- Review [Network Policies](../reference/network-policies) to plan plugin
egress rules.
- Follow [Customize Network Policy](/network-policy/customize-network-policy)
- Follow [Customize Network Policy](../network-policy/customize-network-policy)
if the plugin needs a custom preset.
2 changes: 1 addition & 1 deletion docs/get-started/prerequisites.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,6 @@ The table is generated from [`ci/platform-matrix.json`](https://github.com/NVIDI

## Next Steps

- [Prepare Windows for NemoClaw](windows-preparation) if you are using Windows.
- [Prepare Windows for NemoClaw](prerequisites/windows-preparation) if you are using Windows.
Comment thread
miyoungc marked this conversation as resolved.
- [Quickstart](quickstart) to install NemoClaw and launch your first sandbox.
- [Agent Skills](../resources/agent-skills) to load NemoClaw guidance into an AI coding assistant before setup.
14 changes: 7 additions & 7 deletions docs/get-started/windows-preparation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ import { AgentOnly } from "../_components/AgentGuide";

You can run NemoClaw inside Windows Subsystem for Linux (WSL 2) on Windows.
<AgentOnly variant="openclaw">
Complete these steps before following the [Quickstart](quickstart).
Complete these steps before following the [Quickstart](../quickstart).
</AgentOnly>
<AgentOnly variant="hermes">
Complete these steps before following [Quickstart with Hermes](quickstart-hermes).
Complete these steps before following [Quickstart with Hermes](../quickstart-hermes).
Comment thread
miyoungc marked this conversation as resolved.
</AgentOnly>
Linux and macOS users do not need this page and can go directly to the Quickstart.

Expand All @@ -31,12 +31,12 @@ Verify the following before you begin:
- Windows 10 (build 19041 or later) or Windows 11.
<AgentOnly variant="openclaw">

- Hardware requirements are the same as the [Quickstart](quickstart).
- Hardware requirements are the same as the [Quickstart](../quickstart).

</AgentOnly>
<AgentOnly variant="hermes">

- Hardware requirements are the same as [Quickstart with Hermes](quickstart-hermes).
- Hardware requirements are the same as [Quickstart with Hermes](../quickstart-hermes).

</AgentOnly>

Expand Down Expand Up @@ -163,14 +163,14 @@ Use one instance, or move one of them to a different port before running `nemocl
Your Windows environment is ready.
If you used the bootstrap script, follow the installer command it printed inside Ubuntu.
<AgentOnly variant="openclaw">
If you prepared Windows manually, open a WSL terminal (type `wsl` in PowerShell, or open Ubuntu from Windows Terminal) and continue with the [Quickstart](quickstart) to install NemoClaw and launch your first sandbox.
If you prepared Windows manually, open a WSL terminal (type `wsl` in PowerShell, or open Ubuntu from Windows Terminal) and continue with the [Quickstart](../quickstart) to install NemoClaw and launch your first sandbox.
</AgentOnly>
<AgentOnly variant="hermes">
If you prepared Windows manually, open a WSL terminal (type `wsl` in PowerShell, or open Ubuntu from Windows Terminal) and continue with [Quickstart with Hermes](quickstart-hermes) to install NemoClaw and launch your first Hermes sandbox.
If you prepared Windows manually, open a WSL terminal (type `wsl` in PowerShell, or open Ubuntu from Windows Terminal) and continue with [Quickstart with Hermes](../quickstart-hermes) to install NemoClaw and launch your first Hermes sandbox.
</AgentOnly>

All NemoClaw commands run inside WSL, not in PowerShell.

## Troubleshooting

For Windows-specific troubleshooting, refer to the [Windows Subsystem for Linux section](../reference/troubleshooting#windows-subsystem-for-linux) in the Troubleshooting guide.
For Windows-specific troubleshooting, refer to the [Windows Subsystem for Linux section](../../reference/troubleshooting#windows-subsystem-for-linux) in the Troubleshooting guide.
11 changes: 5 additions & 6 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ layout: overview
position: 1
---

import { AgentOnly, guidePath } from "./_components/AgentGuide";
import { BadgeLinks } from "./_components/BadgeLinks";
import { CommandTerminal } from "./_components/CommandTerminal";

Expand Down Expand Up @@ -60,23 +59,23 @@ By default, NemoClaw installs the OpenClaw agent. Use one of the following quick

| Agent | Guide |
|-------|-------|
| OpenClaw (default) | [Quickstart with OpenClaw](/user-guide/openclaw/get-started/quickstart) |
| Hermes | [Quickstart with Hermes](/user-guide/hermes/get-started/quickstart-hermes) |
| OpenClaw (default) | [Quickstart with OpenClaw](../openclaw/get-started/quickstart) |
| Hermes | [Quickstart with Hermes](../hermes/get-started/quickstart-hermes) |

## Select User Guide for Your Agent

The NemoClaw documentation provides separate user guides for the agents it supports. Select the guide that matches your agent. You can also select the guide from the dropdown at the top of the left navigation pane.

<Cards>

<Card title="NemoClaw for OpenClaw" href="/user-guide/openclaw/about/overview">
<Card title="NemoClaw for OpenClaw" href="../openclaw/about/overview">

Read the OpenClaw-focused overview before launching the default sandboxed agent.

<Badge intent="tip" minimal outlined>Overview</Badge>
</Card>

<Card title="NemoClaw for Hermes" href="/user-guide/hermes/about/overview">
<Card title="NemoClaw for Hermes" href="../hermes/about/overview">

Read the Hermes-focused overview before launching a Hermes sandboxed agent.

Expand All @@ -92,7 +91,7 @@ The skills turn these docs into task-focused guidance that your assistant can ap

<Cards>

<Card title="Set Up Agent Skills" href={guidePath("/resources/agent-skills")}>
<Card title="Set Up Agent Skills" href="resources/agent-skills">

Clone the skills or add them to your assistant so NemoClaw guidance is available directly in chat.

Expand Down
1 change: 1 addition & 0 deletions docs/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ navigation:
slug: switch-inference-providers
- page: "Set Up Task-Specific Sub-Agents"
path: inference/set-up-sub-agent.mdx
slug: set-up-sub-agent
- section: "Manage Sandboxes"
slug: manage-sandboxes
collapsed: open-by-default
Expand Down
8 changes: 4 additions & 4 deletions docs/manage-sandboxes/install-plugins-hermes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ If a plugin calls an external API at runtime, add a policy preset for the requir
Hermes uses Python for plugin execution, so policy entries usually need to allow the Hermes Python runtime, such as `/opt/hermes/.venv/bin/python`, in addition to any command-line wrapper your plugin starts.
For package downloads during sandbox runtime, use the `pypi` preset or a custom preset that allows the package hosts you need.

For policy concepts, see [Network Policies](/reference/network-policies).
For custom preset workflows, see [Customize Network Policy](/network-policy/customize-network-policy).
For policy concepts, see [Network Policies](../reference/network-policies).
For custom preset workflows, see [Customize Network Policy](../network-policy/customize-network-policy).

## Common Mistakes

Expand All @@ -120,6 +120,6 @@ These are the most common places where Hermes plugin installation gets mixed up

## Next Steps

- Review [NemoHermes Command Reference](/reference/commands-nemohermes#nemohermes-onboard-from) for `nemohermes onboard --from` details.
- Review [Customize Network Policy](/network-policy/customize-network-policy) if the plugin needs runtime network egress.
- Review [NemoHermes Command Reference](../reference/commands#nemohermes-onboard-from) for `nemohermes onboard --from` details.
- Review [Customize Network Policy](../network-policy/customize-network-policy) if the plugin needs runtime network egress.
- Review [Runtime Controls](./runtime-controls) before changing shields or mutability settings for a plugin-enabled sandbox.
2 changes: 1 addition & 1 deletion docs/reference/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -973,7 +973,7 @@ Skill names must contain only alphanumeric characters, dots, hyphens, and unders

<AgentOnly variant="openclaw">

OpenClaw plugins are a different kind of extension. To install an OpenClaw plugin, see [Install OpenClaw Plugins](../deployment/install-openclaw-plugins).
OpenClaw plugins are a different kind of extension. To install an OpenClaw plugin, see [Install OpenClaw Plugins](../manage-sandboxes/install-openclaw-plugins).

</AgentOnly>
<AgentOnly variant="hermes">
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1274,7 +1274,7 @@ If you run other services on Spark that expect port 3000, bind them to a differe
<a id="windows-wsl-2"></a>
## Windows Subsystem for Linux

For environment setup steps, see [Windows Prerequisites](../get-started/windows-preparation).
For environment setup steps, see [Windows Prerequisites](../get-started/prerequisites/windows-preparation).
Comment thread
miyoungc marked this conversation as resolved.

### `wsl --install --no-distribution` returns Forbidden (403)

Expand Down Expand Up @@ -1348,7 +1348,7 @@ sudo systemctl stop ollama
OLLAMA_CONTEXT_LENGTH=16384 ollama serve
```

For additional troubleshooting, see the [Quickstart](../get-started/quickstart) and [Windows Setup](../get-started/windows-preparation) pages.
For additional troubleshooting, see the [Quickstart](../get-started/quickstart) and [Windows Setup](../get-started/prerequisites/windows-preparation) pages.

## Podman

Expand Down Expand Up @@ -1442,7 +1442,7 @@ After the rebuild completes, return to the Skills page to confirm the skill is r
## Hermes

The issues below are common problems you may encounter when running Hermes through `nemohermes`.
For setup, refer to [Quickstart with Hermes](/get-started/quickstart-hermes).
For setup, refer to [Quickstart with Hermes](../../hermes/get-started/quickstart-hermes).

### Port 8642 in a browser shows a blank page or `Cannot GET /`

Expand Down Expand Up @@ -1539,7 +1539,7 @@ Reset a specific provider's credentials with `nemohermes credentials reset <prov

### `Brave Search` policy preset has no effect under Hermes

The Hermes wizard intentionally omits the Brave Search preset because Hermes does not use NemoClaw's OpenClaw web-search configuration (see [Quickstart with Hermes](/get-started/quickstart-hermes) and [Network Policies](/reference/network-policies)).
The Hermes wizard intentionally omits the Brave Search preset because Hermes does not use NemoClaw's OpenClaw web-search configuration (see [Quickstart with Hermes](../../hermes/get-started/quickstart-hermes) and [Network Policies](network-policies)).
If you add the `brave` preset to a Hermes sandbox after onboarding, the L7 egress allowlist opens for Brave's endpoints but the agent itself does not start consuming the credential.
Configure Hermes web search from the agent's own configuration inside the sandbox.

Expand Down
Loading
Loading