docs: clarify that the installer does not require root or sudo (#406)#1595
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (3)
📝 WalkthroughWalkthroughThe changes add clarification to installation documentation, explicitly stating that the NemoClaw installer runs as a normal user without requiring sudo/root, installs Node.js via nvm and NemoClaw via npm into user-local directories, and requires Docker to be pre-installed and running. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 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 |
SudheerDev-AIML
force-pushed
the
docs/clarify-install-privileges-v2
branch
from
3cb3b4a to
bc5a183
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
1-1:⚠️ Potential issue | 🔴 CriticalMissing required SPDX license header.
The coding guidelines require every source file matching
**/*.{js,ts,tsx,sh,md}to include an SPDX license header.
For Markdown files, use HTML comments.📝 Add the required SPDX header
Add these lines at the top of the file:
+<!-- + SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. + SPDX-License-Identifier: Apache-2.0 +--> + # 🦞 NVIDIA NemoClaw: Reference Stack for Running OpenClaw in OpenShellAs per coding guidelines, every Markdown file must include the SPDX license header using HTML comment syntax.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 1, Add the required SPDX license header as an HTML comment at the very top of the README before the existing title line "# 🦞 NVIDIA NemoClaw: Reference Stack for Running OpenClaw in OpenShell"; insert the standard SPDX lines (e.g., SPDX‑License‑Identifier and copyright notice) in HTML comment form so the Markdown file complies with the **/*.{js,ts,tsx,sh,md}** guideline.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@README.md`:
- Line 1: Add the required SPDX license header as an HTML comment at the very
top of the README before the existing title line "# 🦞 NVIDIA NemoClaw:
Reference Stack for Running OpenClaw in OpenShell"; insert the standard SPDX
lines (e.g., SPDX‑License‑Identifier and copyright notice) in HTML comment form
so the Markdown file complies with the **/*.{js,ts,tsx,sh,md}** guideline.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 71b9a87f-d05a-4422-a9e8-1cd490787e51
📒 Files selected for processing (8)
.agents/skills/nemoclaw-configure-security/SKILL.md.agents/skills/nemoclaw-configure-security/references/best-practices.md.agents/skills/nemoclaw-configure-security/references/credential-storage.md.agents/skills/nemoclaw-reference/references/architecture.md.agents/skills/nemoclaw-reference/references/commands.md.agents/skills/nemoclaw-reference/references/troubleshooting.mdREADME.mddocs/reference/troubleshooting.md
+<!--
+ SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+ SPDX-License-Identifier: Apache-2.0
+-->
+
# 🦞 NVIDIA NemoClaw: Reference Stack for Running OpenClaw in OpenShellAdd these lines to the very top of README.md (before the existing title). This aligns with the coding guidelines requiring all |
README.md
Outdated
| > | ||
| > The installer runs as your normal user and does not require `sudo` or root. | ||
| > It installs Node.js via nvm and NemoClaw via npm, both into user-local directories. | ||
| > If the [prerequisite](#software) software (Docker, OpenShell) is not already installed, install it separately first. Those tools may require elevated privileges on Linux. |
|
The note about installing OpenShell separately is inaccurate — the NemoClaw installer and Code evidence:
Existing docs already warn against this. Multiple pages say:
— Telling users to "install [OpenShell] separately first" contradicts this guidance and could cause version mismatches with the pinned release the installer expects. Docker is a genuine prerequisite the user must provide, but OpenShell is not — the installer owns that dependency. Suggestion: remove OpenShell from the "install separately" note and keep it scoped to Docker (and possibly other true prerequisites). |
SudheerDev-AIML
force-pushed
the
docs/clarify-install-privileges-v2
branch
from
bc5a183 to
9d0543c
Compare
|
Hi @miyoungc Good catch, thank you. Updated to remove OpenShell from the prerequisites note . Only Docker is listed now. The troubleshooting entry also notes that the installer handles OpenShell automatically. Thank you. |
|
Thank you for your contribution! Approved |
|
Please add a DCO sign-off line in the PR description.
|
…A#406) Add a privileges note to the README quickstart section explaining that the installer runs as a normal user without sudo or root. Add a matching troubleshooting entry for users who encounter permission errors from Docker and mistake them for installer failures. Add the required SPDX license header to README.md. The installer handles OpenShell installation automatically via a pinned release, so only Docker is listed as a true user-provided prerequisite. Closes NVIDIA#406 Made-with: Cursor
SudheerDev-AIML
force-pushed
the
docs/clarify-install-privileges-v2
branch
from
9d0543c to
4b5e394
Compare
…A#406) (NVIDIA#1595) <!-- markdownlint-disable MD041 --> ## Summary Clarify privilege requirements for the NemoClaw installer. The install one-liner gave no indication of whether root was needed, causing confusion when users hit permission errors from prerequisite tools (Docker, OpenShell) and assumed the installer itself required elevated privileges. This is a scoped-down refresh of NVIDIA#760, incorporating maintainer feedback. ## Related Issue Closes NVIDIA#406 ## Changes - Add a privileges note to the README quickstart callout explaining that the installer runs as a normal user and does not need `sudo` or root. - Add a new "Permission errors during installation" entry to the troubleshooting page (`docs/reference/troubleshooting.md`) explaining that permission errors typically come from prerequisites, not the NemoClaw installer. - Include auto-regenerated agent skill files from the `docs-to-skills` pipeline. ## Type of Change - [ ] Code change for a new feature, bug fix, or refactor. - [ ] Code change with doc updates. - [x] Doc only. Prose changes without code sample modifications. - [ ] Doc only. Includes code sample changes. ## Testing - [x] `npx prek run --all-files` passes (or equivalently `make check`). - [ ] `npm test` passes. - [ ] `make docs` builds without warnings. (for doc-only changes) All pre-commit hooks passed: trailing-whitespace, end-of-file-fixer, markdownlint-cli2, gitleaks, commitlint, skills YAML, and the `Regenerate agent skills from docs` hook. ## Checklist ### General - [x] I have read and followed the [contributing guide](CONTRIBUTING.md). - [x] I have read and followed the [style guide](docs/CONTRIBUTING.md). (for doc-only changes) ### Code Changes _N/A — doc-only PR._ ### Doc Changes - [x] Follows the [style guide](docs/CONTRIBUTING.md). - [ ] New pages include SPDX license header and frontmatter, if creating a new page. - [x] Cross-references and links verified. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated README with clarified installation prerequisites and requirements * Added troubleshooting section for permission errors during installation * Documented that the installer runs as a normal user without elevated privileges, installs Node.js and packages to user-local directories via standard package managers, and requires Docker to be pre-installed and running on the system <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: SudheerDev-AIML <gsk.aiml@gmail.com>
4 participants
Summary
Clarify privilege requirements for the NemoClaw installer.
The install one-liner gave no indication of whether root was needed, causing confusion when users
hit permission errors from prerequisite tools (Docker, OpenShell) and assumed the installer itself
required elevated privileges.
This is a scoped-down refresh of #760, incorporating maintainer feedback.
Related Issue
Closes #406
Changes
normal user and does not need
sudoor root.(
docs/reference/troubleshooting.md) explaining that permission errors typically come fromprerequisites, not the NemoClaw installer.
docs-to-skillspipeline.Type of Change
Testing
npx prek run --all-filespasses (or equivalentlymake check).npm testpasses.make docsbuilds without warnings. (for doc-only changes)All pre-commit hooks passed: trailing-whitespace, end-of-file-fixer, markdownlint-cli2,
gitleaks, commitlint, skills YAML, and the
Regenerate agent skills from docshook.Checklist
General
Code Changes
N/A — doc-only PR.
Doc Changes
Summary by CodeRabbit
Signed-off-by: SudheerDev-AIML gsk.aiml@gmail.com