Skip to main content

A seamless voice dictation system for Linux

Project description

Vocalinux

Voice-to-text for Linux, finally done right!

Status: Beta GitHub release License: GPL v3

Vocalinux CI Platform: Linux Python 3.9+ Made with GTK codecov

GitHub stars GitHub forks GitHub watchers Last commit Commit activity Contributions welcome GitHub issues

Vocalinux Users

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:

Transcription in Action
Real-time voice-to-text transcription
System Tray
System tray with listening indicator
About View
About view with version info
Log Viewer
Log viewer for debugging
Features Overview
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:

  1. whisper.cpp โญ (Recommended) - Fast, works with any GPU via Vulkan
  2. Whisper (OpenAI) - PyTorch-based, NVIDIA GPU only
  3. 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

  1. Toggle mode: Double-tap the shortcut key (default Ctrl) to start recording
  2. Speak clearly into your microphone
  3. 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 systemd unit/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

๐Ÿ”Š 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

โญ 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

Star History Chart


Made with โค๏ธ for the Linux community

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vocalinux-0.10.2b0.tar.gz (755.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vocalinux-0.10.2b0-py3-none-any.whl (389.0 kB view details)

Uploaded Python 3

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

Hashes for vocalinux-0.10.2b0.tar.gz
Algorithm Hash digest
SHA256 9f9718c62d07d377399f410bf69c1d0744e5d7bd33f40ee86f51c1ab3528c185
MD5 b4696ebea5c698ef8f462a5836fcebb9
BLAKE2b-256 01d62d03b5d2df2c58a5a2fdbbebaac5cdabc148fdf6620e787b50240696b387

See more details on using hashes here.

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

Hashes for vocalinux-0.10.2b0-py3-none-any.whl
Algorithm Hash digest
SHA256 c983d82fe1affc7dda42d73008b09561a8c7c8fbec500382b86300ee4d14d7b8
MD5 2275a7c66d9d6e1d6ab0961bc4349b4c
BLAKE2b-256 1b3510f78d30aa492a7d3b2e3fa840874446a86793ff308d8a7307de663982c8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page