Skip to content

chore(docs): add debug and uninstall to commands reference #1082

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericksoa merged 2 commits into from
Mar 30, 2026
Merged

chore(docs): add debug and uninstall to commands reference #1082

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7cdcc03
chore(docs): add debug and uninstall to commands reference
ericksoa Mar 30, 2026
fee0dfc
chore(docs): add missing --sandbox flag to debug entry
ericksoa Mar 30, 2026
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
30 changes: 30 additions & 0 deletions docs/reference/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,3 +180,33 @@ After the fixes complete, the script prompts you to run `nemoclaw onboard` to co
```console
$ sudo nemoclaw setup-spark
```

### `nemoclaw debug`

Collect diagnostics for bug reports.
Gathers system info, Docker state, gateway logs, and sandbox status into a summary or tarball.

```console
$ nemoclaw debug [--quick] [--sandbox NAME] [--output PATH]
```

| Flag | Description |
|------|-------------|
| `--quick` | Collect minimal diagnostics only |
| `--sandbox NAME` | Target a specific sandbox (default: auto-detect) |
| `--output PATH` | Write diagnostics tarball to the given path |

### `nemoclaw uninstall`

Remove NemoClaw, destroying all sandboxes and the gateway.
Runs the bundled `uninstall.sh` if available, otherwise downloads it from GitHub.

```console
$ nemoclaw uninstall [--yes] [--keep-openshell] [--delete-models]
```

| Flag | Description |
|------|-------------|
| `--yes` | Skip the confirmation prompt |
| `--keep-openshell` | Leave the openshell binary installed |
| `--delete-models` | Remove NemoClaw-pulled Ollama models |
Loading