docs(uninstall): show flag-passing form for the hosted uninstall.sh (#2357)#3124
Merged
ericksoa merged 5 commits intoMay 20, 2026
Merged
Conversation
Contributor
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis PR clarifies uninstall flag usage for NemoClaw sandbox management. It updates two documentation files to state that ChangesUninstall Flag Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
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 `@docs/manage-sandboxes/lifecycle.md`:
- Around line 276-278: Change the code fence for the CLI example that currently
uses ```bash``` to use ```console``` and prefix the command line with the shell
prompt `$`; locate the block containing the uninstall curl pipeline (the snippet
with `curl -fsSL
https://raw.githubusercontent.com/NVIDIA/NemoClaw/refs/heads/main/uninstall.sh |
bash -s -- --yes --delete-models`) and replace the fence language and add the
leading `$ ` before the command so the example follows the required console/$
formatting.
🪄 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: a1f69aa6-6fcf-450a-84ff-2253b187a9be
📒 Files selected for processing (2)
.agents/skills/nemoclaw-user-manage-sandboxes/SKILL.mddocs/manage-sandboxes/lifecycle.md
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/manage-sandboxes/lifecycle.md (1)
274-274: ⚡ Quick winEnd the sentence with a period instead of a colon.
Line 274 currently ends with
:. Please end the sentence with.to match docs source formatting rules.Suggested edit
-The same `--yes`, `--keep-openshell`, and `--delete-models` flags listed above also apply to the hosted script. Pass them after `bash -s --`: +The same `--yes`, `--keep-openshell`, and `--delete-models` flags listed above also apply to the hosted script. Pass them after `bash -s --`.As per coding guidelines, “Every sentence must end with a period.” and “Colons should only introduce a list.”
🤖 Prompt for 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. In `@docs/manage-sandboxes/lifecycle.md` at line 274, The sentence describing how to pass flags to the hosted script currently ends with a colon; change the trailing punctuation to a period so the sentence reads "...Pass them after `bash -s --`." Update the line containing the flags `--yes`, `--keep-openshell`, and `--delete-models` and the text `bash -s --` to end with a period instead of a colon to comply with the docs sentence-ending rule.
🤖 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.
Nitpick comments:
In `@docs/manage-sandboxes/lifecycle.md`:
- Line 274: The sentence describing how to pass flags to the hosted script
currently ends with a colon; change the trailing punctuation to a period so the
sentence reads "...Pass them after `bash -s --`." Update the line containing the
flags `--yes`, `--keep-openshell`, and `--delete-models` and the text `bash -s
--` to end with a period instead of a colon to comply with the docs
sentence-ending rule.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 6ca3e3ec-e69c-4218-8933-f5dbb472731f
📒 Files selected for processing (2)
.agents/skills/nemoclaw-user-manage-sandboxes/SKILL.mddocs/manage-sandboxes/lifecycle.md
🚧 Files skipped from review as they are similar to previous changes (1)
- .agents/skills/nemoclaw-user-manage-sandboxes/SKILL.md
Contributor
|
✨ Thanks for submitting this PR that improves the uninstall documentation by showing how to pass flags via the pipe. Related open issues: |
jyaunches
approved these changes
May 7, 2026
latenighthackathon
force-pushed
the
docs/uninstall-flag-passing
branch
4 times, most recently
from
5527403 to
35b8bd7
Compare
…VIDIA#2357) Reporter @subrnath: the quickstart shows `curl ... | bash` for the hosted uninstall.sh but does not show how to pass --yes, --keep-openshell, or --delete-models through the curl pipe. Trying the obvious `curl ... | bash --yes` errors out because flags before the pipeline target hit `bash` itself. Add a single example demonstrating the `bash -s -- <flags>` form right after the existing curl|bash one. The same three flags already documented in the table above for `nemoclaw uninstall` work for the hosted form too. Mirrored into the nemoclaw-user-manage-sandboxes skill. Closes NVIDIA#2357 Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
…ample CodeRabbit flagged that the new uninstall.sh flag-passing example used ```bash``` while the dominant convention in this docs tree is ```console with a leading `$ ` prompt. Convert the new fence to match (21 of the 24 fenced blocks in lifecycle.md already use console). Mirror the same change into the user-manage-sandboxes skill. Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
The sentence introducing the bash -s -- example currently ends with a colon. The project docs guideline reserves colons for introducing lists, so use a period instead. Code-block proximity still ties the example to the prose. Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
latenighthackathon
force-pushed
the
docs/uninstall-flag-passing
branch
from
a2e2770 to
987046f
Compare
…assing Signed-off-by: Aaron Erickson <aerickson@nvidia.com> # Conflicts: # docs/manage-sandboxes/lifecycle.mdx
Signed-off-by: Aaron Erickson <aerickson@nvidia.com>
12 tasks
miyoungc
added a commit
that referenced
this pull request
May 20, 2026
## Summary Refreshes the NemoClaw docs for v0.0.46 by updating version metadata, release notes, and generated user skills. The refresh also keeps public docs aligned with the docs skip list by removing non-public experimental references from the generated output. ## Related Issue None. ## Changes - #3744 and #3824 -> `docs/about/release-notes.mdx`: Added Windows bootstrap and WSL express install coverage for v0.0.46. - #3392 -> `docs/manage-sandboxes/messaging-channels.mdx`, `docs/reference/commands.mdx`, `docs/reference/network-policies.mdx`, and policy examples: Refreshed public messaging channel docs around WhatsApp and matching policy presets. - #3742, #3767, #3732, #3786, #3777, and #3808 -> `docs/about/release-notes.mdx`: Added release-note coverage for Hermes managed tools, Bedrock Runtime endpoint detection, WSL Ollama proxying, Model Router Python fallback, plugin command registration, and tool-catalog latency improvements. - #3124 -> `docs/about/release-notes.mdx`: Added release-note coverage for hosted uninstall flag guidance. - Generated `nemoclaw-user-*` skills from the updated MDX docs for the v0.0.46 release. ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [ ] Code change with doc updates - [x] Doc only (prose changes, no code sample modifications) - [ ] Doc only (includes code sample changes) ## Verification - [ ] `npx prek run --all-files` passes - [ ] `npm test` passes - [ ] Tests added or updated for new or changed behavior - [x] No secrets, API keys, or credentials committed - [x] Docs updated for user-facing behavior changes - [ ] `make docs` builds without warnings (doc changes only) - [x] Doc pages follow the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md) (doc changes only) - [ ] New doc pages include SPDX header and frontmatter (new pages only) Verification notes: - Commit hooks passed, including markdownlint, gitleaks, docs-to-skills verification, env-var docs, and skills YAML checks. - `python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --doc-platform fern-mdx` passed. - `bash test/e2e/e2e-cloud-experimental/check-docs.sh --only-links --local-only --with-skills` passed. - `git diff --check` passed. - `make docs` was attempted but blocked before MDX validation because `npx` received HTTP 403 fetching `fern-api` from npm. --- Signed-off-by: Miyoung Choi <miyoungc@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Released v0.0.46: improved Windows setup, WhatsApp messaging support, Hermes sandbox/tool routing, Anthropic endpoint compatibility, Ollama proxy routing, model-router fallback, OpenClaw plugin/backup compatibility, sandbox build tooling fixes, and updated uninstall flag behavior. * **Documentation** * Removed WeChat from messaging flows and presets across guides and CLI docs; clarified onboarding and channel setup for WhatsApp. Clarified runtime mutability and filesystem (Landlock) behavior — some changes require sandbox rebuilds; prefer host-side commands for durable config. <!-- review_stack_entry_start --> [](https://app.coderabbit.ai/change-stack/NVIDIA/NemoClaw/pull/3911?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack) <!-- review_stack_entry_end --> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
](https://app.coderabbit.ai/change-stack/NVIDIA/NemoClaw/pull/3911?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack){kind=link}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
#2357 reports that the docs show
curl ... | bashfor the hosteduninstall.shbut do not show how to pass--yes,--keep-openshell, or--delete-modelsthrough the pipe. Trying the obviouscurl ... | bash --yeserrors out because flags before the pipeline target hitbashitself, not the script.Problem
The flags table on
docs/manage-sandboxes/lifecycle.mdalready lists the three uninstall flags fornemoclaw uninstall. The hosteduninstall.shaccepts the same flags, but the curl|bash example below the table did not show thebash -s --form, leaving users to guess.Changes
bash -s -- <flags>form right after the existing curl|bash example. The example uses--yes --delete-modelsto show two flags compose..agents/skills/nemoclaw-user-manage-sandboxes/SKILL.mdso the skill stays aligned with the source.Type of Change
Test plan
bash -s --shell idiom) matchuninstall.sh:129-138.Closes #2357
Signed-off-by: latenighthackathon latenighthackathon@users.noreply.github.com
Summary by CodeRabbit