Skip to content

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

@zNeill

Description

@zNeill

Description

[Description]

The CLI reference in docs/reference/commands.md is maintained as the canonical documentation for nemoclaw subcommands (via ### nemoclaw … headings). The repository includes a parity check (test/e2e/e2e-cloud-experimental/check-docs.sh) that compares:

  1. Normalized usage lines extracted from NO_COLOR=1 node bin/nemoclaw.js --help
  2. The set of ### `nemoclaw …` headings in docs/reference/commands.md

That check fails because nemoclaw debug and nemoclaw uninstall appear in --help but do not have corresponding top-level ### sections in commands.md. Contributors running the doc check see a mismatch and CI (or local preflight) can fail.
[Environment]

  • Device: Ubuntu 22.04
  • Node.js: v20.20.1
  • npm: 10.8.2
  • Docker: Docker Engine 29.3.0
  • OpenShell CLI: 0.0.15
  • NemoClaw: v0.1.0 (cec1e4)
  • OpenClaw: 2026.3.11 (29dc654)

Note: it can be reproducible with other environment intermittently

[Steps to Reproduce]

  1. Clone NemoClaw and install deps if needed (npm install).
  2. Run: bash test/e2e/e2e-cloud-experimental/check-docs.sh (or --only-cli if supported by the script).
  3. Observe CLI parity failure listing nemoclaw debug and nemoclaw uninstall as only in --help.
  4. Optionally run NO_COLOR=1 node bin/nemoclaw.js --help and confirm Troubleshooting / Cleanup sections mention debug and uninstall.
  5. Open docs/reference/commands.md and confirm there are no ### `nemoclaw debug` or ### `nemoclaw uninstall` sections (only other subcommands through setup-spark, etc.).

<span style= font-size:11pt; font-variant:normal; white-space:pre-wrap >
[Expected Behavior]

  • docs/reference/commands.md includes every subcommand that nemoclaw --help lists (after the script’s normalization), or --help is trimmed to match an intentionally scoped reference doc (with docs explaining the omission).

Steps to reproduce

No steps provided.


[NVB# 6018345]

Metadata

Metadata

Assignees

No one assigned

    Labels

    NV QABugs found by the NVIDIA QA Team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions