Skip to content

docs: sync oclif UX command reference - #2915

Merged
cv merged 26 commits into
mainfrom
docs/oclif-ux-command-reference-sync
May 5, 2026
Merged

docs: sync oclif UX command reference#2915
cv merged 26 commits into
mainfrom
docs/oclif-ux-command-reference-sync

Conversation

@cv

@cv cv commented May 3, 2026

Copy link
Copy Markdown
Collaborator

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

  • Documented --resume | --fresh in onboard usage.
  • Added logs --tail/-n and --since usage.
  • Updated lifecycle confirmation aliases and debug short flags.
  • Updated gc and upgrade-sandboxes confirmation alias references.

Type of Change

  • 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

  • npx prek run --all-files passes
  • npm test passes
  • Tests added or updated for new or changed behavior
  • 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 (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Signed-off-by: Carlos Villela cvillela@nvidia.com

Summary by CodeRabbit

  • Documentation
    • Updated CLI command references for nemoclaw with new flag aliases
    • Added --fresh option for nemoclaw onboard command
    • Added -y and -v short flags for nemoclaw rebuild command
    • Added -q and -o short flags for nemoclaw debug command
    • Documented flag shortcuts for nemoclaw destroy command

@cv cv self-assigned this May 3, 2026
@copy-pr-bot

copy-pr-bot Bot commented May 3, 2026

Copy link
Copy Markdown

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.

@coderabbitai

coderabbitai Bot commented May 3, 2026

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: c2ac4f9b-fc73-497d-b53e-258e0190c7c8

📥 Commits

Reviewing files that changed from the base of the PR and between 702afb1 and 0df2084.

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

📝 Walkthrough

Walkthrough

Updated documentation for nemoclaw CLI commands to include additional flag aliases (-y, -v, -q, -o) and document --fresh as an alternative to --resume in the onboard command.

Changes

CLI Command Reference Updates

Layer / File(s) Summary
Documentation
docs/reference/commands.md
Four command sections updated: nemoclaw onboard adds --fresh; nemoclaw destroy documents -y alias for --yes; nemoclaw rebuild adds -y and -v aliases with updated synopsis and flag tables; nemoclaw debug adds -q and -o aliases with updated synopsis and flag table.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Hop, skip, and flags galore!
Short names make CLI less of a chore,
-y, -v, -q, -o shine bright,
The docs now reflect what works just right! 🎉

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/oclif-ux-command-reference-sync

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

@cv cv added the v0.0.34 label May 4, 2026

@cjagwani cjagwani left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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.

@cv cv added v0.0.35 refactor PR restructures code without intended behavior change and removed v0.0.34 labels May 5, 2026
cv added a commit that referenced this pull request May 5, 2026
## 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>
@cv
cv changed the base branch from refactor/oclif-ux-onboard-flags to main May 5, 2026 16:57
@cv
cv marked this pull request as ready for review May 5, 2026 17:01
@cv
cv enabled auto-merge (squash) May 5, 2026 17:01
cv added 2 commits May 5, 2026 10:01
Signed-off-by: Carlos Villela <cvillela@nvidia.com>
Signed-off-by: Carlos Villela <cvillela@nvidia.com>
@cv
cv merged commit 4b22e3f into main May 5, 2026
15 checks passed
cv added a commit that referenced this pull request May 5, 2026
## 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>
@cv
cv deleted the docs/oclif-ux-command-reference-sync branch May 27, 2026 21:16
@wscurran wscurran added area: cli Command line interface, flags, terminal UX, or output area: docs Documentation, examples, guides, or docs build and removed NemoClaw CLI labels Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: cli Command line interface, flags, terminal UX, or output area: docs Documentation, examples, guides, or docs build refactor PR restructures code without intended behavior change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants