Skip to content

docs(commands): align onboard usage synopsis with CLI output - #1783

Merged
cv merged 2 commits into
NVIDIA:mainfrom
nihalmaddala:fix/docs-onboard-flags-1730
Apr 14, 2026
Merged

docs(commands): align onboard usage synopsis with CLI output#1783
cv merged 2 commits into
NVIDIA:mainfrom
nihalmaddala:fix/docs-onboard-flags-1730

Conversation

@nihalmaddala

@nihalmaddala nihalmaddala commented Apr 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Updates the nemoclaw onboard usage synopsis in the command reference so it matches the live CLI usage output.
Includes the generated skill reference update produced by the docs-to-skills pipeline.

Related Issue

Fixes #1730

Changes

  • Updates docs/reference/commands.md onboarding usage synopsis to include --dangerously-skip-permissions in addition to the already-added non-experimental flags.
  • Updates generated skill mirror: .agents/skills/nemoclaw-user-reference/references/commands.md.

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

Code Changes

  • Formatters applied — npx prek run --all-files auto-fixes formatting (or make format for targeted runs).
  • Tests added or updated for new or changed behavior.
  • No secrets, API keys, or credentials committed.
  • Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs).

Doc Changes

  • Follows the style guide. Try running the nemoclaw-contributor-update-docs agent skill to draft changes while complying with the style guide. For example, prompt your agent with "/nemoclaw-contributor-update-docs catch up the docs for the new changes I made in this PR."
  • New pages include SPDX license header and frontmatter, if creating a new page.
  • Cross-references and links verified.

Signed-off-by: nihalmaddala nihalmaddala@gmail.com

Summary by CodeRabbit

  • Documentation
    • Updated the nemoclaw onboard command reference across documentation to list additional CLI flags: --recreate-sandbox, --agent , --dangerously-skip-permissions, and --yes-i-accept-third-party-software.
    • Clarified the documented command usage so users can see the expanded set of available flags in user-facing references.

Signed-off-by: nihalmaddala <nihalmaddala@gmail.com>
@coderabbitai

coderabbitai Bot commented Apr 11, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: e0bdcc98-b9b8-4825-9251-24b40210caef

📥 Commits

Reviewing files that changed from the base of the PR and between 1a0349e and 8cfd453.

📒 Files selected for processing (2)
  • .agents/skills/nemoclaw-user-reference/references/commands.md
  • docs/reference/commands.md
✅ Files skipped from review due to trivial changes (1)
  • docs/reference/commands.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • .agents/skills/nemoclaw-user-reference/references/commands.md

📝 Walkthrough

Walkthrough

Documentation updates synchronize two CLI reference files so the nemoclaw onboard usage line includes --recreate-sandbox, --agent <name>, --dangerously-skip-permissions, and --yes-i-accept-third-party-software.

Changes

Cohort / File(s) Summary
CLI Command Documentation
/.agents/skills/nemoclaw-user-reference/references/commands.md, docs/reference/commands.md
Expanded the nemoclaw onboard usage synopsis to add flags: --recreate-sandbox, --agent <name>, --dangerously-skip-permissions, and --yes-i-accept-third-party-software.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Nose a-tingle, ears upright,
Flags aligned and docs just right.
No more missing bits in sight,
Onboard marches clear and bright.

🚥 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 clearly and concisely describes the main change: aligning the onboard command documentation with actual CLI output.
Linked Issues check ✅ Passed The PR successfully addresses all requirements from issue #1730: it updates the nemoclaw onboard usage to include --recreate-sandbox, --agent, --dangerously-skip-permissions, and --yes-i-accept-third-party-software flags.
Out of Scope Changes check ✅ Passed All changes are directly related to aligning the onboard command documentation with CLI output, with no unrelated modifications present.
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.

@wscurran

Copy link
Copy Markdown
Contributor

✨ Thanks for submitting this PR, which proposes a way to improve the accuracy of the onboard usage synopsis in the command reference.


Possibly related open issues:

@prekshivyas
prekshivyas requested a review from miyoungc April 14, 2026 15:39
@prekshivyas

Copy link
Copy Markdown
Collaborator

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Apr 14, 2026

Copy link
Copy Markdown
Contributor
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@cv
cv merged commit 922d65f into NVIDIA:main Apr 14, 2026
12 checks passed
@nihalmaddala
nihalmaddala deleted the fix/docs-onboard-flags-1730 branch April 14, 2026 22:16
ColinM-sys pushed a commit to ColinM-sys/NemoClaw that referenced this pull request Apr 14, 2026
…1783)

## Summary
Updates the `nemoclaw onboard` usage synopsis in the command reference
so it matches the live CLI usage output.
Includes the generated skill reference update produced by the
docs-to-skills pipeline.

## Related Issue
Fixes NVIDIA#1730

## Changes
- Updates `docs/reference/commands.md` onboarding usage synopsis to
include `--dangerously-skip-permissions` in addition to the
already-added non-experimental flags.
- Updates generated skill mirror:
`.agents/skills/nemoclaw-user-reference/references/commands.md`.

## Type of Change
- [ ] Code change for a new feature, bug fix, or refactor.
- [ ] Code change with doc updates.
- [x] 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.
- [x] `make docs` builds without warnings. (for doc-only changes)

## Checklist

### General

- [x] I have read and followed the [contributing
guide](https://github.com/NVIDIA/NemoClaw/blob/main/CONTRIBUTING.md).
- [x] I have read and followed the [style
guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md).
(for doc-only changes)

### Code Changes
- [ ] Formatters applied — `npx prek run --all-files` auto-fixes
formatting (or `make format` for targeted runs).
- [ ] Tests added or updated for new or changed behavior.
- [x] No secrets, API keys, or credentials committed.
- [ ] Doc pages updated for any user-facing behavior changes (new
commands, changed defaults, new features, bug fixes that contradict
existing docs).

### Doc Changes
- [x] Follows the [style
guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md).
Try running the `nemoclaw-contributor-update-docs` agent skill to draft
changes while complying with the style guide. For example, prompt your
agent with "`/nemoclaw-contributor-update-docs` catch up the docs for
the new changes I made in this PR."
- [x] New pages include SPDX license header and frontmatter, if creating
a new page.
- [x] Cross-references and links verified.

---
Signed-off-by: nihalmaddala <nihalmaddala@gmail.com>

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Updated the nemoclaw onboard command reference across documentation to
list additional CLI flags: --recreate-sandbox, --agent <name>,
--dangerously-skip-permissions, and --yes-i-accept-third-party-software.
* Clarified the documented command usage so users can see the expanded
set of available flags in user-facing references.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: nihalmaddala <nihalmaddala@gmail.com>
Co-authored-by: Prekshi Vyas <34834085+prekshivyas@users.noreply.github.com>
Signed-off-by: ColinM-sys <cmcdonough@50words.com>
@wscurran wscurran added area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance and removed documentation labels Jun 3, 2026
@wscurran wscurran added the NV QA Bugs found by the NVIDIA QA Team label Jun 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance NV QA Bugs found by the NVIDIA QA Team

Projects

None yet

4 participants