Skip to content

docs(reference): align onboard usage with supported flags - #1795

Closed
WilliamK112 wants to merge 1 commit into
NVIDIA:mainfrom
WilliamK112:docs/onboard-usage-flags
Closed

docs(reference): align onboard usage with supported flags#1795
WilliamK112 wants to merge 1 commit into
NVIDIA:mainfrom
WilliamK112:docs/onboard-usage-flags

Conversation

@WilliamK112

@WilliamK112 WilliamK112 commented Apr 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • update the nemoclaw onboard synopsis to include documented supported flags
  • add reference entries for --recreate-sandbox and --agent <name>
  • regenerate the derived user-reference skill content from docs/

Testing

  • npm test -- test/check-docs-links.test.ts

Related

Summary by CodeRabbit

  • Documentation
    • Updated nemoclaw onboard command reference with new CLI flags: --recreate-sandbox, --agent <name>, and --yes-i-accept-third-party-software.
    • Added descriptions for --recreate-sandbox to delete and recreate existing sandboxes and --agent <name> to select specific packaged agents.

@coderabbitai

coderabbitai Bot commented Apr 12, 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

Run ID: ead71a0f-e98d-40a9-abc9-0ad2388eedb9

📥 Commits

Reviewing files that changed from the base of the PR and between 1ba57ab and 3c99ddb.

📒 Files selected for processing (2)
  • .agents/skills/nemoclaw-user-reference/references/commands.md
  • docs/reference/commands.md

📝 Walkthrough

Walkthrough

Updated CLI command reference documentation for nemoclaw onboard to include previously undocumented flags: --recreate-sandbox, --agent <name>, and --yes-i-accept-third-party-software. Added new sections describing the behavior and usage of each flag with examples.

Changes

Cohort / File(s) Summary
CLI Command Reference Updates
.agents/skills/nemoclaw-user-reference/references/commands.md, docs/reference/commands.md
Updated nemoclaw onboard command synopsis to include --recreate-sandbox, --agent <name>, and --yes-i-accept-third-party-software. Added documentation sections explaining --recreate-sandbox (delete and recreate existing sandbox) and --agent <name> (select specific packaged agent) with usage examples.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 Hops with glee through the docs so bright,
New flags emerge in morning light!
Sandbox, agents, agreements true—
The reference is now complete and new!
~Bunny Scribe 📚✨

🚥 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 'docs(reference): align onboard usage with supported flags' accurately describes the main change: updating documentation to match CLI behavior by adding missing flags to the onboard command reference.
Linked Issues check ✅ Passed The PR successfully addresses all requirements from issue #1730: adds --recreate-sandbox, --agent , and --yes-i-accept-third-party-software to the nemoclaw onboard command synopsis and documentation.
Out of Scope Changes check ✅ Passed All changes are within scope: updates to docs/reference/commands.md and the derived user-reference skill content are directly related to aligning CLI reference documentation with supported flags.
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 self-assigned this Apr 14, 2026
@prekshivyas

Copy link
Copy Markdown
Collaborator

Thank you for this @WilliamK112! Closing because the synopsis line change overlaps with #1783 (already approved and pending merge), which includes the same flags plus --dangerously-skip-permissions.

The --recreate-sandbox and --agent <name> documentation sections you added are valuable though — would you be open to rebasing those as a follow-up PR once #1783 merges? That way there's no conflict on the synopsis line.

@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
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

Projects

None yet

3 participants