💾 Install Eask

This document guides you through the installation of Eask.

Install Eask on macOS, Linux, Windows, BSD, and on any machine that can run the Node.js.

Download the appropriate version for your platform from Eask Releases. Once downloaded, the binary can be run from anywhere. You don’t need to install it in a global location. This works well for shared hosts and other systems where you don’t have a privileged account.

Ideally, you should install it somewhere in your PATH for easy use. /usr/local/bin is the most probable location.

On macOS or Linux:

$ curl -fsSL https://raw.githubusercontent.com/emacs-eask/cli/master/webinstall/install.sh | sh

On Windows:

$ curl.exe -fsSL https://raw.githubusercontent.com/emacs-eask/cli/master/webinstall/install.bat | cmd /Q

If you have npm installed on your machine, you can install Eask with the following one-liner:

$ npm install -g @emacs-eask/cli

Homebrew is a free and open-source package manager for macOS and Linux. To install the Eask CLI:

$ brew tap emacs-eask/cli https://github.com/emacs-eask/packaging
$ brew install eask-cli

MacPorts is a free and open-source package manager for macOS. To install the Eask CLI:

$ sudo port install eask-cli

Derivatives of the Debian distribution of Linux include elementary OS, KDE neon, Linux Lite, Linux Mint, MX Linux, Pop!_OS, Ubuntu, Zorin OS, and others.

$ sudo curl -SsL -o /etc/apt/trusted.gpg.d/easksource.gpg https://raw.githubusercontent.com/emacs-eask/packaging/master/debian/KEY.gpg
$ sudo curl -SsL -o /etc/apt/sources.list.d/easksource.list https://raw.githubusercontent.com/emacs-eask/packaging/master/debian/easksource.list
$ sudo apt update --allow-insecure-repositories
$ sudo apt install eask-cli --allow-unauthenticated

You can also download Debian packages from the packaging repo.

Snap is a free and open-source package manager for Linux. Available for most distributions, snap packages are simple to install and are automatically updated.

$ sudo snap install eask-cli

There’s a PKGBUILD that builds eask from sources and creates a package, so inside the top directory of the repository you can simply run:

$ makepkg -i

If you have Chocolatey installed on your machine, you can install Eask with the following one-liner:

$ choco install eask-cli

Scoop is a free and open-source package manager for Windows. To install the Eask CLI:

$ scoop bucket add emacs-eask/cli https://github.com/emacs-eask/packaging
$ scoop install eask-cli

Winget is Microsoft’s official free and open-source package manager for Windows. To install the Eask CLI:

$ winget install eask.cli

• Git
• Node.js
• npm

Alternatively, you can clone it directly from this repo

# clone the repo
$ git clone https://github.com/emacs-eask/cli eask-cli

# change the working directory to eask-cli
$ cd eask-cli

# install the requirements
$ npm install

You can now run eask using the script bin/eask; add /path/to/eask-cli/bin/ to your environment PATH to execute eask from any location!

On Linux/macOS,

export PATH="path/to/eask/bin:$PATH"

On Windows,

set PATH=%PATH%;c:/path/to/eask/bin

Once you have set it up correctly, try eask --version then you should see the current eask’s version number! 🎉 🎊

To run eask through executable, you will need pkg installed on your machine.

# install it locally in the workspace scope
$ npm install --dev

# or

# install it globally
$ npm install -g pkg

Subsequently, run the following command to build the executable. By default, it will generate an executable in the dist folder.

# build from sources. For available targets see `scripts` in `package.json`
$ npm run pkg-linux-x64

# move `lisp` to `dist` folder
mv lisp dist

You can now run eask using the executable dist/eask; add /path/to/eask-cli/dist/ to your environment PATH to execute eask from any location! 🎉 🎊