The suse case in install_system_dependencies() previously installed all
packages blindly, causing the entire install to fail if a single package
was unavailable (e.g., glslang on some openSUSE repos).
Changes:
- Check each package individually with rpm -q before installing
- Add graceful fallback for glslang -> glslang-devel
- Add graceful fallback for libappindicator-gtk3 -> typelib-1_0-AppIndicator3-0_1 -> libayatana-appindicator3-1
- Continue installation with warning instead of hard failure
Fixes#407
Fix false local repo detection when users run `uv init` before installation. Changed detection from naive file existence check to content validation:
- For pyproject.toml: check for `name = "vocalinux"`
- For setup.py: check for "vocalinux" string
- Falls through to remote clone mode if neither matches
Fixes#396
Add cmake, libcairo2-dev, and dynamic libgirepository version detection
to fix installation failures on Pop!_OS (Cosmic DE) and newer Ubuntu.
Three issues addressed:
1. cmake: Required by pywhispercpp to build whisper.cpp from source.
Added to all distro package lists (apt, dnf, pacman, zypper, emerge,
apk, xbps, eopkg).
2. libcairo2-dev: Required to build pycairo. Was present in the Debian
package list but missing from the Ubuntu list, which Pop!_OS uses.
3. libgirepository version: Ubuntu 24.04+ and Pop!_OS Cosmic+ ship
libgirepository-2.0-dev instead of libgirepository1.0-dev. Added
runtime detection to select the correct package, mirroring the
existing version-aware handling already in place for Debian.
Reported-by: DavidHoenisch
Ref: https://github.com/jatinkrmalik/vocalinux/discussions/378
* fix: bundle resources in package to fix missing icons in system tray (fixes#349)
The resources directory (icons and sounds) was not included in pip-installed
packages because it lived outside the src/ package directory. This caused
the resource_manager to find an empty icon directory at runtime, resulting in
the ellipsis (three dots) icon in the GNOME system tray.
Changes:
- Copy resources into src/vocalinux/resources/ so setuptools bundles them
- Add 'vocalinux.resources/**/*' to package-data in pyproject.toml
- Add MANIFEST.in for sdist builds
- Update resource_manager to check package-bundled resources first
(module_dir.parent / 'resources') before checking external paths
- Add install_resources_to_venv() to install.sh for curl-based installs,
copying resources to /share/vocalinux/resources
This fixes both pip installs (resources bundled in the wheel) and curl-based
installs (resources copied to venv share directory).
* fix: ensure bundled resources are included in sdist and pip installs
- Add 'vocalinux.resources' to setuptools packages list so the
subpackage (and its __init__.py) is recognized by setuptools
- Add __init__.py to src/vocalinux/resources/ to make it a proper
Python subpackage for reliable discovery
- Add 'recursive-include src/vocalinux/resources *' to MANIFEST.in
so sdist archives include the bundled icons and sounds
* chore(release): prepare v0.10.0-beta
Bump versions and release references across app, docs, installer, and website for the next beta release. Add v0.10.0-beta release notes entries covering reliability fixes and CI/test improvements since v0.9.0-beta.
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent)
Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
* docs(release): align Python baseline references to 3.9+
Synchronize stale Python 3.8 references in agent guidance and distro dependency docs/scripts with the current 3.9+ minimum used by project metadata and release docs.
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent)
Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
---------
Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
* chore: bump minimum Python from 3.8 to 3.9 and adopt PEP 585 builtins
- Update requires-python, classifiers, mypy target, and black target in pyproject.toml
- Replace Python 3.8 with 3.9 in CI matrix and nightly workflow
- Replace typing.List/Dict/Tuple/Set with builtin list/dict/tuple/set (PEP 585)
- Update all 3.8 version references in README, docs, website, and install.sh
- Fix test_wayland_no_tools to mock IBus availability
- Remove List from common_types re-exports and update test
* style: reformat test files for Black 26.x and pin version in CI
Black 26.x introduced parenthesized context manager formatting.
Reformat 7 test files and pin Black>=26,<27 in CI to prevent
future drift from unpinned version upgrades.
When running via `curl | bash`, stdin (fd 0) is the pipe — not the
terminal. The script was setting INTERACTIVE_MODE='ask' and then trying
to `read` from the pipe, which returned EOF/garbage, defaulting to
interactive mode, which then immediately errored because there was no TTY.
Fix: if stdin is a pipe but /dev/tty is accessible, do `exec < /dev/tty`
to redirect stdin to the real terminal so user prompts work correctly.
If there is truly no terminal (headless/CI), fall back to automatic mode
without erroring.
Also fix the misleading error message which suggested running the exact
same curl|bash command that just failed.
The IBus injection path had an early return that skipped the clipboard
copy logic. Store the result, copy to clipboard if enabled, then return.
Also add xclip and wl-clipboard to install.sh for all supported distros
so clipboard tools are available out of the box.
* chore(release): prepare v0.7.0-beta
## Version Bump (v0.6.3-beta → v0.7.0-beta)
This is a major beta release with significant new features including autostart support, tabbed settings, and improved GPU detection.
### Core Version Files
- Updated src/vocalinux/version.py to 0.7.0-beta
- Updated pyproject.toml classifiers (already correct - Beta)
### Documentation
- Updated README.md with new features, bug fixes, and version references
- Updated docs/INSTALL.md with v0.7.0-beta install commands
- Updated docs/UPDATE.md with comprehensive 'What's New' section
- Updated SECURITY.md supported versions table (0.7.x now supported)
### Website
- Updated web/src/app/page.tsx version badge (v0.7.0 Beta)
- Updated web/src/app/page.tsx softwareVersion schema
- Updated web/package.json version to 0.7.0
- Updated web/src/app/changelog/page.tsx with v0.7.0-beta release entry
### Other Updates
- Updated install.sh default tag to v0.7.0-beta
- Updated src/vocalinux/main.py error message install command
- Updated AGENTS.md branch naming example
## Changes Since v0.6.3-beta
### New Features (13 commits)
- Autostart on login support via XDG autostart
- Tabbed settings dialog with 5 organized tabs
- Intel GPU compatibility detection with automatic CPU fallback
- Single instance prevention
- Evdev device management to prevent CPU spin
- Improved GPU detection avoiding false positives
- IBus fallback when daemon not running
- Fedora dnf check-update fix
- Web SEO - 7 new optimized pages
### Contributors
- Jatin K Malik (maintainer)
- Antoine Monnet (contributor)
- jatinkrmalik (contributor)
### Bug Fixes
- #254: Improved GPU detection to avoid false positives
- #251: Skip IBus setup when daemon not running
- #243: Prevent dnf check-update from exiting script on Fedora
- #240: Raise exception on IBus setup failure
- #234: Removed leading space from first speech transcription
- #242/#253: Removed disconnected evdev devices to prevent CPU spin
## Verification
- [x] Lint passed
- [x] Black formatting passed
- [x] isort check passed
- [x] Version imports correctly as 0.7.0-beta
* docs: update version history in RELEASE_PROCESS.md
Add entries for 0.6.0-beta through 0.7.0-beta to the version history table.
* fix(installer): improve GPU detection to avoid false positives
- Filter out software renderers (llvmpipe, swiftshader, lavapipe, etc.)
when checking Vulkan compatibility - these are CPU implementations
and should not affect hardware GPU detection
- Skip Vulkan compatibility check for NVIDIA GPUs since they use CUDA
instead of Vulkan for acceleration
- Reorder backend priority: CUDA > Vulkan > CPU
- Only show incompatible GPU warning for actual Vulkan-based GPUs
(AMD/Intel) that lack VK_KHR_16bit_storage support
Fixes issue where RTX 5080 + llvmpipe combination was incorrectly
flagged as incompatible due to llvmpipe lacking 16-bit storage support.
* fix(installer): recommend GPU even without dev libraries installed
The installer installs dev libraries (libvulkan-dev, glslc) in
install_system_dependencies(), which runs AFTER the backend selection.
So we should recommend GPU if there's a compatible GPU regardless
of whether dev libraries are currently installed.
Changes:
- NVIDIA GPU detected → recommend CUDA (even without nvcc)
- Vulkan-compatible GPU → recommend Vulkan (even without libvulkan-dev)
- Only fall back to CPU if no compatible GPU detected or GPU is
genuinely incompatible (old Intel Gen7)
* feat: detect incompatible Intel GPUs and fallback to CPU
Implements two-layer protection for users with older Intel GPUs that lack
VK_KHR_16bit_storage support required by whisper.cpp Vulkan backend.
Affected GPUs: Intel Gen7 and older (Ivy Bridge, Haswell, Sandy Bridge)
- Intel HD Graphics 2500/4000 (Ivy Bridge)
- Intel HD Graphics 4400/4600 (Haswell)
Layer 1: Install-Time Detection (Prevention)
- New check_vulkan_gpu_compatibility() function in install.sh
- Parses GPU name from vulkaninfo output
- Checks against known incompatible patterns
- Shows clear warning and recommends CPU backend
- Updates detect_whispercpp_backends() to skip Vulkan for incompatible GPUs
Layer 2: Runtime Fallback (Safety Net)
- Added error handling in recognition_manager.py _init_whispercpp()
- Catches RuntimeError with "16-bit storage" or "Unsupported device"
- Automatically disables Vulkan/CUDA and retries with CPU
- Shows desktop notification explaining the fallback
Fixes#238
* fix(gpu): improve compatibility detection and add tests
* feat(ui): add auto-start on boot support
- Add --start-minimized CLI flag for autostart entry
- Create autostart_manager.py to handle XDG autostart desktop entry
- Add autostart config option in config_manager.py
- Add Start on Login toggle in Settings dialog
- Add Start Minimized toggle in Settings dialog
- Add Start on Login checkbox in system tray menu
- Add first-run dialog to ask about autostart preference
Closes#184
* fix(test): add first_run: False to mock config settings
The tests were failing with StopIteration because main() now checks
for first_run and shows a dialog if True. By setting first_run: False
in the mock config, we skip the first-run dialog code path.
* fix(ui): harden autostart behavior across Linux sessions
Use XDG-compliant autostart paths and robust Exec command resolution, keep first-run prompt semantics correct, and fix GTK toggle handling so state changes are applied reliably.
* docs(autostart): document XDG startup model and limits
Clarify that Vocalinux uses desktop-session XDG autostart, not systemd services, and explain compatibility expectations for mainstream DEs versus minimal/custom WM sessions.
* feat(ui): add first-run quick-start guidance text
Expand the welcome dialog with concise first-time usage guidance and clear direction to the tray menu Settings entry while preserving the existing autostart decision flow.
* fix(uninstall): remove XDG autostart desktop entry
Ensure uninstall removes ~/.config autostart registration and reports leftover autostart entries during verification.
* fix(install): ignore defunct processes in running-check
Filter installer process detection to exclude defunct entries and installer/uninstaller shells so stale zombie rows do not block reinstall.
* fix(uninstall): ignore defunct processes in running-check
Use filtered process detection so zombie entries and installer shells do not trigger false running-process warnings during uninstall.
dnf check-update returns exit code 100 when system updates are
available, which causes the script to exit immediately due to set -e.
Added '|| true' to prevent this non-error condition from stopping
the installer.
Fixes#34 (Fedora installation failure)
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-opencode)
Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
* chore(release): prepare v0.6.3-beta
- Fix#220: Installer default tag now points to correct version
- Update version from 0.6.2-beta to 0.6.3-beta
- Update documentation version references
- Update website schema and badges
- Add v0.6.3-beta changelog entry
The v0.6.2-beta installer was defaulting to v0.6.1-beta which is
missing the psutil dependency, causing fresh installs to fail.
* docs(update): simplify update guide, remove duplicate version history
install.sh:
- Add check_running_processes() function to detect running Vocalinux
- Prompt user to kill processes before proceeding with installation
- Auto-kill in non-interactive mode
uninstall.sh:
- Add confirmation prompt before killing processes
- Add interactive prompt for keeping data (models, config)
- Simplified --keep-data flag behavior (also keeps config)
This prevents issues during install/upgrade when Vocalinux is
still running, and gives users more control over data preservation.
pkg-config is included in the package list to install, so the script
should not exit with an error if it's not already installed. The check
was preventing installation on fresh systems like WSL Ubuntu 24.04.
The script already has proper fallbacks for when pkg-config is not
available (detect_vulkan and detect_typelib_path both check before
calling pkg-config).
* feat(text-injection): add IBus engine for Wayland text injection
Add a custom IBus input method engine for reliable text injection on
Wayland, solving keyboard layout issues with xdotool/wtype.
Key features:
- IBus proxy engine that passes through normal keyboard input
- Text injection via Unix socket IPC
- User-level component installation (no sudo required)
- Auto-reactivation when user switches keyboard layouts
- Graceful fallback when IBus is unavailable
Changes:
- New ibus_engine.py with VocalinuxEngine and IBusTextInjector
- TextInjector now prefers IBus on Wayland for best compatibility
- Add IBus GObject bindings to system dependencies in install.sh
- Add comprehensive tests for IBus engine
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* security: secure IBus socket with permissions and peer verification
- Set directory to 0o700 (owner-only access)
- Set socket to 0o600 (owner-only read/write)
- Add SO_PEERCRED verification to reject connections from other users
This provides defense-in-depth: even if directory permissions are
bypassed, the socket server verifies the connecting process UID.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* fix: address PR review feedback for IBus text injection
- Fix infinite loop in socket server by adding _server_running flag
- Use sys.executable instead of hardcoded python3 for venv compatibility
- Also inherit environment (env=os.environ.copy()) for venv deps
- Fix component XML to use sys.executable in <exec> tag
- Replace unsafe pgrep with PID file tracking and /proc verification
- Integrate TextInjector.stop() in TrayIndicator._quit() for cleanup
- Remove unused is_engine_registered import
- Fix redundant hasattr check to use proper None comparison
- Auto-detect and update stale IBus component XML on startup
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
---------
Co-authored-by: AntoineMontane <monnet.antoine@gmail.com>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* fix(install): correct package detection for Void and Solus, fix git fetch syntax
- Fix git fetch syntax: remove incorrect quoting around 'tag' argument
- Fix Void Linux: use 'xbps-query' instead of 'xbps-query -S' which checks
remote repos instead of installed packages
- Fix Solus: use 'eopkg list-installed | grep' instead of 'eopkg info' which
queries repository info, not installed status
These bugs caused the installer to always attempt reinstalling packages on
Void Linux and Solus, even when they were already installed.
* fix(install): correct package names for Arch, Void, and Gentoo
- Arch Linux: libappindicator-gtk3 -> libappindicator (package was renamed)
- Void Linux: libappindicator -> libappindicator-gtk3 (correct package name)
- Gentoo: dev-libs/libappindicator:3 -> dev-libs/libayatana-appindicator
(libappindicator is deprecated, use ayatana fork)
Added glslang and vulkan-tools to distributions that were missing them:
- Gentoo: dev-util/glslang
- Alpine: glslang vulkan-tools
- Void: glslang Vulkan-Tools
- Solus: glslang vulkan-tools
Validated package names against official repositories for each distro.
- Try glslc first (available on Ubuntu 24.04+)
- Fall back to glslang-tools if glslc not available (Ubuntu 22.04)
- Update user-facing messages to mention both packages
- Fixes#212 while maintaining compatibility with newer Ubuntu versions
When installing with --engine=whisper, the installer would continue even
if the whisper package installation failed, creating a config file with
engine=whisper. This caused the app to crash on startup with
'No module named whisper'.
Changes:
- Add proper verification of whisper installation by importing the module
- Only create whisper config if installation succeeds
- Fall back to whisper.cpp if whisper installation fails
- Provide clear error messages during installation
Fixes#190
Bump version from 0.6.0-beta to 0.6.1-beta with installation improvements:
Version Updates:
- src/vocalinux/version.py: 0.6.0-beta → 0.6.1-beta
- install.sh: Default tag and help text updated
- web/package.json: 0.6.0 → 0.6.1
- web/src/app/layout.tsx: schema.org softwareVersion updated
- web/src/app/page.tsx: version badge updated
Documentation Updates:
- README.md: New 'What's New' section for v0.6.1-beta
- docs/UPDATE.md: Added v0.6.1-beta release notes with new features
- docs/INSTALL.md: Version references updated
- docs/RELEASE_PROCESS.md: Example commands updated
- tests/distro-testing-checklist.md: Version references updated
- src/vocalinux/main.py: Error message updated
New Features in v0.6.1-beta:
- Interactive backend selection for whisper.cpp (GPU vs CPU)
- Enhanced welcome message with testing instructions
- Simplified install commands (tag-based URLs)
- Better GPU support with proper library detection
Bug Fixes:
- Fixed bash arithmetic with set -e
- Fixed TTY detection for interactive mode
- Auto-install git if missing
- Fixed GPU installation commands
Changed install commands to download install.sh directly from the release
tag instead of from main branch with --tag parameter. This ensures:
1. The install script version matches the release being installed
2. No version mismatch between script and code
3. Simpler, cleaner install commands
Changes:
- install.sh: Updated error message to use v0.6.0-beta URL
- README.md: All install commands now use v0.6.0-beta/install.sh
- docs/INSTALL.md: Updated quick install command
- docs/UPDATE.md: Updated update command examples
- docs/RELEASE_PROCESS.md: Updated example command
- src/vocalinux/main.py: Updated error message install command
- tests/distro-testing-checklist.md: Updated download URL
- web/src/app/page.tsx: Now uses dynamic tag in URL (not main)
- .github/workflows/release.yml: Release notes use tag-based URL
Before:
curl .../main/install.sh | bash -s -- --tag=v0.6.0-beta
After:
curl .../v0.6.0-beta/install.sh | bash
Fixes version consistency between install script and installed code.
The previous fix stored the pip command in a variable:
PYWHISPERCPP_INSTALL_CMD="GGML_CUDA=1 pip install ..."
$PYWHISPERCPP_INSTALL_CMD
This doesn't work because bash interprets "GGML_CUDA=1" as a
command, not as an environment variable prefix.
Fix: Use conditional logic to run the commands directly:
if GGML_CUDA=1 pip install ...; then
GPU_INSTALL_SUCCESS=true
fi
The basic `pip install pywhispercpp` only includes CPU support.
For GPU acceleration, pywhispercpp must be installed with special
environment flags:
- NVIDIA GPU: GGML_CUDA=1 pip install git+...
- Vulkan (AMD/Intel): GGML_VULKAN=1 pip install git+...
This fix:
- Detects GPU type during whisper.cpp installation
- Installs pywhispercpp with appropriate GPU support flag
- Falls back to CPU version if GPU install fails
Fixes#193
Users running the install script via curl | bash may not have git
installed. This adds a check before attempting to clone the repo
and auto-installs git using the appropriate package manager for
the detected distribution.
Fixes issue reported on Reddit where install failed on Linux Mint
with "git command not found" error at line 170.
* feat(speech): add whisper.cpp with Vulkan support for GPU acceleration
Add whisper.cpp as a new speech recognition engine with the following features:
- Vulkan GPU acceleration support (AMD, Intel, NVIDIA)
- Fallback to CUDA for NVIDIA GPUs
- CPU-only mode with automatic thread optimization
- Support for all model sizes: tiny, base, small, medium, large
- Hardware detection to recommend best model/backend
- Models downloaded from Hugging Face (ggml format)
- Updated UI to show compute backend info in settings
- pywhispercpp as the Python binding library
- whisper_cpp as the new default engine
Changes:
- New whispercpp_model_info.py with model metadata and hardware detection
- Updated recognition_manager.py with whisper.cpp init and transcription
- Updated settings_dialog.py with whisper.cpp UI support
- Updated config_manager.py with whisper_cpp_model_size config
- Updated main.py with whisper_cpp CLI option
- Updated pyproject.toml with pywhispercpp dependency
- Updated install.sh with vulkan-tools for GPU detection
Closes#104
* style: fix black and isort formatting issues
* test: update config manager test for whisper_cpp default engine
* feat(install): interactive mode with 3 engine choices and whisper.cpp as default
Major changes to install.sh:
- Interactive mode is now the DEFAULT (not --auto)
- Added --auto flag for non-interactive automatic installation
- New --engine flag to specify engine directly
- Interactive mode shows 3 engine options with visual boxes:
1. whisper.cpp (recommended) - Vulkan/CUDA/CPU support
2. whisper (OpenAI) - PyTorch-based, NVIDIA-only
3. VOSK - lightweight option
- Hardware detection with recommendations:
- Detects Vulkan support (AMD/Intel/NVIDIA)
- Detects NVIDIA CUDA
- Checks available RAM
- Recommends best engine based on hardware
- Updated help text with new options and examples
- Removed old --with-whisper, --whisper-cpu, --no-whisper flags
- whisper.cpp is now the default engine for automatic mode
* feat(uninstall): kill running vocalinux processes before uninstall
* fix(whisper.cpp): auto-download model, use all CPU cores, hide unavailable engines
Three fixes for whisper.cpp implementation:
1. Auto-download model during install
- Added install_whispercpp_model() function to install.sh
- Downloads ggml-tiny.bin (~39MB) from Hugging Face
- Runs automatically when whisper.cpp engine is selected
2. Use all CPU cores for transcription
- Added n_threads parameter to Model initialization
- Uses multiprocessing.cpu_count() to get all cores
- Significantly improves transcription speed
3. Hide unavailable engines from dropdown
- Added get_available_engines() function to detect installed engines
- Settings dialog now only shows engines that are actually installed
- Falls back to first available engine if current not available
Fixes user-reported issues with whisper.cpp integration.
* ui(settings): display whisper.cpp correctly and increase dialog height
- Changed engine display name from 'whisper_cpp' to 'whisper.cpp'
- Added format_engine_display_name() helper function
- Dialog now uses 75% of screen height for better visibility
- More options visible by default without scrolling
* revert(settings): remove display name change, keep dialog height increase
- Reverted engine display name change (was breaking engine selection)
- Kept dialog height at 75% of screen for better visibility
* style: fix black and isort formatting for whisper.cpp logging
* style: fix black formatting in settings_dialog.py
* ci: fix Fedora 39 container package installation
Add dnf cache update and fallback with --nogpgcheck for Fedora containers
that may have stale or missing package metadata.
Add testing infrastructure and documentation improvements.
**Task 12: Add pkg-config to Core Dependencies**
- Added pkg-config check at the start of install_system_dependencies()
- Added pkg-config to all distribution package lists
- Provides distro-specific install instructions if pkg-config is missing
- Critical for library detection (GI_TYPELIB_PATH, PortAudio, etc.)
**Task 13: Update README with Distro Info**
- Updated Requirements section with tested distributions
- Added link to DISTRO_COMPATIBILITY.md
- Listed officially supported distros: Ubuntu 22.04+, Debian 11+, Fedora 39+, Arch, openSUSE
- Mentioned experimental support for Gentoo, Alpine, Void, Solus
**Task 14: Create Test Matrix for CI**
- New workflow: .github/workflows/distro-test-matrix.yml
- Tests on multiple container images: Ubuntu 22.04, 24.04, Debian 12, Fedora 39
- Runs dependency checker on each distro
- Tests Python imports and bash syntax validation
- Uses continue-on-error for experimental distro support
**Task 15: Integration Testing Checklist**
- New file: tests/distro-testing-checklist.md
- Comprehensive checklist for testing on new distributions
- Covers: Pre-install, Installation, Post-install, Functionality, Performance, Cleanup
- Includes quick reference commands
- Desktop environment and application-specific testing sections
- Template for submitting test results
Part of cross-distribution compatibility improvements (Phase 4 of 5).
Related to #157
Add better error messages and documentation for cross-distribution compatibility.
**Task 9: System Dependency Checker (scripts/check-system-deps.sh)**
- New script to check system dependencies regardless of distribution
- Detects Python 3.8+, pkg-config, GTK3, PyGObject, PortAudio
- Checks for text injection tools (xdotool, wtype, ydotool)
- Provides distribution-specific installation instructions
- Supports all 10+ distribution families (Ubuntu, Debian, Fedora, Arch, openSUSE, Gentoo, Alpine, Void, Solus, Mageia)
**Task 10: Better Unsupported Distro Message (install.sh)**
- Enhanced error message for unsupported distributions
- References the new dependency checker script
- Provides manual installation options (skip-system-deps, venv install)
- Includes link to project wiki
- Interactive prompt to continue or cancel
**Task 11: Distro Compatibility Documentation (docs/DISTRO_COMPATIBILITY.md)**
- Comprehensive compatibility matrix for supported distros
- Experimental support section with known issues
- Requirements by distribution with exact commands
- Desktop environment compatibility (GNOME, KDE, Xfce, sway, i3, etc.)
- Display server support (X11, Wayland, XWayland)
- Architecture support (x86_64, arm64, armhf, riscv64)
- Testing checklist for new distributions
- Issue reporting guidelines
- Contributing guidelines for compatibility fixes
Part of cross-distribution compatibility improvements (Phase 3 of 5).
Related to #157
Add support for 5 additional Linux distribution families:
**New Distribution Detection:**
- Gentoo (Portage package manager)
- Alpine Linux (apk package manager)
- Void Linux (xbps package manager)
- Solus (eopkg package manager)
- Mageia (dnf/urpmi package managers)
**Changes:**
- Enhanced `detect_distro()` to detect Gentoo, Alpine, Void, Solus, Mageia
- Added package definitions for each new distribution in `install_system_dependencies()`
- Added full installation case statements with package verification
- Updated `install_python_dependencies()` to handle virtual environment creation for new distros
- Updated `install_text_input_tools()` for both Wayland and X11 sessions
- Updated unknown session type fallback with all new distributions
**Package Manager Support:**
- emerge: Gentoo's Portage (compiles from source)
- apk: Alpine's package manager (musl libc)
- xbps: Void Linux's package manager
- eopkg: Solus's package manager
- dnf/urpmi: Mageia's package managers
Part of cross-distribution compatibility improvements (Phase 2 of 5).
Related to #157
* fix: Phase 1 - Critical cross-distribution compatibility fixes
This commit implements the first phase of cross-distribution compatibility
improvements for Vocalinux, addressing the most critical issues that prevent
the application from working on non-Ubuntu distributions.
## Changes
### install.sh
- Add detect_typelib_path() function that dynamically discovers GI_TYPELIB_PATH
using pkg-config with fallback to distribution-specific paths
- Update wrapper scripts (vocalinux, vocalinux-gui) to use detected path
- Support for: x86_64, arm64, armhf, riscv64, powerpc64le, s390x architectures
- Specific paths for: Ubuntu multiarch, Fedora/RHEL (lib64), Arch (lib)
### src/vocalinux/speech_recognition/recognition_manager.py
- Add _get_system_model_paths() function for dynamic model path discovery
- Enhance ALSA library detection with multiple library name fallbacks:
- libasound.so.2, libasound.so, libasound.so.0, asound
- Support XDG_DATA_DIRS environment variable for model paths
- Distribution-specific paths for Fedora/RHEL/CentOS/Rocky/AlmaLinux
- Arch-specific handling (excludes /usr/local)
### src/vocalinux/utils/resource_manager.py
- Enhanced _find_resources_dir() with more candidate paths
- Support for XDG_DATA_DIRS environment variable
- Add lib64 and lib paths for Fedora/RHEL distributions
- Add Flatpak-specific path (/app/share/vocalinux/resources)
## Testing
All 462 existing tests pass.
## Related Issues
Fixes#157 (partial - Phase 1 of 5)
* chore: Remove analysis docs from PR, add to .gitignore
* style: Apply black formatting to pass lint checks
* fix(install): fix model download and VOSK-only option in interactive mode
- Add missing option 3 handling in interactive prompt to create VOSK
config when user selects VOSK-only mode (mirrors --no-whisper flag)
- Set WITH_WHISPER and WHISPER_CPU flags correctly for options 1 and 2
- Fix Whisper model download logic to check actual installation status
using venv python instead of relying on unreliable flag combinations
- Always download Whisper tiny model when Whisper is installed since
it's the default engine in config_manager.py
- Add informative messages about model download status
Fixes issues where:
1. Selecting option 2 or 3 didn't properly configure the system
2. Whisper tiny model wasn't downloaded even when Whisper was selected
3. App defaulted to Whisper engine but model wasn't available
* fix(install): use explicit venv python path and simplify condition
- Use $VENV_DIR/bin/python instead of bare 'python' in run_tests() and
verify_installation() for consistency and reliability
- Simplify Whisper install condition since WITH_WHISPER is already set
by auto-detection in non-interactive mode (lines 412-424)
- Update comments to better explain the logic flow
* style(install): restore ASCII art logo and improve formatting
- Restore beautiful VOCALINUX ASCII art banner in interactive installer
- Restore ASCII art banner in installation complete message
- Use Unicode box-drawing characters (━) for section separators
- Use bullet points (•) instead of dashes for lists
- Add colored terminal output for commands
- Add star emoji for GitHub link
* style(install): show ASCII art banner in all installation modes
The ASCII art logo is now displayed at the start of installation
regardless of mode (interactive, curl|bash, or with flags).
* fix(install): remove duplicate ASCII art in interactive mode
The ASCII art banner is now shown once at script start for all modes.
Remove the duplicate from run_interactive_install() to avoid showing
it twice when running with -i/--interactive flag.
* docs(install): rename options to 'Full install' and 'Minimal install'
Clarify that VOSK is always installed as a fallback engine:
- 'Full install' = Whisper + VOSK (recommended, highest accuracy)
- 'Minimal install' = VOSK only (lightweight, ~40MB)
Updates both the -i interactive installer and the fallback prompt.
Also improves the installation summary display.
* fix(install): update desktop database so app appears in menu immediately
Previously only the icon cache was updated after installation, but not
the desktop database. This caused the app to not appear in application
menus until the user logged out and back in (or manually ran
update-desktop-database).
Now the installer runs update-desktop-database after installing the
.desktop file, so Vocalinux appears in the app launcher immediately.
* fix(keyboard): verify Ctrl key capability in evdev backend availability check
The evdev backend's is_available() method was incorrectly returning True
when keyboard devices were found, even if the user lacked permission to
access them or if the accessible devices didn't have Ctrl key capability.
This caused keyboard shortcuts to fail silently on Wayland when the user
wasn't in the 'input' group, as the backend was selected but couldn't
actually monitor keyboard events.
Changes:
- Add device_has_ctrl_key() helper to verify a device supports Ctrl keys
- Update is_available() to check both device accessibility AND Ctrl key
capability
- Now correctly returns False when no usable keyboard device is found,
triggering proper error messages about permissions
This ensures users get clear feedback about missing permissions instead
of silently non-working keyboard shortcuts.
* fix(install): use sg command to apply input group without logout
The install.sh script adds the user to the 'input' group for keyboard
shortcuts on Wayland, but this change doesn't take effect until logout.
Updated wrapper scripts to use 'sg input -c ...' to run vocalinux with
the input group applied, even if the user hasn't logged out yet. This
provides a much better user experience as keyboard shortcuts work
immediately after installation.
The wrapper detects if:
1. User is in /etc/group for 'input' group
2. Current session doesn't have the group active
If both conditions are true, it uses 'sg' to apply the group.
* Fix Python 3.13 and Wayland compatibility
This commit addresses installation failures on modern Linux distributions
(Ubuntu 25.10+) with Python 3.13 and Wayland-only sessions.
Changes:
1. **Add Python 3.13 support** (pyproject.toml)
- Add Python 3.13 to classifiers
- Update black target versions to include py312, py313
- No code changes needed - already compatible
2. **Use system site-packages for PyGObject** (install.sh)
- Change venv creation to use --system-site-packages flag
- Avoids PyGObject build failures with Python 3.13
- System PyGObject (python3-gi) is already installed as dependency
- Building from source is unnecessary and fragile with new Python versions
3. **Improve Wayland text injection support** (install.sh)
- Install ydotool as fallback (wtype doesn't work with GNOME Wayland)
- Add user to 'input' group for uinput device access
- Install udev rule for /dev/uinput permissions
- Provide clear warning about logout requirement
Technical details:
- wtype uses Wayland virtual keyboard protocol (not supported by GNOME)
- ydotool uses Linux uinput kernel module (works with all compositors)
- System PyGObject 3.50.0+ supports Python 3.13
- Building PyGObject 3.54.5 from source fails with Python 3.13 build tools
Fixes installation on:
- Ubuntu 25.10 (Questing Quokka) - Wayland-only, Python 3.13
- Arch Linux with Python 3.13
- Fedora 41+ with Python 3.13
Tested on: Ubuntu 25.10 with Python 3.13.7, GNOME 49 Wayland
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
* Prioritize ydotool over wtype for universal Wayland compatibility
wtype uses the virtual-keyboard Wayland protocol which is not supported
by GNOME/Mutter compositors. ydotool uses the Linux uinput kernel module
which works with all Wayland compositors including GNOME.
This change swaps the priority order to check ydotool first, ensuring
text injection works on GNOME Wayland (Ubuntu 25.10+) while still
falling back to wtype for compositors that support it.
Tested on Ubuntu 25.10 with GNOME 49 Wayland - text injection now works
perfectly with ydotool.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
* ci: trigger workflow run
* ci: run lint/tests on python 3.13
---------
Co-authored-by: ACT900 <179795730+ACT900@users.noreply.github.com>
Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
* fix: Debian dependencies in install.sh
Fixes issue #102: Building on a fresh Debian installation in a VM with GNOME
required additional dependencies for pip to install. pip fails with Meson submodule
failing without cairo and girepository-2.0 development packages.
Changes:
- install.sh: Separated Debian packages from Ubuntu packages; selects Debian if found;
otherwise same workflow for apt packages
- docs/INSTALL.md: Separated Debian installation instructions from Ubuntu, updated package list.
- src/vocalinux/main.py: Fixed comment indicating gir1.2-ayatana-appindicator3 is only for Debian
13- it's for Debian 11+
- CONTRIBUTING.md: Separated Debian installation instructions from Ubuntu, updated package list.
* fix: fall back to Ayatana AppIndicator
---------
Co-authored-by: Tanjera <ibi.keller@gmail.com>
There was a typo in the gir1.2-ayatanaappindicator3-0.1 .deb package referred
to in apt commands, submitted in commit 27ebbfe417f178eaabcf2ac10af63f37bc819fac
gir1.2-ayatana-appindicator3 (typo) replaced with gir1.2-ayatanaappindicator3-0.1
per Debian package list at
https://packages.debian.org/search?keywords=gir1.2-ayatanaappindicator3-0.1
Will be backwards compatible with Debian 11 (bullseye), 12 (bookworm), and current
13 (trixie).
Changes:
- install.sh: gir1.2-ayatana-appindicator3 (typo) replaced with gir1.2-ayatanaappindicator3-0.1
- docs/INSTALL.md: gir1.2-ayatana-appindicator3 (typo) replaced with gir1.2-ayatanaappindicator3-0.1
- src/vocalinux/main.py: gir1.2-ayatana-appindicator3 (typo) replaced with gir1.2-ayatanaappindicator3-0.1
- CONTRIBUTING.md: gir1.2-ayatana-appindicator3 (typo) replaced with gir1.2-ayatanaappindicator3-0.1
Release preparation for v0.4.1-alpha with the following updates:
Features:
- Language selector UI with 10 languages and auto-detection support
Bug Fixes:
- App drawer launch fix when installing from local repo (absolute path for VENV_DIR)
- Escape commit message in Detect Changes step
- Correct git fetch syntax for tag-based updates
Updated Files:
- src/vocalinux/version.py: 0.4.0-alpha → 0.4.1-alpha
- install.sh: Default tag v0.3.0-alpha → v0.4.1-alpha
- README.md: Install command version updates
- docs/INSTALL.md: Install command version updates
- docs/UPDATE.md: New v0.4.1-alpha section, moved v0.4.0-alpha to Previous Versions
- web/src/app/layout.tsx: Software version update
When installing from within the git repository, VENV_DIR remained as
the relative path "venv", which caused wrapper scripts in ~/.local/bin/
to fail when executed from any directory other than the repo root.
This broke launching from app drawers/desktop entries since they don't
set the working directory to the repo location.
Fix: Convert VENV_DIR to an absolute path ($INSTALL_DIR/$VENV_DIR) when
running from local repository, ensuring wrapper scripts work regardless
of current working directory.
* feat: add language selector UI with auto-detection support
This commit implements a comprehensive language selector for the GUI,
extending support from 4 to 10 languages and adding Whisper auto-detect.
Changes:
- Add SUPPORTED_LANGUAGES constant with 10 languages (auto, en-us, hi, es, fr, de, it, pt, ru, zh)
- Each language includes display name, Whisper code, VOSK model name, and optional warning
- Extend VOSK_MODEL_INFO to include Hindi, Spanish, Italian, Portuguese, and Chinese models
- Add language dropdown in Settings dialog with status indicators (✓ downloaded, ↓ needs download, ⚠ warning)
- Add language warning label for auto-detect and engine compatibility messages
- Update default language from "en-us" to "auto" for Whisper auto-detection
- Handle "auto" language in Whisper (passes None for auto-detect)
- Handle "auto" language in VOSK (falls back to "en-us" since VOSK doesn't support auto-detect)
- Update CLI --language argument to include all supported languages
Fixes the issue where Hindi speech was being transcribed as English
because the language was hardcoded to "en-us" which Whisper interpreted
as "force English transcription" rather than auto-detect.
Related PRs:
- #72 - Feature: Add language auto-detection and GUI selector (supersedes)
- #71 - Feature: Add multi-language support for FR, DE, RU (builds upon)
- #52 - Feature: 3 more languages for Whisper and VOSK (extends)
- #68 - Comment out language parameter in transcribe call (addresses)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* style: format main.py with black
* fix: use venv python and set GI_TYPELIB_PATH for verification
* fix: create wrapper scripts that set GI_TYPELIB_PATH
Problem: The symlinks in ~/.local/bin pointed to venv scripts that
failed because PyGObject couldn't find the system typelib files
(AppIndicator3 namespace not available).
Solution: Create wrapper scripts in ~/.local/bin that:
1. Set GI_TYPELIB_PATH=/usr/lib/girepository-1.0
2. Execute the venv's vocalinux scripts
This fixes the issue where vocalinux-gui would fail to start with:
ValueError: Namespace AppIndicator3 not available
* fix: set GI_TYPELIB_PATH in desktop entry Exec line
When launching from the app drawer, the environment variables from the
wrapper script weren't being inherited properly. By adding GI_TYPELIB_PATH
directly in the desktop entry's Exec line, the app can now find the
AppIndicator3 typelib files.
* fix: always create wrapper scripts, not just for remote installs
The wrapper scripts were only created when CLEANUP_ON_EXIT=yes, which
is only set for remote (curl-based) installations. When running from
a local repository, the wrapper scripts were never created, causing
the desktop entry and launch commands to fail.
* fix: prevent recursion in LoggingHandler when processing log records
The custom LoggingHandler was triggering logging from within the logging
system itself, causing infinite recursion when formatting log records.
This could happen when the logging formatter or any operation during
record processing triggered additional log messages.
Fix: Add _emitting flag to prevent recursive calls to emit().
* fix: prevent infinite loop in settings dialog when changing language
Add guard flags to prevent recursive event handler calls:
- _populating_models: blocks _on_model_changed during model population
- _processing_language_change: blocks recursive language change handling
- _applying_settings: blocks recursive settings application
These guards prevent the infinite loop that occurred when selecting a
language whose VOSK model wasn't downloaded yet.
Fixes issue where "Model small needs download" logged repeatedly.
* fix: handle language parameter in reconfigure and improve UX
- Fix reconfigure() to properly handle language parameter changes
- Remove _processing_language_change check from _auto_apply_settings
to allow settings to be applied when language changes
- Hide unsupported languages in dropdown based on selected engine
* VOSK: only show languages with available models (no "auto")
* Whisper: show all supported languages including "auto"
- Remove duplicate _auto_apply_settings call in _on_engine_changed
- Set active language in combo after repopulating options
This fixes:
1. Whisper continuing to use old language after switching (e.g.,
still transcribing in Hindi after switching to en-us)
2. Potential infinite loop when selecting languages for VOSK
3. User confusion by showing incompatible language options
---------
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* Fix: Handle deprecated appindicator package on Debian 13+
Fixes#69
The gir1.2-appindicator3-0.1 package was deprecated in Debian 13 (trixie)
and replaced with gir1.2-ayatana-appindicator3. This change adds fallback
logic to try the new package if the old one is not available.
Changes:
- install.sh: Try old package first, fall back to ayatana-appindicator
- docs/INSTALL.md: Document both package options
- src/vocalinux/main.py: Update error message with Debian 13+ note
- CONTRIBUTING.md: Update dev setup instructions
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* fix: clean up whitespace in filtered package list
---------
Co-authored-by: Claude Opus <noreply@anthropic.com>
