Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
latenighthackathon wants to merge 1 commit into from
Closed

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .agents/skills/nemoclaw-user-reference/references/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Comment thread
coderabbitai[bot] marked this conversation as resolved.
#### `--from <Dockerfile>`

Build the sandbox image from a custom Dockerfile instead of the stock NemoClaw image.
Expand Down
11 changes: 9 additions & 2 deletions docs/get-started/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
14 changes: 14 additions & 0 deletions docs/reference/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <Dockerfile>`

Build the sandbox image from a custom Dockerfile instead of the stock NemoClaw image.
Expand Down