thibaud-lclr/api-client
1
0
Fork 0
Code Packages Activity Actions

docs(cli): add workspace dependency build requirements to README (#5440)

Browse source
This commit is contained in:
Nima Akbarzadeh 2025-11-26 15:52:40 +01:00 committed by GitHub
parent c6c86e8db2
commit 1e8edd2c9c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 18 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
packages/hoppscotch-cli/README.md
View file

@ -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: