Skip to content

Getting Started

This section features a quick introduction on how to install and use Squiid with the default Ratatui frontend.

Installation

Squiid is available on numerous platforms and through many different package managers. Find your preferred method of installation below, or if Squiid is not available for your platform, see building or submitting a package request.

Package Manager

The easiest way to install Squiid is through your system's package manager. A comprehensive list of available versions can be found below, along with installation instructions for some operating systems.

Packaging status

Flatpak

flatpak install net.imaginaryinfinity.Squiid
Download on Flathub

Snap

snap install squiid

Get it from the Snap Store

AUR

Install Squiid with your AUR helper (e.g. paru, yay): 

paru -S squiid

Or manually: 

git clone https://aur.archlinux.org/squiid.git
cd squiid
makepkg -si

Deb

Ubuntu users have the option to manually install a deb. However, this is not recommended, and we are working on a PPA. For alternatives, see Snap or Flatpak. The deb may work on debian, however this has not been tested. It was compiled on Ubuntu 18.04, and should work on the versions above that as well. It can be downloaded here, or as an artifact on the latest pipeline.

Binary

Linux users can find the latest stable portable binary here.

MacOS Users

Homebrew

brew install squiid

Windows Users

If Windows users would like to install Squiid without the use of winget, we provide both an installer and a portable release which can be found attached to our latest release.

Winget

winget install --id=ImaginaryInfinity.Squiid -e

Manual Installation

If you would like to manually build Squiid, for example if there isn't a package for your operating system or you'd just prefer to build from source, you can follow the steps below:

  1. Clone the repository with git or download the source code at https://gitlab.com/ImaginaryInfinity/squiid-calculator/squiid.
  2. Install build requirements:
    • Install Rust for your operating system. Rustup is recommended, but you can also install Rust from the official website.
    • Install cmake for your operating system.
  3. Open a terminal (or command prompt/powershell on Windows) and navigate to the source code with the cd command.
  4. Build and install Squiid
    • To install with make - run sudo make install.
    • To install manually - run cargo build --release. The resulting binary can then be found at target/release/squiid. Copy this binary to a directory in your PATH (such as /usr/bin) or use the binary portably.
  5. To uninstall Squiid, run sudo make uninstall or manually remove the binary that you placed.

Requesting a packaged version of Squiid

If we do not provide a packaged version of Squiid for your operating system, you can start an issue to request one.