From 1e8edd2c9c0c26f192f8a7e524df904561cb42bc Mon Sep 17 00:00:00 2001 From: Nima Akbarzadeh Date: Wed, 26 Nov 2025 15:52:40 +0100 Subject: [PATCH] docs(cli): add workspace dependency build requirements to README (#5440) --- packages/hoppscotch-cli/README.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/packages/hoppscotch-cli/README.md b/packages/hoppscotch-cli/README.md index ac7c32b3..8a36a420 100644 --- a/packages/hoppscotch-cli/README.md +++ b/packages/hoppscotch-cli/README.md @@ -133,10 +133,17 @@ The Hoppscotch CLI follows **pre-1.0 semantic versioning** conventions while in 1. Clone the repository, make sure you've installed latest [pnpm](https://pnpm.io). 2. `pnpm install` -3. `cd packages/hoppscotch-cli` -4. `pnpm run build` -5. `sudo pnpm link --global` -6. Test the installation by executing `hopp` +3. Build required workspace dependencies (if needed): + ```bash + # These auto-build via postinstall hooks during 'pnpm install' + # Rebuild manually only when you make changes to these packages: + pnpm --filter @hoppscotch/data run build + pnpm --filter @hoppscotch/js-sandbox run build + ``` +4. `cd packages/hoppscotch-cli` +5. `pnpm run build` +6. `sudo pnpm link --global` +7. Test the installation by executing `hopp` ## **Contributing:** @@ -162,7 +169,13 @@ Please note we have a code of conduct, please follow it in all your interactions ```bash pnpm install - pnpm run build + # Build required workspace dependencies (if needed) + # These auto-build via postinstall hooks during 'pnpm install' + # Rebuild manually only when you make changes to these packages: + pnpm --filter @hoppscotch/data run build + pnpm --filter @hoppscotch/js-sandbox run build + # Then build the CLI + cd packages/hoppscotch-cli && pnpm run build ``` 2. In order to test locally, you can use two types of package linking: