docs: add npm pack method as alternative to npm link for local development#1700
docs: add npm pack method as alternative to npm link for local development#1700Uday9909 wants to merge 1 commit into
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the README.md to replace npm unlink with npm uninstall in the revert instructions, and introduces a new section detailing how to use npm pack to install a local build via a tarball. The feedback recommends replacing the wildcard (*) in the npm install command with a <version> placeholder to prevent potential shell expansion issues on Windows and conflicts when multiple tarball files exist.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
There was a problem hiding this comment.
Pull request overview
Adds a third local-development installation option to the README by documenting a more reliable npm pack-based workflow between the existing npm link method and the note section.
Changes:
- Replaces the Method 2 “revert” command snippet to use uninstall/install.
- Adds Method 3: Using
npm packwith step-by-step instructions to pack and install a tarball into a target project. - Documents how to revert from the tarball install back to the official
@sistent/sistentpackage.
…pment Add Method 3 (Using npm pack) to the README installation section. The npm pack approach avoids peer dependency issues that npm link sometimes causes with Meshery UI. Signed-off-by: Udaybir Singh <usudaybir@gmail.com> Signed-off-by: Udaybir Singh <writetoudaybir@gmail.com>
Uday9909
force-pushed
the
feat/readme-npm-pack
branch
from
169d2a7 to
9b4fcc6
Compare
|
@leecalcote can you review this please? |
|
@KhushamBansal can you review this document fix? |
Adds a Method 3: Using
npm packto the README installation section, placed between Method 2 (npm link) and the Note section.The
npm linkapproach often fails with "Module not found" errors in Meshery UI. Thenpm packmethod works more reliably by creating a tarball and installing it as a regular npm package, avoiding peer dependency issues.New section covers:
npm packCommit:
169d2a7cBranch:
feat/readme-npm-pack(from fork @Uday9909)