From 01160837035ea71216acb2698799945695926ec4 Mon Sep 17 00:00:00 2001 From: latenighthackathon Date: Thu, 21 May 2026 05:03:38 +0000 Subject: [PATCH] docs(reference,quickstart): explain --fresh/--yes and the curl|bash flag form Two related doc gaps reported in the same week. Closes #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 #3233 (partial): adds `#### --fresh and --resume` and `#### --yes / -y` flag subsections to `### nemoclaw onboard` in `docs/reference/commands.md`, mirroring the existing `#### --from ` 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 #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 --- .../nemoclaw-user-reference/references/commands.md | 14 ++++++++++++++ docs/get-started/quickstart.mdx | 11 +++++++++-- docs/reference/commands.mdx | 14 ++++++++++++++ 3 files changed, 37 insertions(+), 2 deletions(-) diff --git a/.agents/skills/nemoclaw-user-reference/references/commands.md b/.agents/skills/nemoclaw-user-reference/references/commands.md index 961b7953f9a..4217a307e5c 100644 --- a/.agents/skills/nemoclaw-user-reference/references/commands.md +++ b/.agents/skills/nemoclaw-user-reference/references/commands.md @@ -180,6 +180,20 @@ If a host firewall blocks that sandbox path, onboarding exits with a `sudo ufw a Tune the wait via `NEMOCLAW_REUSE_HEALTH_POLL_COUNT` (default `6`) and `NEMOCLAW_REUSE_HEALTH_POLL_INTERVAL` (default `5` seconds). The poll count is clamped to a minimum of `1` so the probe always runs at least once, and the interval is clamped to a minimum of `0` (no sleep between attempts). +#### `--fresh` and `--resume` + +By default, `nemoclaw onboard` resumes any saved onboarding session for the same sandbox so a transient failure (network, credential typo, etc.) does not force you to redo earlier steps. +Pass `--fresh` to ignore any saved session and start the wizard from the first prompt; use this when the saved session is stale or you want to change selections made in an earlier attempt. +Pass `--resume` to require that a saved session exist and resume from where it left off; the command exits non-zero if no session is found. +`--fresh` and `--resume` are mutually exclusive. + +#### `--yes` / `-y` + +Auto-confirm prompts that are safe for unattended onboarding. +Equivalent to setting `NEMOCLAW_YES=1`. +Use together with `--non-interactive` (or `NEMOCLAW_NON_INTERACTIVE=1`) for fully scripted runs. +This flag does not bypass the third-party software notice; use `--yes-i-accept-third-party-software` (or `NEMOCLAW_ACCEPT_THIRD_PARTY_SOFTWARE=1`) for that. + #### `--from ` Build the sandbox image from a custom Dockerfile instead of the stock NemoClaw image. diff --git a/docs/get-started/quickstart.mdx b/docs/get-started/quickstart.mdx index 87ca6faf460..91b879331f4 100644 --- a/docs/get-started/quickstart.mdx +++ b/docs/get-started/quickstart.mdx @@ -30,13 +30,20 @@ NemoClaw creates a fresh OpenClaw instance inside the sandbox during the onboard curl -fsSL https://www.nvidia.com/nemoclaw.sh | bash ``` -The piped installer prompts through your terminal. In headless scripts or CI, -pass explicit acceptance to the `bash` side of the pipe: +The piped installer prompts through your terminal. +Piping `curl` into `bash` strips the TTY, so in headless scripts or CI you must pass explicit acceptance of the third-party software notice or the installer exits before installing anything. +Either pass the env vars to the `bash` side of the pipe: ```console $ curl -fsSL https://www.nvidia.com/nemoclaw.sh | NEMOCLAW_NON_INTERACTIVE=1 NEMOCLAW_ACCEPT_THIRD_PARTY_SOFTWARE=1 bash ``` +or pass the flag form via `bash -s --`: + +```console +$ curl -fsSL https://www.nvidia.com/nemoclaw.sh | bash -s -- --yes-i-accept-third-party-software +``` + If you use nvm or fnm to manage Node.js, the installer might not update your current shell's PATH. If `nemoclaw` is not found after install, run `source ~/.bashrc` (or `source ~/.zshrc` for zsh) or open a new terminal. diff --git a/docs/reference/commands.mdx b/docs/reference/commands.mdx index 373b831e8d6..8e442c9662a 100644 --- a/docs/reference/commands.mdx +++ b/docs/reference/commands.mdx @@ -187,6 +187,20 @@ If a host firewall blocks that sandbox path, onboarding exits with a `sudo ufw a Tune the wait via `NEMOCLAW_REUSE_HEALTH_POLL_COUNT` (default `6`) and `NEMOCLAW_REUSE_HEALTH_POLL_INTERVAL` (default `5` seconds). The poll count is clamped to a minimum of `1` so the probe always runs at least once, and the interval is clamped to a minimum of `0` (no sleep between attempts). +#### `--fresh` and `--resume` + +By default, `nemoclaw onboard` resumes any saved onboarding session for the same sandbox so a transient failure (network, credential typo, etc.) does not force you to redo earlier steps. +Pass `--fresh` to ignore any saved session and start the wizard from the first prompt; use this when the saved session is stale or you want to change selections made in an earlier attempt. +Pass `--resume` to require that a saved session exist and resume from where it left off; the command exits non-zero if no session is found. +`--fresh` and `--resume` are mutually exclusive. + +#### `--yes` / `-y` + +Auto-confirm prompts that are safe for unattended onboarding. +Equivalent to setting `NEMOCLAW_YES=1`. +Use together with `--non-interactive` (or `NEMOCLAW_NON_INTERACTIVE=1`) for fully scripted runs. +This flag does not bypass the third-party software notice; use `--yes-i-accept-third-party-software` (or `NEMOCLAW_ACCEPT_THIRD_PARTY_SOFTWARE=1`) for that. + #### `--from ` Build the sandbox image from a custom Dockerfile instead of the stock NemoClaw image.