About Spurt

Spurt is a cross-platform push-to-talk dictation tool powered by whisper.cpp. It allows users to press and hold a hotkey, speak into their microphone, and then release the key to have their words automatically typed into the active window. This tool aims to streamline the dictation process, making it more efficient and accessible.

Key Features:

• Cross-Platform Compatibility: Works on Windows, macOS, and Linux (with experimental support for Linux).

• AI-Powered Transcription: Utilizes the advanced whisper.cpp engine for accurate speech-to-text conversion.

• Push-to-Talk Functionality: Intuitive control with a hotkey that activates dictation when held and stops when released.

• Automatic Typing: Dictated text is seamlessly inserted into the currently active application window.

• Multiple Installation Options: Available via Homebrew, as pre-built binaries, or by running from source.

• Configurable: Users can customize the whisper model, trigger key, and key mode to suit their preferences.

• Model Variety: Supports various whisper models, from small and fast to large and highly accurate, including multilingual options.

• Easy Setup: Sensible defaults are provided, requiring minimal configuration for immediate use.

Installation and Usage:

Spurt can be installed using Homebrew on macOS and Linux, or by downloading pre-built binaries for Windows, Linux, and macOS. For developers, it can also be run directly from the source code. Once installed, the tool can be started with a simple command, and the whisper model downloads automatically on the first run. Users can further configure settings such as the model, trigger key, and key mode through the command-line interface.

Troubleshooting and Reference:

The project includes comprehensive troubleshooting guides for common issues like microphone problems, model download failures, and key detection issues. Detailed reference information is also provided, including available models, key modes, configuration file locations, model cache locations, project structure, and dependencies.