# 
Vocalinux
[](https://github.com/jatinkrmalik/vocalinux/actions)
[](https://codecov.io/gh/jatinkrmalik/vocalinux)
[](https://github.com/jatinkrmalik/vocalinux)
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://www.python.org/downloads/)
[](CONTRIBUTING.md)
[](https://github.com/jatinkrmalik/vocalinux/issues)
[](https://github.com/jatinkrmalik/vocalinux/releases)
**A seamless voice dictation system for Linux**, comparable to the built-in solutions on macOS and Windows.
> π **Alpha Release!** We're excited to share Vocalinux with the community. Try it out and [let us know what you think](https://github.com/jatinkrmalik/vocalinux/issues)!
---
## β¨ Features
- π€ **Double-tap Ctrl** to start/stop voice dictation
- β‘ **Real-time transcription** with minimal latency
- οΏ½οΏ½ **Universal compatibility** across all Linux applications
- π **Offline operation** for privacy and reliability (with VOSK)
- π€ **Optional Whisper AI** support for enhanced accuracy
- π¨ **System tray integration** with visual status indicators
- π **Audio feedback** for recording status
- βοΈ **Graphical settings** dialog for easy configuration
## π Quick Install
### One-liner Installation (Recommended)
```bash
curl -fsSL https://raw.githubusercontent.com/jatinkrmalik/vocalinux/main/install.sh | bash
```
This will:
- Clone the repository
- Install all dependencies
- Set up a virtual environment in `~/.local/share/vocalinux/venv`
- Create a symlink at `~/.local/bin/vocalinux`
### Alternative: Install from Source
```bash
# Clone the repository
git clone https://github.com/jatinkrmalik/vocalinux.git
cd vocalinux
# Run the installer
./install.sh
```
The installer handles everything: system dependencies, Python environment, speech models, and desktop integration.
### After Installation
```bash
# 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**: Ubuntu 22.04+ (other Linux distros may work)
- **Python**: 3.8 or newer
- **Display**: X11 or Wayland
- **Hardware**: Microphone for voice input
## ποΈ 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
```bash
vocalinux --help # Show all options
vocalinux --debug # Enable debug logging
vocalinux --engine whisper # Use Whisper AI engine
vocalinux --model medium # Use medium-sized model
vocalinux --wayland # Force Wayland mode
```
## βοΈ Configuration
Configuration is stored in `~/.config/vocalinux/config.json`:
```json
{
"speech_recognition": {
"engine": "vosk",
"model_size": "small",
"vad_sensitivity": 3,
"silence_timeout": 2.0
}
}
```
You can also configure settings through the graphical Settings dialog (right-click the tray icon).
## π§ Development Setup
```bash
# Clone and install in dev mode
git clone https://github.com/jatinkrmalik/vocalinux.git
cd vocalinux
./install.sh --dev
# Activate environment
source activate-vocalinux.sh
# 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
β βββ text_injection/ # Text injection (X11/Wayland)
β βββ ui/ # GTK UI components
β βββ utils/ # Utility functions
βββ tests/ # Test suite
βββ resources/ # Icons and sounds
βββ docs/ # Documentation
βββ web/ # Website source
```
## π Documentation
- [Installation Guide](docs/INSTALL.md) - Detailed installation instructions
- [User Guide](docs/USER_GUIDE.md) - Complete user documentation
- [Contributing](CONTRIBUTING.md) - Development setup and contribution guidelines
## πΊοΈ Roadmap
- [x] ~~Custom icon design~~ β
- [x] ~~Graphical settings dialog~~ β
- [x] ~~Whisper AI support~~ β
- [ ] Multi-language support
- [ ] Application-specific commands
- [ ] Debian/Ubuntu package (.deb)
- [ ] Improved Wayland support
- [ ] Voice command customization
## π€ Contributing
We welcome contributions! Whether it's bug reports, feature requests, or code contributions, please check out our [Contributing Guide](CONTRIBUTING.md).
### Quick Links
- π [Report a Bug](https://github.com/jatinkrmalik/vocalinux/issues/new?template=bug_report.md)
- π‘ [Request a Feature](https://github.com/jatinkrmalik/vocalinux/issues/new?template=feature_request.md)
- π¬ [Discussions](https://github.com/jatinkrmalik/vocalinux/discussions)
## π¨βπ» Author
**Jatin K Malik**
- GitHub: [@jatinkrmalik](https://github.com/jatinkrmalik)
- Twitter: [@jatinkrmalik](https://twitter.com/jatinkrmalik)
## β 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](LICENSE) file for details.
---
Made with β€οΈ for the Linux community
github.com/jatinkrmalik/vocalinux