docs(cli): sync command reference with implemented CLI surface by WuKongAI-CMU · Pull Request #901 · NVIDIA/NemoClaw

WuKongAI-CMU · 2026-03-25T18:32:44Z

Summary

document the current /nemoclaw slash-command surface, including onboard and eject
add the missing host CLI entries for help, version, deprecated setup, debug, and uninstall
keep the reference aligned with the commands exposed by the current CLI

Testing

not run (docs-only change)

Fixes #758

Summary by CodeRabbit

Documentation
- Expanded slash-command docs: added a top-level help entry plus onboarding and rollback (eject) options.
- Added standalone CLI reference: top-level help/version, enhanced debug guidance (sandbox targeting, quick diagnostics, output capture).
- Expanded uninstall guidance: clearer removal scope (sandboxes, gateway resources, images/containers, local state) and clarified options.
- Marked setup as deprecated and documented legacy workflow with deprecation guidance.

coderabbitai · 2026-03-25T18:32:59Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b96d1218-64e0-4c71-840e-72401b1e7811

📥 Commits

Reviewing files that changed from the base of the PR and between f2f26a2 and 6950fd4.

📒 Files selected for processing (1)

docs/reference/commands.md

🚧 Files skipped from review as they are similar to previous changes (1)

docs/reference/commands.md

📝 Walkthrough

Walkthrough

Updated docs/reference/commands.md to match the implemented CLI surface: added a top-level /nemoclaw help entry, documented slash subcommands /nemoclaw onboard and /nemoclaw eject, added host CLI entries (help, --version, debug, uninstall) and marked nemoclaw setup as deprecated.

Changes

Cohort / File(s)	Summary
Documentation Updates `docs/reference/commands.md`	Rewrote front-matter description to cover both OpenClaw slash commands and standalone NemoClaw host CLI. Added top-level `/nemoclaw` help/pointers row; documented `/nemoclaw onboard` and `/nemoclaw eject`. Added host CLI docs for `nemoclaw help`/`-h`/`--help`, `nemoclaw --version`/`-v`. Expanded `nemoclaw debug` docs with `--sandbox`, `--quick`, `--output` flags. Reworked `nemoclaw uninstall` scope, clarified local `uninstall.sh` precedence and fallback, and reformatted flags. Marked `nemoclaw setup`/`setup.sh` as deprecated and recommended `nemoclaw onboard`.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I nibble docs with careful cheer,

Slash and host commands now appear.
Old setup fades, new paths I tread,
Help and debug hop straight ahead.
A tiny rabbit, lines well-read.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: syncing the command reference documentation with the implemented CLI surface.
Linked Issues check	✅ Passed	The PR addresses all acceptance criteria from issue `#758`: documents slash commands (status, onboard, eject), host commands (debug, uninstall, help, --version), marks setup as deprecated, and ensures parity between docs and implementation.
Out of Scope Changes check	✅ Passed	All changes are within scope; only docs/reference/commands.md is modified to align documentation with the implemented CLI surface as required by issue `#758`.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

prekshivyas

Nice work — this covers the gaps in the command reference well. All commands and flags verified against the codebase.

Two minor suggestions:

debug --sandbox NAME: debug.sh also accepts --sandbox NAME to target a specific sandbox (line 45-47 in scripts/debug.sh). It's not shown in the main nemoclaw help output, but since this is the full CLI reference, it might be worth documenting here too.
Ordering: The deprecated setup section sits between onboard and list. Consider moving it toward the end (before or after uninstall) so users see current commands first.

Neither is a blocker — the PR is solid as-is.

WuKongAI-CMU · 2026-03-26T04:37:18Z

Addressing the two reviewer suggestions in c695fdc:

document nemoclaw debug --sandbox <name> in the host CLI reference
move the deprecated setup section after the current host commands so the active surface stays grouped first

@coderabbitai review

coderabbitai · 2026-03-26T04:37:31Z

@WuKongAI-CMU Sure! I'll kick off a fresh review of the PR with those two updates in mind — documenting nemoclaw debug --sandbox <name> and repositioning the deprecated setup section.

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

WuKongAI-CMU · 2026-03-27T02:17:30Z

Docs sync is up to date on this branch and the follow-up reviewer suggestions are already addressed in c695fdc. This one should be ready for maintainer merge when convenient.

