Installing Halloy

Pre-built binaries

Download pre-built binaries from GitHub page.

Packaging status

macOS

The following third party repositories are available for macOS

Homebrew

brew install --cask halloy

MacPorts

sudo port install halloy

Linux

The following third party repositories are available for Linux

Flatpak

https://flathub.org/apps/org.squidowl.halloy

Snapcraft

https://snapcraft.io/halloy

Manually from release builds

Download the .tar.gz file for the latest release. The .tar.gz release has files and folders in it that match the the XDG Desktop Entry Specification, which is how many Linux desktop environments store applications. We will use /usr/local as the extraction for our examples since it is widely supported, but you can extract the files wherever you prefer (e.g. /opt, ~/.local/, etc). To extract into /usr/local you'll likely need to be root, or use sudo/doas/etc:

sudo tar -xf halloy-*-x86_64-linux.tar.gz -C /usr/local

You may have to update your local application and icon database so Halloy becomes discoverable:

sudo update-desktop-database /usr/local/share/applications
sudo gtk-update-icon-cache -t /usr/local/share/icons/hicolor/

Windows

Winget

winget install squidowl.halloy

Command-line options for the GitHub Windows installer (.exe) are documented in the Command Line guide.

Build from source

Clone the Halloy GitHub repository into a directory of your choice and build with cargo.

Requirements:

• Rust toolchain
• Git version control system
• Packages:
  • Fedora-based distributions: alsa-lib-devel openssl-devel libxcb-devel
  • Debian-based distributions: librust-alsa-sys-dev libssl-dev libxcb1-dev

# Clone the repository
git clone https://github.com/squidowl/halloy.git

cd halloy

# Build and run
cargo build --release
cargo run --release

Install from Source

The script install-linux.sh in the scripts directory of the Halloy repository will build and install Halloy on Linux systems (with the same requirements as building from source). By default the script will install Halloy in the ~/.local/ base directory (i.e. the executable will be put in ~/.local/bin/). To change the installation base directory, provide install-linux.sh with the long flag .

git clone https://github.com/squidowl/halloy.git

cd halloy

./scripts/install-linux.sh --prefix=<base/directory>