Installation
Nokkvi is Linux only and built/tested on Arch Linux (Wayland/Hyprland) with PipeWire. Three install paths:
Arch Linux (AUR) — recommended
Section titled “Arch Linux (AUR) — recommended”Two AUR packages are published. Install whichever fits — they conflict, so you can only have one at a time.
| Package | Install | What it does |
|---|---|---|
nokkvi-bin | yay -S nokkvi-bin | Downloads the prebuilt x86_64 binary from the latest GitHub release. Fastest install, recommended for most users. |
nokkvi-git | yay -S nokkvi-git | Builds from the latest main HEAD. Picks up unreleased fixes between tagged releases. Slower install (cargo build), needs a Rust toolchain. |
(Replace yay with paru or any other AUR helper if you prefer.)
Runtime dependencies (pipewire, fontconfig, alsa-lib) are pulled in automatically by pacman.
To uninstall: yay -Rns nokkvi-bin (or nokkvi-git). User config at ~/.config/nokkvi/ is left in place — remove it manually with rm -rf ~/.config/nokkvi/ if you want a full wipe.
Other Linux distros — prebuilt binary
Section titled “Other Linux distros — prebuilt binary”Grab the latest tarball from GitHub Releases. Each release ships:
nokkvi-vX.Y.Z-x86_64-unknown-linux-gnu.tar.gznokkvi-vX.Y.Z-x86_64-unknown-linux-gnu.tar.gz.sha256
Verify, extract, install:
curl -LO https://github.com/f-o-o-g-s/nokkvi/releases/download/vX.Y.Z/nokkvi-vX.Y.Z-x86_64-unknown-linux-gnu.tar.gzcurl -LO https://github.com/f-o-o-g-s/nokkvi/releases/download/vX.Y.Z/nokkvi-vX.Y.Z-x86_64-unknown-linux-gnu.tar.gz.sha256sha256sum -c nokkvi-vX.Y.Z-x86_64-unknown-linux-gnu.tar.gz.sha256tar xzf nokkvi-vX.Y.Z-x86_64-unknown-linux-gnu.tar.gzcd nokkvi-vX.Y.Z-x86_64-unknown-linux-gnu./install.shinstall.sh places per-user files (no sudo):
~/.local/bin/nokkvi— binary~/.local/share/applications/org.nokkvi.nokkvi.desktop— launcher entry~/.local/share/icons/hicolor/scalable/apps/org.nokkvi.nokkvi.svg— icon
You’ll need pipewire and fontconfig installed system-wide at runtime:
# Debian / Ubuntusudo apt install pipewire fontconfig
# Fedorasudo dnf install pipewire fontconfigThe binary requires glibc roughly matching Ubuntu 24.04’s (≥ 2.39) or newer. Modern rolling distros (Arch, Fedora, recent Ubuntu/Debian) work; very old enterprise distros may not.
Build from source
Section titled “Build from source”For contributors, AUR maintainers, or users on architectures we don’t ship binaries for.
# System dependencies (Arch)sudo pacman -S pipewire fontconfig pkg-config
# Clone and buildgit clone https://github.com/f-o-o-g-s/nokkvi.gitcd nokkvicargo build --release./install.shThe CI build pipeline produces what nokkvi-bin ships, so building locally from a tagged commit yields a functionally identical binary.
./install.sh auto-detects whether it’s running from an extracted release tarball or a source-tree build, and installs the binary from the right location either way.
For development workflow details — including the nightly rustfmt requirement and the test/clippy/format gates — see CONTRIBUTING.md in the repo.