docs: sync oclif UX command reference - #2915
Conversation
This reverts commit 4ebeae4.
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdated documentation for nemoclaw CLI commands to include additional flag aliases ( ChangesCLI Command Reference Updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
cjagwani
left a comment
There was a problem hiding this comment.
Approved as part of the oclif refactor stack — initial smoke flag was a CANCELLED commit-lint that's since been superseded by SUCCESS. CI green.
## Summary Model the onboard/setup/setup-spark flag surface in oclif while preserving the existing onboarding action validation for Dockerfile paths, agents, sessions, and third-party notice semantics. This lets oclif own unknown flags and missing flag values before the onboarding action runs. ## Stack Navigation - Position: 21 of 60 - Previous PR: [#2912 — refactor(cli): model debug flags with oclif](#2912) - Next PR: [#2915 — docs: sync oclif UX command reference](#2915) ## Changes - Added oclif flags for onboard, setup, and setup-spark options. - Added onboard examples for common interactive, resume, fresh, custom Dockerfile, and non-interactive invocations. - Reconstructed legacy argv for the existing onboarding action so domain validation stays centralized. - Kept deprecated setup/setup-spark help paths routed through the existing deprecation messaging. - Updated CLI expectations for parser-owned unknown flag errors. ## Type of Change - [x] Code change (feature, bug fix, or refactor) - [ ] Code change with doc updates - [ ] Doc only (prose changes, no code sample modifications) - [ ] Doc only (includes code sample changes) ## Verification - [x] `npx prek run --all-files` passes - [x] `npm test` passes - [x] Tests added or updated for new or changed behavior - [x] No secrets, API keys, or credentials committed - [ ] Docs updated for user-facing behavior changes - [ ] `make docs` builds without warnings (doc changes only) - [ ] Doc pages follow the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md) (doc changes only) - [ ] New doc pages include SPDX header and frontmatter (new pages only) --- Signed-off-by: Carlos Villela <cvillela@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Refactor** * CLI commands now use stricter flag parsing and convert parsed flags into the legacy argument format, improving validation and behavior for onboarding and setup flows. * **Documentation** * Improved usage text, examples, and more predictable handling of help requests for onboard and setup commands. * **Tests** * CLI tests updated for stricter parsing, standardized parser exit codes, and updated error output expectations for invalid flags. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Carlos Villela <cvillela@nvidia.com>
Signed-off-by: Carlos Villela <cvillela@nvidia.com>
Signed-off-by: Carlos Villela <cvillela@nvidia.com>
## Summary Start the post-UX architecture cleanup by extracting public argv normalization out of `src/nemoclaw.ts`. The top-level entrypoint still owns registry recovery and user-facing routing errors, but command classification now lives in a focused helper with unit coverage. ## Stack Navigation - Position: 23 of 60 - Previous PR: [#2915 — docs: sync oclif UX command reference](#2915) - Next PR: [#2917 — refactor(cli): rename oclif dispatch module](#2917) ## Changes - Added `src/lib/cli-argv-normalizer.ts` for root/global/sandbox argv normalization and typo suggestions. - Replaced duplicated command-shape parsing in `src/nemoclaw.ts` with the normalizer. - Added unit coverage for root help, global commands, explicit sandbox actions, implicit connect, and suggestions. ## Type of Change - [x] Code change (feature, bug fix, or refactor) - [ ] Code change with doc updates - [ ] Doc only (prose changes, no code sample modifications) - [ ] Doc only (includes code sample changes) ## Verification - [x] `npx prek run --all-files` passes - [x] `npm test` passes - [x] Tests added or updated for new or changed behavior - [x] No secrets, API keys, or credentials committed - [ ] Docs updated for user-facing behavior changes - [ ] `make docs` builds without warnings (doc changes only) - [ ] Doc pages follow the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md) (doc changes only) - [ ] New doc pages include SPDX header and frontmatter (new pages only) --- Signed-off-by: Carlos Villela <cvillela@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit # Release Notes * **New Features** * Added `sandbox doctor` diagnostic command for comprehensive sandbox health checks. * Enhanced `sandbox logs` with `--tail`, `--since`, and `--follow` options for flexible log streaming. * Added `--probe-only` option to sandbox connection for testing without full connection. * **Documentation** * Updated CLI commands reference with new flag options and short aliases (`-y`, `-q`, `-o`, `-v`). * Added CLI usage examples across multiple commands for improved discoverability. * **Bug Fixes** * Made channel argument required for `channels` subcommands to prevent invalid invocations. * Improved validation for policy and channel mutations with clearer error messages. * **Refactoring** * Restructured internal CLI dispatching and removed legacy dispatch path. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Carlos Villela <cvillela@nvidia.com>
Summary
Sync the CLI command reference with the oclif UX changes in the stacked parser/help PRs. This updates documented usage for new aliases, parser-owned flags, and recent command examples.
Stack Navigation
Changes
--resume | --freshin onboard usage.--tail/-nand--sinceusage.gcandupgrade-sandboxesconfirmation alias references.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesmake docsbuilds without warnings (doc changes only)Signed-off-by: Carlos Villela cvillela@nvidia.com
Summary by CodeRabbit
nemoclawwith new flag aliases--freshoption fornemoclaw onboardcommand-yand-vshort flags fornemoclaw rebuildcommand-qand-oshort flags fornemoclaw debugcommandnemoclaw destroycommand