Quick start
Prerequisites
Section titled “Prerequisites”- Linux with systemd (Arch, Debian, Ubuntu, Fedora, openSUSE, etc.)
- Python 3.11-3.15
- Wayland or X11 session (GNOME, KDE Plasma, Sway, Hyprland, Niri, etc.).
- Clipboard/window tools:
wl-clipboardandwtypeon Waylandpython-pyperclip,xclip,xdotool, andxpropon X11 (installed by the dependency script)
- Waybar or Noctalia (optional, for status bar)
- gtk4 + PyCairo (optional, for visualizer)
- NVIDIA GPU (optional, for CUDA acceleration)
- AMD/Intel GPU / APU (optional, for Vulkan acceleration)
Install
Section titled “Install”Nix and NixOS (beta)
Section titled “Nix and NixOS (beta)”Use the Nix flake and NixOS module for a packaged Whisper.cpp CPU runtime. Nix installations use configuration and model commands instead of the interactive installer. We’d appreciate issue reports.
Arch Linux
Section titled “Arch Linux”On the AUR:
# Install for stableyay -S hyprwhspr
# Or install for bleeding edgeyay -S hyprwhspr-gitThen run the interactive setup:
hyprwhspr setupUbuntu, Debian, Fedora, openSUSE
Section titled “Ubuntu, Debian, Fedora, openSUSE”curl -fsSL https://hyprwhspr.com/install.sh | bashInstalls dependencies and the latest release, then walks you through setup.
Manual install
# Clone the repogit clone https://github.com/goodroot/hyprwhspr.gitcd hyprwhspr
# Install dependencies for your distro./scripts/install-deps.sh
# Run interactive setup./bin/hyprwhspr setupSetup: pick a backend, review your preferences and choose desktop integrations. Setup asks before changing your bar or desktop shortcuts. Backend and model downloads can take several minutes. Follow the final checks and any remaining steps before trying dictation.
Want to choose everything? Answer no to recommended settings.
For automatic backend selection and default settings:
hyprwhspr setup autoAuthentication may still ask for your password.
First use
Section titled “First use”Ensure your microphone of choice is available in audio settings!
- Log out and back in if setup asked you to
- Press
Super+Alt+Dto start dictation - beep! - Speak naturally
- Press
Super+Alt+Dagain to stop dictation - boop! - Bam! Text appears in active buffer!
Recording indicator: when enabled and its dependencies are available, supported desktops show an overlay or a status notification. Noctalia / Omarchy can match the overlay to your shell theme. See Themed visualizer for details.
Any snags, please create an issue.
Updating
Section titled “Updating”# Arch: update via your AUR helperyay -Syu hyprwhspr
# Installed with install.shhyprwhspr update
# Old git-clone installs: re-run the installer once to move to releasescurl -fsSL https://hyprwhspr.com/install.sh | bash
# Either way, setup is idempotent if you need to re-run ithyprwhspr setupManaged release rollout and recovery: installation guide.