WuKongAI-CMU · 2026-03-27T02:17:47Z

Docs sync is up to date on this branch and the follow-up reviewer suggestions are already addressed in c695fdc. This one should be ready for maintainer merge when convenient.

WuKongAI-CMU · 2026-03-27T02:17:56Z

Docs sync is up to date on this branch and the follow-up reviewer suggestions are already addressed in c695fdc. This one should be ready for maintainer merge when convenient.

prekshivyas · 2026-03-30T15:51:13Z

@WuKongAI-CMU pls resolve merge conflicts

WuKongAI-CMU · 2026-03-30T18:03:08Z

Rebased onto latest main and resolved conflicts in docs/reference/commands.md. Merged the upstream debug and uninstall documentation additions with our command reference updates. Ready for re-review.

Signed-off-by: peteryuqin <peter.yuqin@gmail.com>

* docs(cli): sync command reference with implemented CLI surface Signed-off-by: peteryuqin <peter.yuqin@gmail.com> * docs(cli): document debug sandbox flag --------- Signed-off-by: peteryuqin <peter.yuqin@gmail.com>

…A#901) * docs(cli): sync command reference with implemented CLI surface Signed-off-by: peteryuqin <peter.yuqin@gmail.com> * docs(cli): document debug sandbox flag --------- Signed-off-by: peteryuqin <peter.yuqin@gmail.com>

WuKongAI-CMU mentioned this pull request Mar 25, 2026

docs(cli): update command reference to match implemented slash commands and host commands #758

Closed

prekshivyas mentioned this pull request Mar 25, 2026

refactor(cli): migrate to oclif + TypeScript #909

Closed

8 tasks

prekshivyas reviewed Mar 25, 2026

View reviewed changes

cv mentioned this pull request Mar 25, 2026

refactor(cli): shell consolidation, TypeScript migration & oclif #924

Open

prekshivyas self-requested a review March 25, 2026 22:36

prekshivyas approved these changes Mar 25, 2026

View reviewed changes

WuKongAI-CMU force-pushed the docs/758-command-reference branch from c695fdc to f2f26a2 Compare March 30, 2026 18:03

WuKongAI-CMU added 2 commits March 30, 2026 14:12

docs(cli): sync command reference with implemented CLI surface

a5f6f63

Signed-off-by: peteryuqin <peter.yuqin@gmail.com>

docs(cli): document debug sandbox flag

6950fd4

WuKongAI-CMU force-pushed the docs/758-command-reference branch from f2f26a2 to 6950fd4 Compare March 30, 2026 18:12

cv approved these changes Mar 30, 2026

View reviewed changes

cv merged commit 50d9810 into NVIDIA:main Mar 30, 2026
1 check passed

wscurran added the chore Build, CI, dependency, or tooling maintenance label Jun 8, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(cli): sync command reference with implemented CLI surface#901

docs(cli): sync command reference with implemented CLI surface#901
cv merged 2 commits into
NVIDIA:mainfrom
WuKongAI-CMU:docs/758-command-reference

WuKongAI-CMU commented Mar 25, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Mar 25, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

prekshivyas left a comment

Uh oh!

WuKongAI-CMU commented Mar 26, 2026

Uh oh!

coderabbitai Bot commented Mar 26, 2026

Uh oh!

WuKongAI-CMU commented Mar 27, 2026

Uh oh!

WuKongAI-CMU commented Mar 27, 2026

Uh oh!

WuKongAI-CMU commented Mar 27, 2026

Uh oh!

prekshivyas commented Mar 30, 2026

Uh oh!

WuKongAI-CMU commented Mar 30, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

WuKongAI-CMU commented Mar 25, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Testing

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

prekshivyas left a comment

Choose a reason for hiding this comment

Uh oh!

WuKongAI-CMU commented Mar 26, 2026

Uh oh!

coderabbitai Bot commented Mar 26, 2026

Uh oh!

WuKongAI-CMU commented Mar 27, 2026

Uh oh!

WuKongAI-CMU commented Mar 27, 2026

Uh oh!

WuKongAI-CMU commented Mar 27, 2026

Uh oh!

prekshivyas commented Mar 30, 2026

Uh oh!

WuKongAI-CMU commented Mar 30, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

WuKongAI-CMU commented Mar 25, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Mar 25, 2026 •

edited

Loading