installation

Installation

Holesail is currently available as a npm package or can be run from the source. Installing and using holesail is pretty simple.

We will soon distribute holesail as a binary but at the moment using it from npm or building from the source is the only solution.

Make sure you have node version >= v16.20.2, you can install and switch between node versions using Node version manager on Linux and Mac.

You need to install holesail as a global package to use it from anywhere in the terminal/cmd.

npm i holesail -g

Installing global packages on Linux requires sudo privileges:

sudo npm i holesail -g

You can then verify if the installation was successful using:

holesail --help

You can run holesail from its source on GitHub. The process is straightforward and similar to other Node.js packages.

git clone https://github.com/holesail/holesail.git && cd holesail

Install the dependencies:

npm install

Finally, run the package:

node index.js

You can pass arguments directly to index.js, such as --help