From 9b4fcc6857660207e267b6227b2f8984b995ef52 Mon Sep 17 00:00:00 2001 From: Udaybir Singh Date: Thu, 9 Jul 2026 21:58:42 +0530 Subject: [PATCH] docs: add npm pack method as alternative to npm link for local development 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 Signed-off-by: Udaybir Singh --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 44 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cc740d327..ce94e85a9 100644 --- a/README.md +++ b/README.md @@ -181,10 +181,52 @@ ls -l node_modules/@sistent/sistent # node_modules/@sistent/sistent -> ../../../../../sistent ``` -To revert back to the official package, first unlink the package, then install the official package using the following commands: +To revert back to the official package, first uninstall the package, then install the official package using the following commands: ``` -npm unlink @sistent/sistent +npm uninstall @sistent/sistent +npm install @sistent/sistent +``` + +#### Method 3: Using `npm pack` + +This method creates a tarball of your local Sistent build and installs it like a regular npm package. It avoids the peer dependency issues that `npm link` sometimes causes. + +1. Build your local Sistent fork + +``` +cd + +make build +``` + +2. Create a tarball + +``` +npm pack +``` + +This creates a `.tgz` file (e.g., `sistent-sistent-.tgz`) in the Sistent directory. + +3. Install the tarball in your project + +``` +cd + +npm install /sistent-sistent-.tgz +``` + +4. Run the build command in your project + +``` +# example, Meshery UI +make ui-build +``` + +To revert back to the official package: + +``` +npm uninstall @sistent/sistent npm install @sistent/sistent ```