Skip to content

Installation

Aleem Isiaka edited this page Mar 31, 2026 · 2 revisions

Installation

This guide covers all installation methods for Heimdal on different platforms.

Table of Contents


Quick Install

macOS

brew install limistah/tap/heimdal

Any Platform (with Rust)

cargo install heimdal

Universal script

curl -fsSL https://raw.githubusercontent.com/limistah/heimdal/main/install.sh | bash

macOS

Homebrew (Recommended)

brew tap limistah/tap
brew install heimdal

One-liner:

brew install limistah/tap/heimdal

Cargo

cargo install heimdal

Manual Binary Download

Apple Silicon (M1/M2/M3):

curl -L https://github.com/limistah/heimdal/releases/latest/download/heimdal-darwin-arm64.tar.gz | tar xz
sudo mv heimdal /usr/local/bin/

Intel Macs:

curl -L https://github.com/limistah/heimdal/releases/latest/download/heimdal-darwin-amd64.tar.gz | tar xz
sudo mv heimdal /usr/local/bin/

Linux

Debian/Ubuntu (APT)

One-line setup:

curl -fsSL https://raw.githubusercontent.com/limistah/heimdal/main/scripts/install-deb.sh | bash

Manual DEB package:

curl -LO https://github.com/limistah/heimdal/releases/latest/download/heimdal_amd64.deb
sudo dpkg -i heimdal_amd64.deb
sudo apt-get install -f   # fix dependencies if needed

Fedora/RHEL (DNF)

One-line setup:

curl -fsSL https://raw.githubusercontent.com/limistah/heimdal/main/scripts/install-rpm.sh | bash

Manual RPM package:

curl -LO https://github.com/limistah/heimdal/releases/latest/download/heimdal-1.x86_64.rpm
sudo dnf install ./heimdal-1.x86_64.rpm

Arch Linux (Pacman)

Heimdal is available on the AUR:

yay -S heimdal-bin
# or
paru -S heimdal-bin

Manual AUR install:

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

Alpine Linux (APK)

One-line setup:

wget -qO- https://limistah.github.io/apk-repo/setup.sh | sudo sh
sudo apk add heimdal --allow-untrusted

Manual APK package:

wget https://github.com/limistah/heimdal/releases/latest/download/heimdal-r0.apk
sudo apk add --allow-untrusted heimdal-r0.apk

Cross-Platform

Cargo (Rust)

If you have Rust installed:

cargo install heimdal

Install Rust first (if needed):

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Universal Install Script

Automatically detects your platform and installs the appropriate package:

curl -fsSL https://raw.githubusercontent.com/limistah/heimdal/main/install.sh | bash

From Source

# Install Rust if needed
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Clone and build
git clone https://github.com/limistah/heimdal.git
cd heimdal
cargo build --release

# Install
sudo cp target/release/heimdal /usr/local/bin/
# or:
cargo install --path .

Requirements: Rust 1.70+, git, standard build tools (gcc, make)

Manual Binary Download

Pre-built binaries are available at GitHub Releases:

Linux (GNU libc):

curl -L https://github.com/limistah/heimdal/releases/latest/download/heimdal-linux-amd64.tar.gz | tar xz
sudo mv heimdal /usr/local/bin/

Linux (MUSL/static — Alpine, etc.):

curl -L https://github.com/limistah/heimdal/releases/latest/download/heimdal-linux-amd64-musl.tar.gz | tar xz
sudo mv heimdal /usr/local/bin/

Verification

After installation:

heimdal --version
heimdal --help
heimdal status

Troubleshooting Installation

Command not found:

# Cargo installs
export PATH="$HOME/.cargo/bin:$PATH"
echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.bashrc

# /usr/local/bin installs
export PATH="/usr/local/bin:$PATH"

Permission denied:

chmod +x /usr/local/bin/heimdal

Missing build dependencies (from source):

Debian/Ubuntu:

sudo apt install build-essential pkg-config libssl-dev

Fedora/RHEL:

sudo dnf groupinstall "Development Tools"
sudo dnf install openssl-devel

Arch:

sudo pacman -S base-devel openssl

Next Steps

  1. Run the wizard to set up your configuration:

    heimdal wizard
  2. Read the Quick Start guide: Quick Start

  3. Explore features: Package Management | Dotfile Management | Profile System


Installed successfully? Quick Start Guide

Having issues? Troubleshooting

Clone this wiki locally