* docs: update all documentation for whisper.cpp as default engine Comprehensive documentation update highlighting whisper.cpp as the new default speech recognition engine: README.md: - Added 'Major Change: whisper.cpp is Now Default!' section - Updated Features to highlight whisper.cpp and Vulkan GPU support - Updated Quick Install section with engine choices - Changed default engine from whisper to whisper_cpp in examples - Updated configuration examples - Updated roadmap to mark whisper.cpp as complete docs/INSTALL.md: - Added whisper.cpp section with performance benefits - Updated installation options (--engine flag) - Added GPU support matrix and Vulkan detection info - Added installation time comparison table - Updated system requirements (lower disk space for whisper.cpp) docs/USER_GUIDE.md: - Added comprehensive 'Choosing Your Engine' section - Added GPU acceleration information - Updated tips to mention whisper.cpp benefits - Added model size recommendations web/src/app/page.tsx: - Updated hero to mention whisper.cpp (C++ optimized, Vulkan support) - Changed installation time from ~5-10 min to ~1-2 min - Updated Features section to mention Vulkan GPU support - Added whisper.cpp as default engine card (3-column layout) - Updated installation commands (--engine flags) - Updated FAQ about switching engines This ensures all documentation reflects whisper.cpp as the new default and highlights its major benefits: 10x faster install, universal GPU support, and C++ optimized performance. * chore(release): prepare v0.6.0-beta This release brings whisper.cpp as the new default speech recognition engine: Version Updates: - Bump version from 0.5.0-beta to 0.6.0-beta - Update src/vocalinux/version.py - Update web/package.json Documentation Updates: - README.md: Update all v0.5.0-beta references to v0.6.0-beta - docs/INSTALL.md: Update version references and installation commands - docs/UPDATE.md: Add new 'What's New' section highlighting whisper.cpp - SECURITY.md: Update supported versions table (0.6.x now supported) Website Updates: - web/src/app/layout.tsx: Update softwareVersion to 0.6.0-beta Release Highlights: - whisper.cpp is now the default engine (10x faster install!) - Universal GPU support via Vulkan (AMD, Intel, NVIDIA) - C++ optimized inference with multi-threading - ~1-2 minute installation vs ~5-10 minutes before Testing: - All 472 tests passing - Black formatting clean - Flake8 linting clean - isort import ordering clean * ui(website): improve hero section layout * docs(readme): remove duplicate What's New section
5.0 KiB
Updating Vocalinux
This guide explains how to update Vocalinux to the latest version.
Quick Update (Recommended)
If You Installed via curl (One-liner)
Simply re-run the installation command with the new version tag:
curl -fsSL https://raw.githubusercontent.com/jatinkrmalik/vocalinux/main/install.sh | bash -s -- --tag=v0.6.0-beta
The installer will:
- Update your existing installation
- Preserve your configuration and models
- Install any new dependencies
Note
: The installer automatically detects and updates existing installations.
If You Installed from Source
cd vocalinux
git fetch origin
git checkout v0.6.0-beta
./install.sh
Or to always get the latest main branch:
cd vocalinux
git pull origin main
./install.sh
Detailed Update Methods
Method 1: Reinstall via Installer (Easiest)
The installer handles everything automatically:
# From the repo (if you have it cloned)
cd vocalinux
./install.sh --tag=v0.4.1-alpha
# Or via curl (for any installation)
curl -fsSL https://raw.githubusercontent.com/jatinkrmalik/vocalinux/main/install.sh | bash -s -- --tag=v0.6.0-beta
What gets preserved:
- Your configuration at
~/.config/vocalinux/ - Your speech models at
~/.local/share/vocalinux/models/ - Your custom settings and preferences
Method 2: Manual Update (Advanced)
If you prefer manual control over the update process:
# 1. Navigate to your vocalinux directory
cd vocalinux
# 2. Pull the latest changes
git fetch origin
git checkout v0.6.0-beta
# 3. Activate your virtual environment
source venv/bin/activate
# 4. Update the package
pip install --upgrade .
# 5. Exit and restart
exit
vocalinux
Checking Your Current Version
To see which version you have installed:
# Check the package version
python3 -c "import vocalinux; print(vocalinux.version.__version__)"
# Or check from the repo
git describe --tags
What's New in v0.6.0-beta
🚀 Major Feature: whisper.cpp is Now Default!
This release brings whisper.cpp as the new default speech recognition engine—a game-changing upgrade!
Key Improvements:
- ⚡ 10x faster installation — No more 2.3GB PyTorch downloads (~1-2 min vs ~5-10 min)
- 🎮 Universal GPU support — Works with AMD, Intel, and NVIDIA via Vulkan (not just NVIDIA CUDA)
- 💾 Smaller footprint — Tiny model is only ~39MB vs ~75MB
- 🔥 Better performance — C++ optimized inference with true multi-threading (no Python GIL)
- 🌍 99+ languages with automatic language detection
Additional Improvements:
- Interactive installer: Choose between 3 engines (whisper.cpp, Whisper, VOSK)
- Hardware auto-detection: Automatically detects your GPU and recommends optimal settings
- Enhanced logging: Comprehensive debug info for whisper.cpp troubleshooting
- Better documentation: Updated all docs to reflect whisper.cpp as the new default
See the full changelog.
Previous Versions
v0.4.1-alpha
- Language selector UI: Choose from 10 languages with auto-detection support for Whisper
- App drawer launch fix: Desktop entry now works when installing from local repo
- Better commit handling: Fixed error with special characters in commit messages
- Improved update mechanism: Corrected git fetch syntax for tag-based updates
v0.4.0-alpha
- Multi-language support: French, German, and Russian
- Debian 13+ compatibility: Fixed appindicator package issues
- Python 3.12+ support: Improved venv handling
- Better install script: Tag-based version selection
Troubleshooting
Update Won't Install
Symptom: Installation fails during update
Solution: Run the uninstaller first, then reinstall:
# Keep your config and models
./uninstall.sh --keep-config --keep-data
# Reinstall
curl -fsSL https://raw.githubusercontent.com/jatinkrmalik/vocalinux/main/install.sh | bash -s -- --tag=v0.6.0-beta
Old Version Still Running
Symptom: After update, old version is still active
Solution: Fully exit and restart:
# Kill any running instances
pkill -f vocalinux
# Start fresh
vocalinux
Dependencies Changed
Symptom: New version has different system dependencies
Solution: The installer handles this, but if you see errors:
sudo apt update
sudo apt install -y python3-gi python3-gi-cairo gir1.2-gtk-3.0
Automatic Updates (Coming Soon)
We're working on an in-app update mechanism. For now, please use the manual update methods above.
To check if a new version is available:
# Check latest release
curl -s https://api.github.com/repos/jatinkrmalik/vocalinux/releases/latest | grep "tag_name"