Skip to content

Commit 1e8edd2

Browse files
authored
docs(cli): add workspace dependency build requirements to README (hoppscotch#5440)
1 parent c6c86e8 commit 1e8edd2

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

packages/hoppscotch-cli/README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -133,10 +133,17 @@ The Hoppscotch CLI follows **pre-1.0 semantic versioning** conventions while in
133133
134134
1. Clone the repository, make sure you've installed latest [pnpm](https://pnpm.io).
135135
2. `pnpm install`
136-
3. `cd packages/hoppscotch-cli`
137-
4. `pnpm run build`
138-
5. `sudo pnpm link --global`
139-
6. Test the installation by executing `hopp`
136+
3. Build required workspace dependencies (if needed):
137+
```bash
138+
# These auto-build via postinstall hooks during 'pnpm install'
139+
# Rebuild manually only when you make changes to these packages:
140+
pnpm --filter @hoppscotch/data run build
141+
pnpm --filter @hoppscotch/js-sandbox run build
142+
```
143+
4. `cd packages/hoppscotch-cli`
144+
5. `pnpm run build`
145+
6. `sudo pnpm link --global`
146+
7. Test the installation by executing `hopp`
140147

141148
## **Contributing:**
142149

@@ -162,7 +169,13 @@ Please note we have a code of conduct, please follow it in all your interactions
162169

163170
```bash
164171
pnpm install
165-
pnpm run build
172+
# Build required workspace dependencies (if needed)
173+
# These auto-build via postinstall hooks during 'pnpm install'
174+
# Rebuild manually only when you make changes to these packages:
175+
pnpm --filter @hoppscotch/data run build
176+
pnpm --filter @hoppscotch/js-sandbox run build
177+
# Then build the CLI
178+
cd packages/hoppscotch-cli && pnpm run build
166179
```
167180

168181
2. In order to test locally, you can use two types of package linking:

0 commit comments

Comments
 (0)