For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
User Guide
User Guide
    • Home
      • Overview
      • Architecture Overview
      • Ecosystem
      • Release Notes
      • Prerequisites
      • Quickstart with Hermes
      • Inference Options
      • Use Local Inference
      • Switch Inference Providers
      • Manage Sandbox Lifecycle
      • Runtime Controls
      • Set Up Messaging Channels
      • Workspace Files
      • Backup and Restore
      • Install Hermes Plugins
      • Approve or Deny Network Requests
      • Customize the Network Policy
      • Integration Policy Examples
      • Monitor Sandbox Activity
      • Security Best Practices
      • Credential Storage
      • Architecture Details
      • Commands
      • Which CLI to Use
      • Network Policies
      • Troubleshooting
      • Agent Skills
      • Report Vulnerabilities
      • License
      • Discord
NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.

LogoLogoNemoClaw
On this page
  • List Sandboxes
  • Check Sandbox Health
  • Inspect Logs
  • Collect Diagnostics
  • Manage Dashboard Ports
  • Run Multiple Sandboxes
  • Reconfigure or Recover
  • Change Inference Model or API
  • Restart the Gateway and Port Forward
  • Reset a Stored Credential
  • Rebuild a Sandbox While Preserving Workspace State
  • Add a Network Preset After Onboarding
  • Update to the Maintained Version
  • Update the NemoClaw CLI
  • Upgrade Sandboxes with Stale Agent and Runtime Versions
  • What Changes During a Rebuild
  • Uninstall
  • Related Topics
Manage Sandboxes

Manage Sandbox Lifecycle

||View as Markdown|
Previous

Switch Inference Models at Runtime

Next

Runtime Controls and Sandbox Mutability

Use this guide after you finish Quickstart with Hermes. It covers day-two sandbox operations such as listing sandboxes, checking health, managing ports, rebuilding safely, upgrading, and uninstalling.

When a workflow uses the lower-level OpenShell CLI, see CLI Selection Guide for the boundary between nemohermes, nemoclaw, and openshell.

List Sandboxes

List every sandbox registered on this host:

$nemohermes list

The list shows each sandbox’s model, provider, policy presets, active SSH session indicator, and dashboard URL when NemoClaw records a dashboard port. Use JSON output for scripts:

$nemohermes list --json

Check Sandbox Health

Check a specific sandbox’s health, inference route, active connections, live policy, update status, and messaging-channel overlap warnings:

$nemohermes my-assistant status

Use the host-level status command when you want the sandbox inventory plus host auxiliary service state, such as cloudflared:

$nemohermes status

Inspect Logs

View recent sandbox logs:

$nemohermes my-assistant logs

Stream logs while you reproduce a problem:

$nemohermes my-assistant logs --follow

The log command reads both Hermes gateway output and OpenShell audit events, so policy denials appear beside gateway logs.

Collect Diagnostics

Collect diagnostics for bug reports or support handoff:

$nemohermes debug --sandbox my-assistant --output nemoclaw-debug.tar.gz

Use --quick for a smaller local summary:

$nemohermes debug --quick --sandbox my-assistant

The debug command gathers system information, Docker state, gateway logs, and sandbox status.

Manage Dashboard Ports

If the forward stopped, or the installer reported that no active forward was found and the URL does not load, restart it manually with the port from the install summary.

$openshell forward start --background <dashboard-port> my-gpt-claw

To list active forwards across all sandboxes, run the following command.

$openshell forward list

Run Multiple Sandboxes

Each sandbox needs its own dashboard port, since openshell forward refuses to bind a port that another sandbox is already using.

When the default API port is already held by another sandbox, nemohermes onboard scans for the next free port and records it for the sandbox. If you intentionally run separate OpenShell gateways on the same host, set a different NEMOCLAW_GATEWAY_PORT before each onboarding run. NemoClaw isolates the gateway name and local state by port so one port-specific gateway does not replace another.

$nemohermes onboard # first sandbox uses 18789
$nemohermes onboard # second sandbox uses the next free port, such as 18790

To choose a specific port, pass --control-ui-port:

$nemohermes onboard --control-ui-port 19000

You can also set CHAT_UI_URL or NEMOCLAW_DASHBOARD_PORT before onboarding:

$CHAT_UI_URL=http://127.0.0.1:19000 nemohermes onboard
$NEMOCLAW_DASHBOARD_PORT=19000 nemohermes onboard

For full details on port conflicts and overrides, refer to Port already in use.

Reconfigure or Recover

Recover from a misconfigured sandbox without re-running the full onboard wizard or destroying workspace state.

Change Inference Model or API

Change the active model or provider at runtime without rebuilding the sandbox:

$nemohermes inference set --model <model> --provider <provider>

Refer to Switch Inference Providers for provider-specific model IDs and API compatibility notes.

Restart the Gateway and Port Forward

If nemohermes <name> status reports the sandbox is alive but the Hermes gateway is not running, run the recover command instead of opening a shell.

$nemohermes <sandbox-name> recover

The command restarts the in-sandbox gateway and re-establishes the dashboard port-forward in one step. It is idempotent and safe to script. Refer to nemohermes <name> recover for details.

Reset a Stored Credential

If you entered a provider credential incorrectly during onboarding, clear the gateway-registered value and re-enter it on the next onboard run:

$nemohermes credentials list # see which providers are registered
$nemohermes credentials reset <PROVIDER> # clear a single provider, for example nvidia-prod
$nemohermes onboard # re-run to re-enter the cleared provider

The command reference documents nemohermes credentials reset <PROVIDER> in full.

Rebuild a Sandbox While Preserving Workspace State

If you changed the underlying Dockerfile, upgraded Hermes, or want to pick up a new base image without losing your sandbox’s state files, use rebuild instead of destroying and recreating:

$nemohermes <sandbox-name> rebuild

Rebuild preserves the mounted workspace and registered policies while recreating the container. If NemoClaw cannot archive any requested state path, it reports the backup failure and stops before deleting the original sandbox. Refer to nemohermes <name> rebuild for flag details.

Add a Network Preset After Onboarding

Apply an additional preset, such as Telegram or GitHub, to a running sandbox without re-onboarding:

$nemohermes <sandbox-name> policy-add

Refer to nemohermes <name> policy-add for usage details and flags.

Non-interactive re-onboards in the default suggested policy mode preserve presets added this way. To make a re-onboard authoritative, set NEMOCLAW_POLICY_MODE=custom and provide NEMOCLAW_POLICY_PRESETS with the exact list to apply; onboarding removes anything else. See NEMOCLAW_POLICY_MODE for the full table.

Update to the Maintained Version

When a maintained NemoClaw release becomes available, update the nemohermes CLI on your host and check existing sandboxes for stale agent/runtime versions.

The standard installer follows the admin-promoted lkg release tag by default, so it can trail the newest semver or latest tag while validation completes. To pin a specific release in a curl | bash install, set NEMOCLAW_INSTALL_TAG on the bash side of the pipe, or export it before the pipeline:

$curl -fsSL https://www.nvidia.com/nemoclaw.sh | NEMOCLAW_INSTALL_TAG=v0.0.56 bash
$# or
$export NEMOCLAW_INSTALL_TAG=v0.0.56
$curl -fsSL https://www.nvidia.com/nemoclaw.sh | bash

Do not place NEMOCLAW_INSTALL_TAG=... only before curl; shell assignment in that position applies to curl, not to the installer running under bash. If the requested ref cannot be fetched, the installer exits with a clear error instead of falling back to lkg.

Update the NemoClaw CLI

Re-run the installer. Before it onboards anything, the installer calls nemohermes backup-all automatically, storing a snapshot of each running sandbox in ~/.nemoclaw/rebuild-backups/ as a safety net.

If your existing gateway is from OpenShell earlier than 0.0.37, the installer prompts before it runs the new automatic gateway upgrade path.

The installer offers the automatic path only when the existing nemohermes CLI supports backup-all. Older installs must preserve sandbox state manually before retiring the gateway. For unattended installs, set NEMOCLAW_ACCEPT_EXPERIMENTAL_OPENSHELL_UPGRADE=1, or manually run nemohermes backup-all, openshell gateway remove nemoclaw || openshell gateway destroy -g nemoclaw || openshell gateway destroy (the command tries both verbs so the right one runs on either OpenShell release), and sudo pkill -f openshell-gateway if a privileged host gateway remains before rerunning the installer as curl -fsSL https://www.nvidia.com/nemoclaw.sh | NEMOCLAW_AGENT=hermes NEMOCLAW_OPENSHELL_UPGRADE_PREPARED=1 bash.

$curl -fsSL https://www.nvidia.com/nemoclaw.sh | bash

Upgrade Sandboxes with Stale Agent and Runtime Versions

The installer checks registered sandboxes after onboarding succeeds and runs nemohermes upgrade-sandboxes --auto for stale running sandboxes. Use upgrade-sandboxes directly to verify the result, rebuild when you skipped the installer or onboarding step, or handle sandboxes that were stopped or could not be version checked. The upgrade flow is non-destructive by default because NemoClaw preserves manifest-defined workspace state, but a manual snapshot before any major upgrade gives you a state restore point.

