fix(docs): remove bare npm install that installs placeholder package#761
fix(docs): remove bare npm install that installs placeholder package#761north-echo wants to merge 1 commit intoNVIDIA:mainfrom
Conversation
…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>
📝 WalkthroughWalkthroughDocumentation updates to two command reference files clarifying that the 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 |
There was a problem hiding this comment.
🧹 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
nemoclawCLI 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
nemoclawCLI 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
📒 Files selected for processing (2)
.agents/skills/docs/nemoclaw-reference/references/commands.mddocs/reference/commands.md
|
Thanks for submitting this PR, it improves the documentation by removing a confusing install command, which could improve the user experience for new users and make it easier to get started with the NemoClaw project. |
…A#506) The npmjs.org `nemoclaw` package (0.1.0) is a broken 249-byte placeholder that clobbers the real CLI. This commit: - Removes the bare `npm install -g nemoclaw` reference from docs - Adds `is_real_nemoclaw_cli()` behavioural check (mirrors PR NVIDIA#970 isOpenshellCLI pattern) — verifies `nemoclaw --version` outputs `nemoclaw v<semver>` - Adds `remove_broken_nemoclaw()` to auto-detect and uninstall any globally installed nemoclaw that fails the behavioural check - Updates `verify_nemoclaw()` to validate every candidate binary - Adds test for placeholder detection and updates all existing fake nemoclaw stubs to output the correct version format Supersedes NVIDIA#761. Fixes NVIDIA#506. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…A#506) The npmjs.org `nemoclaw` package (0.1.0) is a broken 249-byte placeholder that clobbers the real CLI. This commit: - Removes the bare `npm install -g nemoclaw` reference from docs - Adds `is_real_nemoclaw_cli()` behavioural check (mirrors PR NVIDIA#970 isOpenshellCLI pattern) — verifies `nemoclaw --version` outputs `nemoclaw v<semver>` - Adds `remove_broken_nemoclaw()` to auto-detect and uninstall any globally installed nemoclaw that fails the behavioural check - Updates `verify_nemoclaw()` to validate every candidate binary - Adds test for placeholder detection and updates all existing fake nemoclaw stubs to output the correct version format Supersedes NVIDIA#761. Fixes NVIDIA#506. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
## Summary - Remove bare `npm install -g nemoclaw` from docs — it points to a broken 249-byte placeholder on npmjs.org that only contains package.json - Add `is_real_nemoclaw_cli()` behavioural validation to `verify_nemoclaw()` — runs `nemoclaw --version` and verifies the output matches `nemoclaw v<semver>` (mirrors the `isOpenshellCLI()` pattern from PR #970) - Update `verify_nemoclaw()` to validate every candidate binary before accepting it, and auto-uninstall if the binary fails the check Supersedes #761 (docs-only fix, now stale with merge conflicts). Fixes #506 Relates to #737, #967 ## Test plan Updated all existing fake nemoclaw stubs to output `nemoclaw v<version>` format so they pass `is_real_nemoclaw_cli()`. Existing test `prints the HTTPS GitHub remediation when the binary is missing` still asserts bare `npm install -g nemoclaw` never appears in output. Signed-off-by: Dongni Yang <dongniy@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated CLI installation docs to show the shell-script installer (curl ... | bash) as the recommended method instead of npm global install. * **Bug Fixes** * Improved installer checks to verify the CLI binary is genuine and functional. * Added clearer recovery steps and warnings for broken or missing installations to reduce installation failures. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Dongni Yang <dongniy@nvidia.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Thank you for catching this @north-echo! Closing as superseded — the |
…A#1606) ## Summary - Remove bare `npm install -g nemoclaw` from docs — it points to a broken 249-byte placeholder on npmjs.org that only contains package.json - Add `is_real_nemoclaw_cli()` behavioural validation to `verify_nemoclaw()` — runs `nemoclaw --version` and verifies the output matches `nemoclaw v<semver>` (mirrors the `isOpenshellCLI()` pattern from PR NVIDIA#970) - Update `verify_nemoclaw()` to validate every candidate binary before accepting it, and auto-uninstall if the binary fails the check Supersedes NVIDIA#761 (docs-only fix, now stale with merge conflicts). Fixes NVIDIA#506 Relates to NVIDIA#737, NVIDIA#967 ## Test plan Updated all existing fake nemoclaw stubs to output `nemoclaw v<version>` format so they pass `is_real_nemoclaw_cli()`. Existing test `prints the HTTPS GitHub remediation when the binary is missing` still asserts bare `npm install -g nemoclaw` never appears in output. Signed-off-by: Dongni Yang <dongniy@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated CLI installation docs to show the shell-script installer (curl ... | bash) as the recommended method instead of npm global install. * **Bug Fixes** * Improved installer checks to verify the CLI binary is genuine and functional. * Added clearer recovery steps and warnings for broken or missing installations to reduce installation failures. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Dongni Yang <dongniy@nvidia.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Summary
npm install -g nemoclawfrom docs, which resolves to a placeholder 0.1.0 package on npmjs.org and clobbers the real CLI installed from GitHub sourcedocs/reference/commands.mdand the agent skills reference copyContext
The installer scripts (
scripts/install.sh,install.sh) correctly usenpm 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 barenpm install -g nemoclaw, which pulls the placeholder from npmjs.org.Fixes #737
Test plan
vitest run test/install-preflight.test.js— 11/11 passingnpm install -g nemoclawCo-Authored-By: Claude noreply@anthropic.com
Summary by CodeRabbit