Skip to content

docs: add missing debug and uninstall sections to commands.md#1074

Open
latenighthackathon wants to merge 9 commits intoNVIDIA:mainfrom
latenighthackathon:docs/add-debug-uninstall-commands
Open

docs: add missing debug and uninstall sections to commands.md#1074
latenighthackathon wants to merge 9 commits intoNVIDIA:mainfrom
latenighthackathon:docs/add-debug-uninstall-commands

Conversation

@latenighthackathon
Copy link
Copy Markdown
Contributor

@latenighthackathon latenighthackathon commented Mar 29, 2026

Summary

commands.md was missing documentation for nemoclaw debug and nemoclaw uninstall, which caused the doc-parity CI check to fail. Added both sections with usage examples and flag tables.

Related Issue

Closes #984

Changes

  • Added ### nemoclaw debug section with --quick, --sandbox, --output/-o flags
  • Added ### nemoclaw uninstall section with --yes, --keep-openshell, --delete-models flags
  • Flag tables match actual --help output and scripts/debug.sh parser

Type of Change

  • Code change for a new feature, bug fix, or refactor.
  • Code change with doc updates.
  • Doc only. Prose changes without code sample modifications.
  • Doc only. Includes code sample changes.

Testing

  • npx prek run --all-files passes (or equivalently make check).
  • npm test passes.
  • make docs builds without warnings. (for doc-only changes)

Checklist

General

Doc Changes

  • Follows the style guide.
  • Cross-references and links verified.

Summary by CodeRabbit

  • Documentation
    • Added docs for two new CLI subcommands: nemoclaw debug — collects system info, container state, sandbox logs and gateway health; supports --output/-o FILE, --quick, and --sandbox NAME to control output and scope and to save a compressed archive.
    • nemoclaw uninstall — documents removal workflow and flags --yes, --keep-openshell, and --delete-models for optional confirmation skipping, OpenShell retention, and model removal.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 29, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Added two top-level CLI reference entries to docs/reference/commands.md for nemoclaw debug and nemoclaw uninstall, documenting their flags, options, and described behaviors to match the CLI help output.

Changes

Cohort / File(s) Summary
Command Reference Documentation
docs/reference/commands.md
Added ### \nemoclaw debug`documenting diagnostics collection (system info, Docker state, sandbox logs, gateway health) with--quick, --sandbox NAME, and --output

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • cv

Poem

🐰 I hopped through docs at break of day,

Collected flags and wrote the play.
Debug and uninstall now in line,
Headings fixed — the docs feel fine.
A tiny rabbit hops, "Ship and shine!"

🚥 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 and concisely describes the primary change: adding missing documentation sections for two nemoclaw subcommands to commands.md.
Linked Issues check ✅ Passed The PR fully addresses issue #984 by adding the missing nemoclaw debug and uninstall sections with documented flags, achieving doc-parity with --help output.
Out of Scope Changes check ✅ Passed All changes are documentation additions directly related to the issue objective; no out-of-scope modifications to code or unrelated documentation files.
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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/reference/commands.md`:
- Around line 180-188: Update the docs for the `nemoclaw debug` command to
include the short `-o` alias for output: add `-o` to the usage line (`$ nemoclaw
debug [--quick] [--sandbox NAME] [--output FILE]`) and include `-o` in the flag
table entry for `--output FILE` so it reads something like `--output FILE | -o`
to match the CLI implementation (see `scripts/debug.sh`) and ensure docs and
parser behavior are in parity.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6de02baf-62ec-4cd9-b658-c6dbbf2d4351

📥 Commits

Reviewing files that changed from the base of the PR and between eb4ba8c and ad719cd.

📒 Files selected for processing (1)
  • docs/reference/commands.md

commands.md was missing documentation for nemoclaw debug and
nemoclaw uninstall, which caused the doc-parity CI check to fail.

Add both sections with usage examples, flag tables, and descriptions
matching the actual --help output and script behavior.

Closes NVIDIA#984
CodeRabbit correctly noted that scripts/debug.sh accepts -o as a
short alias for --output. Update the usage line and flag table to
document this.
@latenighthackathon latenighthackathon force-pushed the docs/add-debug-uninstall-commands branch from 965da48 to 40273f3 Compare March 29, 2026 22:12
@wscurran wscurran added the documentation Improvements or additions to documentation label Mar 30, 2026
@wscurran
Copy link
Copy Markdown
Contributor

✨ Thanks for submitting this PR with a detailed summary, it addresses a documentation gap and proposes an addition to improve the documentation of NemoClaw, which could enhance the user experience.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[NemoClaw][Ubuntu 22.04][doc] add commands.md sections for debug and uninstall to match nemoclaw --help

3 participants