Skip to content

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

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

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

Conversation

@WilliamK112

@WilliamK112 WilliamK112 commented Apr 25, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add dedicated nemoclaw onboard reference entries for the remaining undocumented flags --recreate-sandbox and --agent <name>
  • keep the scope to the docs gap that remains after nearby onboard/reference changes merged into main
  • regenerate the derived user-reference skill content from docs/

Testing

  • not run (docs-only change)

Related

Signed-off-by: WilliamK112 164879897+WilliamK112@users.noreply.github.com

Summary by CodeRabbit

  • Documentation
    • Added documentation for the new --recreate-sandbox option in the nemoclaw onboard command, enabling users to delete and recreate sandboxes, with support for non-interactive mode via environment variable.
    • Added documentation for the new --agent <name> option, allowing users to select and onboard a specific installed agent profile during setup, with example invocations provided.

@copy-pr-bot

copy-pr-bot Bot commented Apr 25, 2026

Copy link
Copy Markdown

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

coderabbitai Bot commented Apr 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack
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: 25f3845f-d63a-44e8-b20a-27666311c777

📥 Commits

Reviewing files that changed from the base of the PR and between 0f64b53 and 3da129f.

📒 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 (2)
  • docs/reference/commands.md
  • .agents/skills/nemoclaw-user-reference/references/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

Command Reference Documentation

Layer / File(s) Summary
New option subsections
.agents/skills/nemoclaw-user-reference/references/commands.md, docs/reference/commands.md
Added text and console examples documenting nemoclaw onboard --recreate-sandbox (plus NEMOCLAW_RECREATE_SANDBOX=1 non-interactive equivalent) and nemoclaw onboard --agent <name> (select a specific installed agent profile).
Insertion point
.agents/skills/nemoclaw-user-reference/references/commands.md
Inserted the new option documentation immediately before the existing “Before creating the gateway, the wizard runs preflight checks.” section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped through lines to add a clue,
Two flags to guide the onboarding crew.
Recreate the sandbox, choose which bot to greet,
Docs now tidy — the CLI's complete! 📘✨

🚥 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 describes the main change: adding documentation for two previously undocumented onboard flags (--recreate-sandbox and --agent).
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

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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

@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

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:

Use this when you need onboarding to rebuild the sandbox after configuration changes, to recover from a broken sandbox state, or to force recreation when no provider or model drift is detected.

```console
$ nemoclaw onboard --resume --recreate-sandbox

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.

--resume is only for continuing an interrupted onboarding session; completed sessions are marked non-resumable, so this example can fail for the normal "recreate an existing sandbox" case. Suggest dropping --resume here.

Suggested change
$ nemoclaw onboard --resume --recreate-sandbox
$ nemoclaw onboard --recreate-sandbox

Use this when you need onboarding to rebuild the sandbox after configuration changes, to recover from a broken sandbox state, or to force recreation when no provider or model drift is detected.

```console
$ nemoclaw onboard --resume --recreate-sandbox

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.

Please mirror the source docs correction in the generated skill copy so the two files stay in sync.

Suggested change
$ nemoclaw onboard --resume --recreate-sandbox
$ nemoclaw onboard --recreate-sandbox

@wscurran

wscurran commented May 6, 2026

Copy link
Copy Markdown
Contributor

Thanks for this. Since #1521 and #2223 have both merged nearby onboard/reference docs changes, could you please rebase this PR on current main and confirm which docs gaps remain, especially for --agent <name> versus any --recreate-sandbox content now covered by #1521? Also please fix the failing DCO check so we can reassess the remaining docs delta.

@WilliamK112

Copy link
Copy Markdown
Contributor Author

Rebased this PR onto current main and trimmed the scope confirmation accordingly. After nearby onboard/reference changes merged, the remaining delta here is still the dedicated reference entries for --recreate-sandbox and --agent <name> in both the canonical docs and the derived user-reference skill file. I also updated the PR description to satisfy the DCO requirement.

@WilliamK112
WilliamK112 force-pushed the docs/onboard-followup-flags branch from 0f64b53 to 3da129f Compare May 8, 2026 05:20
@miyoungc

Copy link
Copy Markdown
Collaborator

Thanks for the follow-up here. I’m going to close this as stale/superseded.

Since this PR was opened, the docs source migrated from legacy docs/reference/commands.md to Fern MDX, and docs/reference/commands.md no longer exists on current main. The generated user skill file also should not be edited directly in ordinary docs PRs; it is regenerated from docs/ during release prep.

The remaining docs gap is already covered on current main in docs/reference/commands.mdx: the nemoclaw onboard synopsis includes --recreate-sandbox, --agent <name>, and --yes-i-accept-third-party-software, and the page documents --agent <name> plus NEMOCLAW_RECREATE_SANDBOX=1.

There is also still an unresolved accuracy issue from the earlier review: nemoclaw onboard --resume --recreate-sandbox is not the right example for the normal “recreate an existing sandbox” case because --resume is only for interrupted onboarding sessions.

Thanks again for spotting the docs gap. The current docs have since moved forward enough that this branch is no longer the right patch to merge.

@miyoungc miyoungc closed this May 22, 2026
@wscurran wscurran added area: cli Command line interface, flags, terminal UX, or output area: install Install, setup, prerequisites, or uninstall flow area: onboarding Onboarding FSM, provider setup, sandbox launch, or first-run flow and removed Getting Started labels Jun 3, 2026
@wscurran wscurran added needs: review PR is conflict-free and awaiting maintainer review area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance and removed status: rfr needs: review PR is conflict-free and awaiting maintainer review 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 area: install Install, setup, prerequisites, or uninstall flow area: onboarding Onboarding FSM, provider setup, sandbox launch, or first-run flow chore Build, CI, dependency, or tooling maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants