Skip to content

docs(reference,quickstart): explain --fresh/--yes and the curl|bash flag form#3351

Closed
latenighthackathon wants to merge 1 commit into
NVIDIA:mainfrom
latenighthackathon:docs/onboard-fresh-and-curl-tty
Closed

docs(reference,quickstart): explain --fresh/--yes and the curl|bash flag form#3351
latenighthackathon wants to merge 1 commit into
NVIDIA:mainfrom
latenighthackathon:docs/onboard-fresh-and-curl-tty

Conversation

@latenighthackathon

@latenighthackathon latenighthackathon commented May 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Two related doc gaps reported in the same week. Adds an ### nemoclaw onboard flag-explainer block for --fresh / --resume / --yes to the commands reference, and adds the bash -s -- --yes-i-accept-third-party-software flag form to the quickstart curl|bash example.

Related Issue

Closes #3275. Closes #3233 (partial, see verification notes).

Changes

  • docs/reference/commands.mdx: new #### --fresh and --resume subsection mirroring the existing #### --from <Dockerfile> pattern. Explains the default resume-saved-session behavior, contrasts --fresh against --resume (mutually exclusive), and clarifies the failure mode if no saved session exists for --resume. Also adds a #### --yes / -y subsection clarifying that --yes is for safe-for-unattended prompts and is not equivalent to --yes-i-accept-third-party-software for the licensing notice.
  • docs/get-started/quickstart.mdx: adds the bash -s -- --yes-i-accept-third-party-software flag form alongside the existing env-var form, plus a one-sentence note that piping curl into bash strips the TTY so explicit acceptance is required.
  • .agents/skills/nemoclaw-user-reference/references/commands.md: same #### --fresh and --resume and #### --yes / -y subsections added to keep the auto-generated skill in sync. The onboard synopsis at the top of the file already lists [--yes | -y].

Test plan

  • prek run clean
  • Behavior verified against current nemoclaw onboard --help output for the flag names + descriptions
  • curl|bash form verified against the installer source for accepted invocation patterns

Signed-off-by: latenighthackathon latenighthackathon@users.noreply.github.com

@copy-pr-bot

copy-pr-bot Bot commented May 11, 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 May 11, 2026

Copy link
Copy Markdown
Contributor

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Adds nemoclaw onboard docs for --fresh/--resume and --yes/-y, mirrors those docs in the agent skill reference, and documents a TTY/workaround for piped installer usage in the quickstart guide.

Changes

NemoClaw CLI Onboarding Documentation

