Skip to content

fix(docs): remove bare npm install that installs placeholder package#761

Open
north-echo wants to merge 1 commit intoNVIDIA:mainfrom
north-echo:fix/remove-bare-npm-install-from-docs
Open

fix(docs): remove bare npm install that installs placeholder package#761
north-echo wants to merge 1 commit intoNVIDIA:mainfrom
north-echo:fix/remove-bare-npm-install-from-docs

Conversation

@north-echo
Copy link

@north-echo north-echo commented Mar 24, 2026

Summary

  • Remove npm install -g nemoclaw from docs, which resolves to a placeholder 0.1.0 package on npmjs.org and clobbers the real CLI installed from GitHub source
  • Replace with reference to the official curl installer in both docs/reference/commands.md and the agent skills reference copy

Context

The installer scripts (scripts/install.sh, install.sh) correctly use npm install -g git+https://github.com/NVIDIA/NemoClaw.git, and there's even a test asserting the bare form is never used (install-preflight.test.js:284). But the docs page told users to run the bare npm install -g nemoclaw, which pulls the placeholder from npmjs.org.

Fixes #737

Test plan

  • vitest run test/install-preflight.test.js — 11/11 passing
  • Verify rendered docs page no longer contains npm install -g nemoclaw

Co-Authored-By: Claude noreply@anthropic.com

Summary by CodeRabbit

  • Documentation
    • Updated nemoclaw CLI installation instructions across documentation files to reflect automatic installation via the project's installer script, replacing the previous npm install method.

…older package

The docs told users to run `npm install -g nemoclaw`, which resolves to a
placeholder 0.1.0 package on npmjs.org and clobbers the real CLI installed
from GitHub source. Replace with a reference to the official installer.

Fixes NVIDIA#737

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link

coderabbitai bot commented Mar 24, 2026

📝 Walkthrough

Walkthrough

Documentation updates to two command reference files clarifying that the nemoclaw CLI is installed automatically via the project installer script (curl -fsSL https://www.nvidia.com/nemoclaw.sh | bash), removing references to the manual npm install -g nemoclaw installation method.

Changes

Cohort / File(s) Summary
Documentation Updates
.agents/skills/docs/nemoclaw-reference/references/commands.md, docs/reference/commands.md
Removed explicit npm install -g nemoclaw installation method and clarified that the installer script handles installation automatically. Updated to direct users to the installer rather than npm package installation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 The docs now shine, so clear and bright,
No npm confusion in sight!
The installer takes the lead,
Preventing placeholder deed,
NemoClaw flows left and right! ✨

🚥 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: removing the problematic bare npm install instruction from documentation that references a placeholder package.
Linked Issues check ✅ Passed The PR successfully addresses issue #737 by removing npm install -g nemoclaw from documentation, preventing the placeholder package from clobbering the real CLI installation.
Out of Scope Changes check ✅ Passed All changes are directly scoped to the linked issue: removing problematic npm install references from two documentation files as intended.
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

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (2)
docs/reference/commands.md (1)

23-24: Use active voice instead of passive constructions.

Both sentences contain passive voice:

  • Line 23: "is the primary interface" — consider "The nemoclaw CLI manages NemoClaw sandboxes" or similar active phrasing
  • Line 24: "is installed automatically by" — consider "The installer installs it automatically"

As per coding guidelines: "Active voice required. Flag passive constructions."

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/reference/commands.md` around lines 23 - 24, Rewrite the two passive
sentences to use active voice: change "The `nemoclaw` CLI is the primary
interface for managing NemoClaw sandboxes." to an active form such as "The
`nemoclaw` CLI manages NemoClaw sandboxes." and change "It is installed
automatically by the [installer](../../README.md#install)." to an active form
such as "The [installer](../../README.md#install) installs it automatically."
Ensure the text refers to the `nemoclaw` CLI and the installer link exactly as
shown so readers can find the installer documentation.
.agents/skills/docs/nemoclaw-reference/references/commands.md (1)

3-4: Use active voice instead of passive constructions.

Both sentences contain passive voice:

  • Line 3: "is the primary interface" — consider "The nemoclaw CLI manages NemoClaw sandboxes" or similar active phrasing
  • Line 4: "is installed automatically by" — consider "The installer (curl -fsSL https://www.nvidia.com/nemoclaw.sh | bash) installs it automatically"

As per coding guidelines: "Active voice required. Flag passive constructions."

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.agents/skills/docs/nemoclaw-reference/references/commands.md around lines 3
- 4, The two sentences use passive voice; change them to active voice by
rephrasing so the subject performs the action — e.g., replace "The `nemoclaw`
CLI is the primary interface for managing NemoClaw sandboxes." with an active
sentence like "The `nemoclaw` CLI manages NemoClaw sandboxes." and replace "It
is installed automatically by the installer (`curl -fsSL
https://www.nvidia.com/nemoclaw.sh | bash`)." with an active sentence like "The
installer (`curl -fsSL https://www.nvidia.com/nemoclaw.sh | bash`) installs the
`nemoclaw` CLI automatically." Ensure the term `nemoclaw` CLI and the installer
command remain in the updated lines.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.agents/skills/docs/nemoclaw-reference/references/commands.md:
- Around line 3-4: The two sentences use passive voice; change them to active
voice by rephrasing so the subject performs the action — e.g., replace "The
`nemoclaw` CLI is the primary interface for managing NemoClaw sandboxes." with
an active sentence like "The `nemoclaw` CLI manages NemoClaw sandboxes." and
replace "It is installed automatically by the installer (`curl -fsSL
https://www.nvidia.com/nemoclaw.sh | bash`)." with an active sentence like "The
installer (`curl -fsSL https://www.nvidia.com/nemoclaw.sh | bash`) installs the
`nemoclaw` CLI automatically." Ensure the term `nemoclaw` CLI and the installer
command remain in the updated lines.

In `@docs/reference/commands.md`:
- Around line 23-24: Rewrite the two passive sentences to use active voice:
change "The `nemoclaw` CLI is the primary interface for managing NemoClaw
sandboxes." to an active form such as "The `nemoclaw` CLI manages NemoClaw
sandboxes." and change "It is installed automatically by the
[installer](../../README.md#install)." to an active form such as "The
[installer](../../README.md#install) installs it automatically." Ensure the text
refers to the `nemoclaw` CLI and the installer link exactly as shown so readers
can find the installer documentation.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b211fa5c-3d01-4909-97ed-ec41fb9f3d9a

📥 Commits

Reviewing files that changed from the base of the PR and between 166319d and cebe232.

📒 Files selected for processing (2)
  • .agents/skills/docs/nemoclaw-reference/references/commands.md
  • docs/reference/commands.md

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.

Installer: placeholder npm package clobbers real NemoClaw installation

1 participant