Skip to content

docs(reference): document onboard recreate-sandbox and agent flags#2474

Open
WilliamK112 wants to merge 1 commit intoNVIDIA:mainfrom
WilliamK112:docs/onboard-followup-flags
Open

docs(reference): document onboard recreate-sandbox and agent flags#2474
WilliamK112 wants to merge 1 commit intoNVIDIA:mainfrom
WilliamK112:docs/onboard-followup-flags

Conversation

@WilliamK112
Copy link
Copy Markdown
Contributor

@WilliamK112 WilliamK112 commented Apr 25, 2026

Summary

Testing

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

Related

Summary by CodeRabbit

  • Documentation
    • Added comprehensive documentation for the --recreate-sandbox option, which forces deletion and recreation of the existing sandbox environment during onboarding.
    • Added documentation for the --agent <name> option, allowing users to select a specific installed agent profile during onboarding.
    • Documented the NEMOCLAW_RECREATE_SANDBOX=1 environment variable as an equivalent approach for non-interactive onboarding runs.

@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented Apr 25, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 25, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 37bb03c6-f5de-4dd8-b10a-20203190da2f

📥 Commits

Reviewing files that changed from the base of the PR and between 9c5a42a and 0f64b53.

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

📝 Walkthrough

Walkthrough

Documentation updates to the nemoclaw onboard command reference files, adding descriptions for two new CLI options: --recreate-sandbox (for forcing sandbox deletion and recreation) and --agent <name> (for selecting a specific installed agent profile during onboarding).

Changes

Cohort / File(s) Summary
Command Reference Documentation
.agents/skills/nemoclaw-user-reference/references/commands.md, docs/reference/commands.md
Added documentation for two new nemoclaw onboard CLI options: --recreate-sandbox (with example and non-interactive environment variable alternative NEMOCLAW_RECREATE_SANDBOX=1) and --agent <name> (for selecting an installed agent profile). Both additions include usage examples.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Our docs now bloom with flags so new,
--recreate-sandbox and agents too!
A rabbit's joy when references grow clear,
The onboard command gets upgrades here! 📚✨

🚥 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 summarizes the main change: documenting two new onboard command flags (recreate-sandbox and agent), matching the actual scope of the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ 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 wscurran added documentation Improvements or additions to documentation NemoClaw CLI Use this label to identify issues with the NemoClaw command-line interface (CLI). labels Apr 27, 2026
@wscurran
Copy link
Copy Markdown
Contributor

✨ Thanks for submitting this pull request that proposes a way to document the onboard recreate-sandbox and agent flags. This identifies a documentation gap and proposes a change to include dedicated reference entries for these flags under nemoclaw onboard, enhancing clarity and usability.


Related open PRs:


Related open issues:

@wscurran wscurran added Getting Started Use this label to identify setup, installation, or onboarding issues. priority: high Important issue that should be resolved in the next release labels Apr 27, 2026
@wscurran
Copy link
Copy Markdown
Contributor

✨ Thanks for submitting this pull request that proposes a way to document the onboard recreate-sandbox and agent flags. This identifies a documentation gap and proposes a change to include dedicated reference entries for these flags.


Related open PRs:


Related open issues:

@wscurran wscurran removed the priority: high Important issue that should be resolved in the next release label Apr 27, 2026
@wscurran wscurran requested a review from miyoungc April 27, 2026 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Getting Started Use this label to identify setup, installation, or onboarding issues. NemoClaw CLI Use this label to identify issues with the NemoClaw command-line interface (CLI).

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants