Skip to content

docs: add curl uninstall flag example to README#440

Merged
miyoungc merged 1 commit intomainfrom
fix/readme-uninstall-flag-example
Mar 19, 2026
Merged

docs: add curl uninstall flag example to README#440
miyoungc merged 1 commit intomainfrom
fix/readme-uninstall-flag-example

Conversation

@kjw3
Copy link
Copy Markdown
Contributor

@kjw3 kjw3 commented Mar 19, 2026

Summary

  • add a curl uninstall example after the README uninstall flags table
  • show how to pass --yes through bash -s --
  • make the documented uninstall flags directly actionable

Testing

  • reviewed the README uninstall section locally
  • verified the example matches the documented curl uninstall flow

Closes #439

Summary by CodeRabbit

  • Documentation
    • Added an additional uninstall usage example demonstrating how to suppress the confirmation prompt when running the uninstall script.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 19, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 01f25b49-a500-41e1-8bf4-aaf0ffda1606

📥 Commits

Reviewing files that changed from the base of the PR and between 6ca7d37 and c121ce7.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

Added a documentation example to the README demonstrating how to pass command-line flags to the uninstall script when invoking it via curl | bash, specifically showing usage of the bash -s -- --yes syntax.

Changes

Cohort / File(s) Summary
README Documentation
README.md
Added usage example demonstrating how to suppress the uninstall confirmation prompt by piping the uninstall script to bash with the -s -- --yes flags.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A flag passes through the curl-ing stream,
With bash -s -- making pipes a dream,
No prompts to slow the swift goodbye,
Just --yes and the bundle flies by! ✨

🚥 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 accurately describes the main change: adding a curl uninstall flag example to the README documentation.
Linked Issues check ✅ Passed The pull request directly addresses issue #439 by adding a curl uninstall flag example showing how to pass the --yes flag through bash -s --.
Out of Scope Changes check ✅ Passed All changes are scoped to the README documentation and directly address the objective of documenting curl uninstall flag usage.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/readme-uninstall-flag-example
📝 Coding Plan
  • Generate coding plan for human review comments

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

@kjw3 kjw3 requested a review from miyoungc March 19, 2026 20:23
@miyoungc miyoungc merged commit b3ae862 into main Mar 19, 2026
5 checks passed
Ryuketsukami pushed a commit to Ryuketsukami/NemoClaw that referenced this pull request Mar 24, 2026
jessesanford pushed a commit to jessesanford/NemoClaw that referenced this pull request Mar 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document curl uninstall flag usage in README

2 participants