💾 Install Qob

This document guides you through the installation of Qob.

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

Download the appropriate version for your platform from Qob 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/cl-qob/cli/master/webinstall/install.sh | sh

On Windows:

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

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

$ nix profile install nixpkgs#qob-cli

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

$ brew tap cl-qob/cli https://github.com/cl-qob/packaging
$ brew install qob-cli

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

$ sudo port install qob-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/qobsource.gpg https://raw.githubusercontent.com/cl-qob/packaging/master/debian/KEY.gpg
$ sudo curl -SsL -o /etc/apt/sources.list.d/qobsource.list https://raw.githubusercontent.com/cl-qob/packaging/master/debian/qobsource.list
$ sudo apt update --allow-insecure-repositories
$ sudo apt install qob-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 qob-cli

There’s a PKGBUILD that builds qob 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 Qob with the following one-liner:

$ choco install qob-cli

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

$ scoop bucket add cl-qob/cli https://github.com/cl-qob/packaging
$ scoop install qob-cli

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

$ winget install qob.cli

• Git
• SBCL
• Quicklisp

Alternatively, you can clone it directly from this repo

# clone the repo
$ git clone https://github.com/cl-qob/cli qob-cli

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

# build executable to `bin` folder
$ make build

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

On Linux/macOS,

export PATH="path/to/qob-cli/bin:$PATH"

On Windows,

set PATH=%PATH%;c:/path/to/qob-cli/bin

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