Skip to content

[Linux][Docs] commands.md and install.sh --help not updated after oclif migration and new provider additions #3224

@zNeill

Description

@zNeill

Description

Description

Two documentation gaps found by automated vitest verification across v0.0.34–v0.0.36:

1. docs/reference/commands.md does not reflect the oclif CLI migration (PR #3106):
   83/85 vitest assertions pass, 2 fail because new oclif command signatures
   and flags are present in --help output but missing from commands.md.

2. install.sh --help does not list all valid NEMOCLAW_PROVIDER values (PR #3151):
   16/18 vitest assertions pass, 2 fail because recently added provider
   identifiers are accepted by the installer but not documented in the
   --help output.

Both are recurring issues — commands.md has had docs-lag findings in v0.0.31,
v0.0.34, v0.0.35, and v0.0.36 (TC5882289 flagged in every version).
Environment
Device:        testnemoclaw (x86_64 CPU server)
OS:            Ubuntu 24.04
Architecture:  x86_64
Node.js:       v22.22.2
NemoClaw:      v0.0.36
Steps to Reproduce
Issue 1 — commands.md:
1. Install NemoClaw v0.0.36
2. For each command in docs/reference/commands.md, run the command with --help
3. Compare documented flags/arguments with actual --help output
4. Observe 2 mismatches where --help shows flags not in commands.md

Issue 2 — install.sh --help:
1. Run: curl -fsSL https://www.nvidia.com/nemoclaw.sh | bash -- --help
2. Check the listed NEMOCLAW_PROVIDER values
3. Compare with actually supported providers in the codebase
4. Observe 2 missing provider values
Expected Result
1. Every flag shown by --help is documented in commands.md
2. Every valid NEMOCLAW_PROVIDER value is listed in install.sh --help
Actual Result
1. commands.md: 2 flags/commands from oclif migration not documented
2. install.sh --help: 2 provider values accepted but not listed

TC5882289: 83/85 pass (PR #3106)
TC5956310: 16/18 pass (PR #3151)
Logs
Discovered by Agentic QA Pipeline automated vitest execution.
This is a recurring pattern — TC5882289 (commands reference) has flagged
docs-lag in every version from v0.0.31 to v0.0.36.

Suggest adding a CI check that diffs --help output against commands.md
on every PR that touches CLI code.

Bug Details

Field Value
Priority Unprioritized
Action Dev - Open - To fix
Disposition Open issue
Module Machine Learning - NemoClaw
Keyword NemoClaw, NemoClaw_CLI&UX, NemoClaw_Docs, NEMOCLAW_GH_SYNC_APPROVAL

[NVB#6156934]

Metadata

Metadata

Assignees

Labels

NV QABugs found by the NVIDIA QA Teamarea: docsDocumentation, examples, guides, or docs build

Type

No fields configured for Bug.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions