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.8+ Made with GTK codecov

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

Vocalinux Users

A seamless free open-source private voice dictation system for Linux, comparable to built-in solutions on macOS and Windows.

๐Ÿ“š What's New in v0.7.0-beta

๐ŸŽ‰ Major Release: Autostart, Tabbed Settings & Intel GPU Support! โ€” The most feature-rich Vocalinux release yet.

๐Ÿš€ Highlights (v0.6.3 โ†’ v0.7.0)

Feature Description
๐Ÿ–ฅ๏ธ Autostart Support Launch Vocalinux automatically on desktop session startup
โš™๏ธ Tabbed Settings Completely redesigned settings dialog with organized tabs
๐ŸŽฎ Intel GPU Detection Automatically detects incompatible Intel GPUs and falls back to CPU
๐Ÿ”’ Single Instance Prevents multiple Vocalinux instances from running simultaneously

โœจ New Features (v0.7.0)

  • Autostart on Login โ€” Added XDG autostart support via settings dialog and system tray
  • Tabbed Settings Dialog โ€” reorganized settings into Speech Engine, Recognition, Text Injection, Audio Feedback, and General tabs
  • Intel GPU Compatibility Detection โ€” Detects incompatible Intel GPUs and automatically falls back to CPU processing
  • Multiple Instance Prevention โ€” Shows notification and exits if Vocalinux is already running
  • Evdev Device Management โ€” Automatically removes disconnected input devices to prevent CPU spin

๐Ÿ› Bug Fixes (v0.7.0)

  • #254: Improved GPU detection to avoid false positives on systems without dev libraries
  • #251: Skip IBus setup when daemon is not running, enable fallback to other methods
  • #243: Prevent dnf check-update from exiting script on Fedora
  • #240: Raise exception on IBus setup failure to enable automatic fallback
  • #234: Removed leading space from first speech transcription
  • #242/#253: Removed disconnected evdev devices to prevent CPU spin

๐Ÿ”ง Recent Improvements

  • Web SEO Enhancements โ€” Added 7 new optimized pages for organic traffic
  • Mobile Responsiveness โ€” Improved mobile and tablet layout for the website
  • Better Fedora Support โ€” Fixed dnf check-update behavior
  • Improved Device Handling โ€” More robust handling of input device connections/disconnections

โœจ Features

  • ๐ŸŽค Double-tap Ctrl to start/stop voice dictation
  • โšก 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/v0.7.0-beta/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: Installs v0.7.0-beta. For other versions, check GitHub Releases.

Installation Options

Default (whisper.cpp - recommended):

curl -fsSL raw.githubusercontent.com/jatinkrmalik/vocalinux/v0.7.0-beta/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/v0.7.0-beta/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/v0.7.0-beta/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.8 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. Double-tap Ctrl to start recording
  2. Speak clearly into your microphone
  3. Double-tap Ctrl again (or pause speaking) 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

๐Ÿค Contributing

We welcome contributions! Whether it's bug reports, feature requests, or code contributions, please check out our Contributing Guide.

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.


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.7.0b0.tar.gz (417.6 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.7.0b0-py3-none-any.whl (486.3 kB view details)

Uploaded Python 3

File details

Details for the file vocalinux-0.7.0b0.tar.gz.

File metadata

  • Download URL: vocalinux-0.7.0b0.tar.gz
  • Upload date:
  • Size: 417.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for vocalinux-0.7.0b0.tar.gz
Algorithm Hash digest
SHA256 48f43d3c78798a16a9c437ec036f15817e5068803a1eed2969cd60641c0f841d
MD5 0d1cfd526a34db1fb387e01b8e398806
BLAKE2b-256 ada2575a6145aa5115f44ed4b02fdafde7a6ae9de946fb1b2be214b5a4ec4005

See more details on using hashes here.

File details

Details for the file vocalinux-0.7.0b0-py3-none-any.whl.

File metadata

  • Download URL: vocalinux-0.7.0b0-py3-none-any.whl
  • Upload date:
  • Size: 486.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for vocalinux-0.7.0b0-py3-none-any.whl
Algorithm Hash digest
SHA256 dc2f9b2f7b89364476375101970ecadad1996a94da62d8f49a5f394012cc5534
MD5 6520a99f31f3e18064094a0744c7db34
BLAKE2b-256 110c9719230a0daef1eb6cf442bdcfb9631e632aea6cbf4787eb3f4dd07464ad

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