Layer / File(s) Summary
Onboarding CLI Flag Reference
docs/reference/commands.md
Adds reference sections for --fresh/--resume (session control with mutual exclusivity and resume-by-default behavior) and --yes/-y (auto-confirm flag equivalent to NEMOCLAW_YES=1, intended for non-interactive use, and does not replace third-party acceptance).
Agent Skill Documentation Mirror
.agents/skills/nemoclaw-user-reference/references/commands.md
Mirrors the onboarding flag documentation (--fresh/--resume, --yes/-y) with matching wording and structure.
Quickstart Installation Guide
docs/get-started/quickstart.md
Explains that piping `curl

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Fresh starts and resumed trails I sow,
Tiny flags that tell the installer where to go,
When pipes steal the TTY and scripts run low—
bash -s whispers "accept" and onward we row,
A nibble of docs, and the onboarding will glow.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main changes: documenting the --fresh flag behavior and --yes flag, plus explaining the curl|bash flag form for installation.
Linked Issues check ✅ Passed The PR fully addresses the coding requirements from both linked issues: #3275 (documents the bash -s -- --yes-i-accept-third-party-software workaround and TTY stripping) and #3233 (documents --fresh/--resume and --yes/-y flag behaviors).
Out of Scope Changes check ✅ Passed All changes are documentation-only and directly scoped to the linked issues: three modified markdown files explain the --fresh, --resume, --yes flags and the curl|bash installation pattern with no unrelated code changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.agents/skills/nemoclaw-user-reference/references/commands.md:
- Around line 173-179: The synopsis near the top of the document is missing the
new `--yes`/`-y` flag; update the synopsis line that lists flags to include
`[--yes | -y]` (matching the detailed section titled "`--yes` / `-y`") so the
top-of-page synopsis and the detailed flag description stay consistent.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: c33219f4-8429-4e43-9f79-792e8d406c2c

📥 Commits

Reviewing files that changed from the base of the PR and between 9bc5e7c and d0710db.

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

Comment thread .agents/skills/nemoclaw-user-reference/references/commands.md
@wscurran

Copy link
Copy Markdown
Contributor

✨ Thanks for submitting this detailed PR to address documentation gaps for the --fresh, --yes, and --resume flags in the NemoClaw onboard command. This change aims to improve the accuracy of the documentation by explaining the default resume-saved-session behavior and clarifying the failure mode if no saved session exists for --resume.


Related open issues:

…lag form

Two related doc gaps reported in the same week.

Closes NVIDIA#3275: the quickstart already showed the env-var form for accepting
the third-party software notice when piping `curl` into `bash`, but did
not show the flag form (`bash -s -- --yes-i-accept-third-party-software`)
that `install.sh --help` documents. Add a second example next to the env
form and a one-sentence note that piping `curl` into `bash` strips the
TTY so explicit acceptance is required.

Closes NVIDIA#3233 (partial): adds `#### --fresh and --resume` and `#### --yes / -y`
flag subsections to `### nemoclaw onboard` in `docs/reference/commands.md`,
mirroring the existing `#### --from <Dockerfile>` subsection pattern.
Explains the default-resume behavior, contrasts `--fresh` against `--resume`
(mutually exclusive), and clarifies that `--yes` does not bypass the
third-party software notice. The remaining two complaints in NVIDIA#3233 are
stale on current main: `--probe-only` is documented at commands.md:308
and `--yes` is in the onboard synopsis at line 68.

Mirrored to the nemoclaw-user-reference skill.

Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
@latenighthackathon

Copy link
Copy Markdown
Contributor Author

Closing in favor of #4167 which is rebuilt cleanly on current upstream/main with the same content. Cheers!

latenighthackathon added a commit to latenighthackathon/NemoClaw that referenced this pull request May 27, 2026
…lag form (closes NVIDIA#3233, NVIDIA#3275)

Three small documentation additions in the same area:

`docs/reference/commands.mdx` gains two new subsections under the
`nemoclaw onboard` reference, between the `--reuse-health` block and
the `--from <Dockerfile>` block:

  - `--fresh` and `--resume` — explains the default resume-saved-session
    behavior, the `--fresh` opt-out, the `--resume` "must-exist" form,
    and the mutual exclusion.
  - `--yes` / `-y` — explains auto-confirm semantics, the
    `NEMOCLAW_YES=1` equivalent, and the explicit carve-out for the
    third-party software notice.

`docs/get-started/quickstart.mdx` clarifies that piping `curl` into
`bash` strips the TTY, then documents both non-interactive forms:
either env-var prefix on `bash`, or the flag form via `bash -s --
--yes-i-accept-third-party-software`.

The synopsis line at the top of the onboard section was already
updated upstream to include `[--yes | -y]`, so no synopsis change is
needed in the fresh version.

The mirror at `.agents/skills/nemoclaw-user-reference/references/commands.md`
is regenerated by `scripts/docs-to-skills.py`.

This is a fresh recreation of the closed NVIDIA#3351 rebuilt cleanly on
top of current upstream/main as a single signed commit.

Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
@wscurran wscurran added area: install Install, setup, prerequisites, or uninstall flow area: onboarding Onboarding FSM, provider setup, sandbox launch, or first-run flow labels Jun 3, 2026
@wscurran wscurran added bug-fix PR fixes a bug or regression area: docs Documentation, examples, guides, or docs build and removed Getting Started 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 area: install Install, setup, prerequisites, or uninstall flow area: onboarding Onboarding FSM, provider setup, sandbox launch, or first-run flow bug-fix PR fixes a bug or regression

Projects

None yet

3 participants