$nemohermes <sandbox-name> snapshot create --name pre-upgrade # optional, recommended
$nemohermes update --yes # updates CLI through the maintained installer flow
$nemohermes upgrade-sandboxes --check # verify or list remaining stale/unknown sandboxes
$nemohermes upgrade-sandboxes # manually rebuild remaining stale running sandboxes

nemohermes update is the CLI wrapper around the same installer path with Hermes selected. Use nemohermes update --check when you only want to inspect version state and see the maintained update command.

For scripted manual rebuilds, use nemohermes upgrade-sandboxes --auto to skip the confirmation prompt.

If the upgraded sandbox needs its workspace state reverted, restore the pre-upgrade snapshot into the running sandbox. This restores saved state directories only; it does not downgrade the sandbox image or agent/runtime:

$nemohermes <sandbox-name> snapshot restore pre-upgrade

What Changes During a Rebuild

Each rebuild destroys the existing container and creates a new one.

NemoClaw protects your data through the same backup-and-restore flow as nemohermes <name> rebuild:

  • NemoClaw preserves manifest-defined Hermes state. Before deleting the old container, NemoClaw snapshots the state directories and durable state files defined in the Hermes manifest, including SOUL.md and the SQLite database behind .hermes/state.db. Stored credentials (~/.nemoclaw/credentials.json) and registered policy presets live on the host and are re-applied to the new sandbox automatically.
  • NemoClaw does not preserve runtime changes outside the manifest-defined state directories. This includes packages installed inside the running container with apt or pip, files in non-state paths, and in-memory or process state. If you have customized the running container at runtime, capture that as Dockerfile changes for nemohermes onboard --from or a manual openshell sandbox download before the rebuild starts.

Aborts before the destroy step are non-destructive. The flow refuses to proceed past preflight if a credential is missing or past backup if it cannot copy required manifest-defined state, so a failed run leaves the original sandbox intact and ready to retry. When a backup command reports partial archive output, NemoClaw keeps the usable entries and reports only the manifest-defined paths that could not be archived.

See Backup and Restore for the full list of state-preservation guarantees, snapshot retention, and instructions for manual backups when the auto-flow is not enough.

If the rebuild aborts with Missing credential: <KEY>

The rebuild preflight reads the provider credential recorded by your last nemohermes onboard session. If you have switched providers since onboarding, for example from a remote API to a local Ollama setup, the preflight can still reference the old key and fail before any destroy step runs.

To recover, re-run nemohermes onboard and select your current provider. This refreshes the session metadata. Your existing container keeps serving traffic until the new image is ready.

Uninstall

To remove NemoClaw and all resources created during setup, run the CLI’s built-in uninstall command:

$nemohermes uninstall
FlagEffect
--yesSkip the confirmation prompt.
--keep-openshellLeave OpenShell binaries installed.
--delete-modelsAlso remove NemoClaw-pulled Ollama models.

The uninstall command preserves ~/.nemoclaw/rebuild-backups/ (host-side snapshots that snapshot and backup-all commands write), ~/.nemoclaw/backups/ (workspace backups that scripts/backup-workspace.sh writes), and ~/.nemoclaw/sandboxes.json (the sandbox registry) by default. Uninstall removes every other entry under ~/.nemoclaw/. Interactive runs prompt before they remove the preserved entries; the default answer keeps them. For non-interactive runs (--yes, NEMOCLAW_NON_INTERACTIVE=1, or a non-TTY shell), set NEMOCLAW_UNINSTALL_DESTROY_USER_DATA=1 to acknowledge data loss and remove the preserved entries as well. See the Commands reference for the full preservation contract.

The CLI uninstall command runs the version-pinned uninstall.sh that shipped with your installed CLI, so it does not fetch anything over the network at uninstall time.

If the CLI is missing or broken, fall back to the hosted script:

$curl -fsSL https://raw.githubusercontent.com/NVIDIA/NemoClaw/refs/heads/main/uninstall.sh | bash

The same --yes, --keep-openshell, and --delete-models flags listed above also apply to the hosted script. Pass them after bash -s --.

$curl -fsSL https://raw.githubusercontent.com/NVIDIA/NemoClaw/refs/heads/main/uninstall.sh | bash -s -- --yes --delete-models

For a full comparison of the two forms, including what they fetch, what they trust, and when to prefer each, refer to nemohermes uninstall vs. the hosted uninstall.sh.

Related Topics

  • Set Up Messaging Channels to connect Telegram, Discord, or Slack.
  • Workspace Files for persistent OpenClaw files inside the sandbox.
  • Backup and Restore for snapshot and restore workflows.
  • Monitor Sandbox Activity for observability tools.