Skip to main content
Complete installation guide for all supported Linux distributions.

System requirements

  • OS: Linux with glibc 2.35+ (Ubuntu 24.04+, Fedora 39+, Arch, Debian Trixie+)
  • Desktop: Wayland or X11
  • Audio: PipeWire or PulseAudio
  • CPU: x86_64 with AVX2 support
  • RAM: 1 GB available
  • Disk: 500 MB for base.en model
Voxtype requires glibc 2.35 or newer. Older distributions (Ubuntu 22.04, Debian Bullseye) are not supported.

Package installation

AUR packages

Two packages are available:voxtype - Build from source (recommended)
yay -S voxtype
voxtype-bin - Prebuilt binary
yay -S voxtype-bin
The AUR packages include:
  • Systemd service file
  • Shell completions (bash, zsh, fish)
  • Man pages
  • Configuration examples

Post-installation

Enable and start the service:
systemctl --user enable --now voxtype

Build from source

Building from source gives you the most control and latest features.

Prerequisites

sudo dnf install rust cargo alsa-lib-devel

Build steps

# Clone repository
git clone https://github.com/peteonrails/voxtype.git
cd voxtype

# Build release binary
cargo build --release

# Binary is at: target/release/voxtype

Build with GPU acceleration

cargo build --release --features gpu-vulkan
Supports AMD, NVIDIA, and Intel GPUs.

Install binary

# Install to /usr/local/bin
sudo install -m 755 target/release/voxtype /usr/local/bin/

# Verify installation
voxtype --version

Runtime dependencies

Voxtype requires a text input driver and clipboard utility.

Text input drivers

Install at least one:

Clipboard utilities

For clipboard fallback and paste mode:
# Fedora
sudo dnf install wl-clipboard

# Arch
sudo pacman -S wl-clipboard

# Ubuntu
sudo apt install wl-clipboard

Audio system

One of these should already be installed:
  • PipeWire (recommended, modern)
  • PulseAudio (older systems)
Verify:
pactl info  # Should show server info

Permissions

No special permissions needed. Just configure your compositor and disable the built-in hotkey:
# ~/.config/voxtype/config.toml
[hotkey]
enabled = false

Built-in hotkey (evdev)

If using the built-in hotkey on X11 or as a fallback:
# Add yourself to input group
sudo usermod -aG input $USER

# Log out and back in for changes to take effect
Then verify:
groups  # Should list 'input'

Download models

Voxtype needs a transcription model to work.

Default model

# Download base.en (142 MB)
voxtype setup --download

Specific model

# Download a specific model
voxtype setup --download --model large-v3-turbo

# Interactive selection
voxtype setup model

Available models

ModelSizeLanguagesBest for
tiny.en39 MBEnglishTesting, low resources
base.en142 MBEnglishGeneral use
small.en466 MBEnglishBetter accuracy
medium.en1.5 GBEnglishHigh accuracy
large-v33 GB99 languagesMultilingual
large-v3-turbo1.6 GB99 languagesFast + accurate (GPU)
Models are stored in ~/.local/share/voxtype/.

Verify installation

Run the setup check:
voxtype setup
Expected output:
Checking system configuration...

✓ Voxtype binary found
✓ Model found: base.en
✓ Audio system: PipeWire
✓ Text output: wtype (Wayland)
✓ Clipboard: wl-copy

All checks passed! Ready to use voxtype.

Configure compositor

See the Quick Start guide for compositor-specific keybinding setup.

Optional: Systemd service

Run Voxtype as a systemd user service to start automatically:
# Install service file
voxtype setup systemd

# Enable and start
systemctl --user enable --now voxtype

# Check status
systemctl --user status voxtype

# View logs
journalctl --user -u voxtype -f
The service uses your config from ~/.config/voxtype/config.toml.

Optional: Waybar integration

Add status bar integration:
# Show configuration
voxtype setup waybar

# Auto-install to ~/.config/waybar/
voxtype setup waybar --install
See Integrations for full Waybar setup.

Upgrade

yay -Syu voxtype

Uninstall

yay -R voxtype

Next steps

Quick start

Configure and test your installation

Basic usage

Learn push-to-talk controls

GPU acceleration

Enable GPU for faster transcription

Troubleshooting

Fix common installation issues

Build docs developers (and LLMs) love