Skip to content

Commit

Permalink
chore: update @hoppscotch/cli README
Browse files Browse the repository at this point in the history
  • Loading branch information
AndrewBastin committed Apr 22, 2024
1 parent d21bb65 commit 844eee0
Showing 1 changed file with 27 additions and 4 deletions.
31 changes: 27 additions & 4 deletions packages/hoppscotch-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,34 @@ hopp [options or commands] arguments
Taking the above example, `pw.env.get("ENV1")` will return `"value1"`

## Install
- Before you install Hoppscotch CLI you need to make sure you have the dependencies it requires to run.
- **Windows & macOS**: You will need `node-gyp` installed. Find instructions here: https://github.com/nodejs/node-gyp
- **Debian/Ubuntu derivatives**:
```sh
sudo apt-get install python g++ build-essential
```
- **Alpine Linux**:
```sh
sudo apk add python3 make g++
```
- **Amazon Linux (AMI)**
```sh
sudo yum install gcc72 gcc72-c++
```
- **Arch Linux**
```sh
sudo pacman -S make gcc python
```
- **RHEL/Fedora derivatives**:
```sh
sudo dnf install python3 make gcc gcc-c++ zlib-devel brotli-devel openssl-devel libuv-devel
```

Install [@hoppscotch/cli](https://www.npmjs.com/package/@hoppscotch/cli) from npm by running:
```
npm i -g @hoppscotch/cli
```

- Once the dependencies are installed, install [@hoppscotch/cli](https://www.npmjs.com/package/@hoppscotch/cli) from npm by running:
```
npm i -g @hoppscotch/cli
```

## **Developing:**

Expand Down

0 comments on commit 844eee0

Please sign in to comment.