Skip to content

docs: shorten quick-start install command to npm i -g#260

Merged
efenocchi merged 1 commit into
activeloopai:mainfrom
kaghni:readme-npm-i-g
Jun 11, 2026
Merged

docs: shorten quick-start install command to npm i -g#260
efenocchi merged 1 commit into
activeloopai:mainfrom
kaghni:readme-npm-i-g

Conversation

@kaghni

@kaghni kaghni commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Shortens the quick-start install command in the README from npm install -g to npm i -g.

The npm install in the Development section is left unchanged, since it installs local dependencies rather than the global CLI.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated Quick Start installation command to use the shorthand npm i -g instead of the full npm install -g.

@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 654e96cf-0e27-4e68-80ab-39fa543780cd

📥 Commits

Reviewing files that changed from the base of the PR and between 4388400 and 22002af.

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

📝 Walkthrough

Walkthrough

The README's Quick start installation command was updated to use the npm shorthand npm i -g instead of the full npm install -g form, reducing verbosity while maintaining identical functionality and the downstream hivemind install step.

Changes

README Installation Command Update

Layer / File(s) Summary
Quick start command shorthand
README.md
The Quick start one-liner installation command was condensed from npm install -g to the equivalent npm i -g shorthand.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

Poem

🐰 With npm's shorthand, we hop with glee,
From install to i, much shorter to see!
The hivemind's quick start now swiftly runs,
A tiny tweak done, the CLI sets sun! 🌙

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description clearly explains what was changed and why, but does not follow the required template structure with Summary, Version Bump, and Test plan sections. Add the required sections from the template: Summary (already mostly provided), Version Bump details, and Test plan checklist to ensure clarity on version bumping and testing status.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: shortening the quick-start install command from 'npm install -g' to 'npm i -g', which matches the actual modification in README.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@efenocchi efenocchi merged commit 7daf2f9 into activeloopai:main Jun 11, 2026
11 checks passed
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.

2 participants