A seamless voice dictation system for Linux
Project description
Vocalinux
Voice-to-text for Linux, finally done right!
Linux has always punched above its weight, except when it comes to voice typing. Vocalinux fixes that.
It's a free, GPLv3-licensed desktop app that lets you dictate text into any application, on X11 or Wayland, using fully offline speech recognition. Pick from three engines (whisper.cpp, OpenAI Whisper, or VOSK), get automatic GPU acceleration via Vulkan, and control it all with customizable keyboard shortcuts: toggle or push-to-talk.
No internet required. No data leaves your machine. Just speak and type.
๐ What's New in v0.10.2-beta
๐ Release: non-ASCII text injection, IBus Wayland detection fixes, Pop!_OS dependency support, and code quality improvements.
๐ Highlights (v0.10.1 โ v0.10.2)
| Feature | Description |
|---|---|
| ๐ Non-ASCII Text Injection | ydotool now falls back to clipboard paste for non-ASCII characters (รก, รฉ, รฑ, etc.) |
| ๐ IBus on Wayland | IBus now detected and started correctly on Wayland without legacy env vars |
| ๐ IBus Engine Startup | Engine process now starts before registration check โ fixes startup on some systems |
| ๐ฆ Pop!_OS / Ubuntu 24.04+ | Added missing system dependencies (cmake, libcairo2-dev, libgirepository1.0-dev) |
| โก Code Quality | Systematic refactor across 20 quality dimensions |
| ๐ผ๏ธ Website OG Image | Redesigned Open Graph image โ cleaner and more professional |
โจ Scope
- Patch release focused on compatibility - IBus/Wayland improvements, non-ASCII text injection, and distro support
- Broader platform coverage - Pop!_OS, Ubuntu 24.04+, Wayland IBus users
- Code quality - Systematic refactor across 20 dimensions for long-term maintainability
๐ Bug Fixes (v0.10.2)
- #362 / #376: Handle non-ASCII characters with ydotool via clipboard paste fallback
- #360 / #361: Start IBus engine process before checking registration
- #381: Detect IBus on Wayland without legacy env vars and fix text injection
- #379: Add missing dependencies for Pop!_OS and Ubuntu 24.04+
๐ง Improvements
- Code quality - Systematic refactor across 20 quality dimensions (#377)
- Debian support - Clarify missing GNOME AppIndicator support messaging (#385)
- Website - Redesigned OG image for vocalinux.com (#392)
- Tests - Additional coverage for tray, IBus, and notification edge cases
โจ Features
- ๐ค Toggle or Push-to-Talk activation modes
- โก Real-time transcription with minimal latency
- ๐ Universal compatibility across all Linux applications
- ๐ 100% Offline operation for privacy and reliability
- ๐ค whisper.cpp by default - High-performance C++ speech recognition
- ๐ฎ Universal GPU support - Vulkan acceleration for AMD, Intel, and NVIDIA
- ๐จ System tray integration with visual status indicators
- ๐ Start on login support via XDG autostart (desktop-session startup)
- ๐ Pleasant audio feedback - smooth gliding tones, headphone-friendly
- โ๏ธ Graphical settings dialog for easy configuration
- ๐ฆ 3 engine choices - whisper.cpp (default), OpenAI Whisper, or VOSK
๐ธ Screenshots
Here are some screenshots showcasing Vocalinux in action:
|
Real-time voice-to-text transcription |
System tray with listening indicator |
|
About view with version info |
Log viewer for debugging |
|
Overview of key features and configuration options with annotations |
|
๐ Quick Install
Interactive Install (Recommended)
Our new interactive installer guides you through setup with intelligent hardware detection:
curl -fsSL raw.githubusercontent.com/jatinkrmalik/vocalinux/main/install.sh -o /tmp/vl.sh && bash /tmp/vl.sh
Choose your engine:
- whisper.cpp โญ (Recommended) - Fast, works with any GPU via Vulkan
- Whisper (OpenAI) - PyTorch-based, NVIDIA GPU only
- VOSK - Lightweight, works on older systems
The installer will:
- Auto-detect your hardware (GPU, RAM, Vulkan support)
- Recommend the best engine for your system
- Download the appropriate model (~39MB for whisper.cpp tiny)
- Install in ~1-2 minutes (vs 5-10 min with old Whisper)
Note: Always installs the latest release. For a specific version, check GitHub Releases.
Installation Options
Default (whisper.cpp - recommended):
curl -fsSL raw.githubusercontent.com/jatinkrmalik/vocalinux/main/install.sh -o /tmp/vl.sh && bash /tmp/vl.sh
Fastest installation (~1-2 min), universal GPU support via Vulkan.
Whisper (OpenAI) - if you prefer PyTorch:
curl -fsSL raw.githubusercontent.com/jatinkrmalik/vocalinux/main/install.sh -o /tmp/vl.sh && bash /tmp/vl.sh --engine=whisper
NVIDIA GPU only (~5-10 min, downloads PyTorch + CUDA).
VOSK only - for low-RAM systems:
curl -fsSL raw.githubusercontent.com/jatinkrmalik/vocalinux/main/install.sh -o /tmp/vl.sh && bash /tmp/vl.sh --engine=vosk
Lightweight option (~40MB), works on systems with 4GB RAM.
Alternative: Install from Source
# Clone the repository
git clone https://github.com/jatinkrmalik/vocalinux.git
cd vocalinux
# Run the installer (will prompt for Whisper)
./install.sh
# Or with Whisper support
./install.sh --with-whisper
The installer handles everything: system dependencies, Python environment, speech models, and desktop integration.
๐ Nightly Releases (Bleeding Edge)
For developers and early adopters who want to test the latest features, check out our GitHub Releases page which includes both beta and nightly builds.
โ ๏ธ Warning: Nightly releases contain the absolute latest code and may be unstable. For production use, we recommend using the latest beta release.
Nightly builds are automatically generated from the main branch every day. They include all merged changes but haven't undergone the same testing as beta releases.
Release Channels:
- Beta (Recommended) - Tested pre-releases with known features
- Nightly - Untested bleeding edge with latest commits
After Installation
# If ~/.local/bin is in your PATH (recommended):
vocalinux
# Or activate the virtual environment first:
source ~/.local/bin/activate-vocalinux.sh
vocalinux
# Or run directly:
~/.local/share/vocalinux/venv/bin/vocalinux
Or launch it from your application menu!
๐ Requirements
- OS: Linux (tested on Ubuntu 22.04+, Debian 11+, Fedora 39+, Arch Linux, openSUSE Tumbleweed)
- Python: 3.9 or newer
- Display: X11 or Wayland
- Hardware: Microphone for voice input
Note: See Distribution Compatibility for distribution-specific information and experimental support for Gentoo, Alpine, Void, Solus, and more.
๐๏ธ Usage
Voice Dictation
- Toggle mode: Double-tap the shortcut key (default Ctrl) to start recording
- Speak clearly into your microphone
- Toggle mode: Double-tap again (or pause speaking) to stop, or Push-to-Talk mode: release the key to stop
Voice Commands
| Command | Action |
|---|---|
| "new line" | Inserts a line break |
| "period" / "full stop" | Types a period (.) |
| "comma" | Types a comma (,) |
| "question mark" | Types a question mark (?) |
| "exclamation mark" | Types an exclamation mark (!) |
| "delete that" | Deletes the last sentence |
| "capitalize" | Capitalizes the next word |
Command Line Options
vocalinux --help # Show all options
vocalinux --debug # Enable debug logging
vocalinux --engine whisper_cpp # Use whisper.cpp engine (default)
vocalinux --engine whisper # Use OpenAI Whisper engine
vocalinux --engine vosk # Use VOSK engine
vocalinux --model medium # Use medium-sized model
vocalinux --wayland # Force Wayland mode
vocalinux --start-minimized # Start without first-run modal prompts
Autostart on Login
Vocalinux uses the Linux desktop standard for autostart:
- Mechanism: XDG autostart desktop entry (
vocalinux.desktop) - Path:
$XDG_CONFIG_HOME/autostart/or~/.config/autostart/(fallback) - Launch mode: Starts as a regular user desktop app in your graphical session
- Not used: No
systemdunit/service is created by Vocalinux for autostart
How to enable/disable:
- First-run welcome dialog
- Tray menu: Start on Login
- Settings dialog: Start on Login
Compatibility notes:
- Works on mainstream desktop environments (GNOME, KDE, Xfce, Cinnamon, MATE, LXQt)
- On minimal/custom window-manager sessions, an autostart handler may be required
(for example DE-specific startup hooks or tools like
dex)
โ๏ธ Configuration
Configuration is stored in ~/.config/vocalinux/config.json:
{
"speech_recognition": {
"engine": "whisper_cpp",
"model_size": "tiny",
"vad_sensitivity": 3,
"silence_timeout": 2.0
}
}
You can also configure settings through the graphical Settings dialog (right-click the tray icon).
๐ง Development Setup
# Clone and install in dev mode
git clone https://github.com/jatinkrmalik/vocalinux.git
cd vocalinux
./install.sh --dev
# Activate environment
source venv/bin/activate
# Run tests
pytest
# Run from source with debug
python -m vocalinux.main --debug
๐ Project Structure
vocalinux/
โโโ src/vocalinux/ # Main application code
โ โโโ speech_recognition/ # Speech recognition engines (VOSK, Whisper, whisper.cpp)
โ โ โโโ recognition_manager.py # Unified engine interface
โ โโโ text_injection/ # Text injection (X11/Wayland)
โ โโโ ui/ # GTK UI components
โ โโโ utils/ # Utility functions
โ โโโ whispercpp_model_info.py # whisper.cpp model metadata & hardware detection
โ โโโ vosk_model_info.py # VOSK model metadata
โโโ tests/ # Test suite
โโโ scripts/ # Development utilities
โ โโโ generate_sounds.py # Sound generation script
โโโ resources/ # Icons and sounds
โโโ docs/ # Documentation
โโโ web/ # Website source
๐ Documentation
- Installation Guide - Detailed installation instructions
- Update Guide - How to update Vocalinux
- User Guide - Complete user documentation
- Distribution Compatibility - Distro/session behavior and caveats
- Contributing - Development setup and contribution guidelines
๐ Sound Customization
Vocalinux uses smooth, pleasant gliding tones for audio feedback:
- Start: Ascending F4โA4 (0.6s) - positive, uplifting
- Stop: Descending A4โF4 (0.6s) - resolves completion
- Error: Lower descending E4โC4 (0.7s) - gentle but noticeable
All sounds use pure sine waves with smoothstep interpolation for buttery smooth pitch transitions - perfect for headphone use!
Regenerate Sounds
To modify or regenerate the notification sounds:
python scripts/generate_sounds.py
This script generates all three sounds using the same smooth glide algorithm. You can edit the frequencies, durations, and amplitudes in the script to customize the sounds to your preference.
๐บ๏ธ Roadmap
-
Custom icon designโ -
Graphical settings dialogโ -
Whisper AI supportโ -
Multi-language support (FR, DE, RU)โ -
whisper.cpp integration (default engine)โ -
Vulkan GPU supportโ - In-app update mechanism
- Application-specific commands
- Debian/Ubuntu package (.deb)
-
Wayland support via IBusโ - Voice command customization
๐ The Voca Ecosystem
Vocalinux is part of a family of privacy-first, offline voice dictation tools. Same mission, every operating system.
| Platform | Project | Website | GitHub | Status |
|---|---|---|---|---|
| ๐ง Linux | VocaLinux | vocalinux.com | jatinkrmalik/vocalinux | โ Beta v0.10.2 |
| ๐ macOS | VocaMac | vocamac.com | jatinkrmalik/vocamac | ๐ Beta |
| ๐ช Windows | VocaWin | vocawin.com | jatinkrmalik/vocawin | ๐ Planned |
Each platform uses native technologies for the best possible integration, while sharing the same privacy-first philosophy and offline-only architecture.
๐ค Contributing
We welcome contributions! Whether it's bug reports, feature requests, or code contributions, please check out our Contributing Guide.
Contributors
Thanks to everyone who has contributed to Vocalinux! ๐
Quick Links
- ๐ Report a Bug
- ๐ก Request a Feature
- ๐ฌ Discussions
โญ Support
If you find Vocalinux useful, please consider:
- โญ Starring this repository
- ๐ Reporting bugs you encounter
- ๐ Improving documentation
- ๐ Contributing code
๐ License
This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.
Star Chart
Made with โค๏ธ for the Linux community
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vocalinux-0.10.2b0.tar.gz.
File metadata
- Download URL: vocalinux-0.10.2b0.tar.gz
- Upload date:
- Size: 755.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9f9718c62d07d377399f410bf69c1d0744e5d7bd33f40ee86f51c1ab3528c185
|
|
| MD5 |
b4696ebea5c698ef8f462a5836fcebb9
|
|
| BLAKE2b-256 |
01d62d03b5d2df2c58a5a2fdbbebaac5cdabc148fdf6620e787b50240696b387
|
File details
Details for the file vocalinux-0.10.2b0-py3-none-any.whl.
File metadata
- Download URL: vocalinux-0.10.2b0-py3-none-any.whl
- Upload date:
- Size: 389.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c983d82fe1affc7dda42d73008b09561a8c7c8fbec500382b86300ee4d14d7b8
|
|
| MD5 |
2275a7c66d9d6e1d6ab0961bc4349b4c
|
|
| BLAKE2b-256 |
1b3510f78d30aa492a7d3b2e3fa840874446a86793ff308d8a7307de663982c8
|