Voice transcription tool using Groq API with global hotkeys
Project description
Whisper Assistant
Voice-to-text tool powered by Groq's Whisper API. Press a hotkey, speak, and get instant transcription.
Get Started
Requires macOS and uv.
# Install portaudio (required for audio recording)
brew install portaudio
# Run the setup wizard
uvx whisper-assistant init
The wizard will:
- Ask for your Groq API key (free)
- Configure hotkeys and preferences
- Start the background daemon
Where files are stored (XDG Base Directory Specification):
| Path | Contents |
|---|---|
~/.config/whisper-assistant/config.env |
API key, hotkeys, preferences |
~/.local/share/whisper-assistant/history/ |
Audio recordings & transcriptions |
~/.local/state/whisper-assistant/logs/ |
Log files |
~/.local/state/whisper-assistant/daemon.pid |
Daemon process ID |
Usage
# Daemon control
whisper-assistant start
whisper-assistant stop
whisper-assistant restart
whisper-assistant status
# View logs
whisper-assistant logs
whisper-assistant logs --stderr
# Configuration
whisper-assistant config show
whisper-assistant config edit
# History
whisper-assistant history list
whisper-assistant history play 1 # play most recent recording
whisper-assistant history transcribe 1 # re-transcribe most recent
# Transcribe any audio file
whisper-assistant transcribe /path/to/audio.wav
Default hotkeys:
Ctrl+Shift+1— Toggle recording (press to start, press again to stop and transcribe)Ctrl+Shift+2— Retry last transcriptionCtrl+Shift+3— Cancel recording
Config location: ~/.config/whisper-assistant/config.env
Contributing
PRs welcome. For major changes, open an issue first.
git clone https://github.com/Futhark-AS/whisper_assistant.git
cd whisper_assistant
uv sync
uv run whisper-assistant --help
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file whisper_assistant-0.1.10.tar.gz.
File metadata
- Download URL: whisper_assistant-0.1.10.tar.gz
- Upload date:
- Size: 39.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.11 {"installer":{"name":"uv","version":"0.9.11"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
de1925038b0d278bebfdcecf9b9eaf63c84c066bbf214767ace97abe6af3b59b
|
|
| MD5 |
e697cfcdf1a85efd60fa120fda05448e
|
|
| BLAKE2b-256 |
e3ba1f82cbb69bb20297e7801ed8b51e8ca493f4529d0e58534a0ba942467bc3
|
File details
Details for the file whisper_assistant-0.1.10-py3-none-any.whl.
File metadata
- Download URL: whisper_assistant-0.1.10-py3-none-any.whl
- Upload date:
- Size: 20.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.11 {"installer":{"name":"uv","version":"0.9.11"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dd03ede9cad9462a6f1049f261c163cd9db8eb04556eb0008d44e79ae46943a4
|
|
| MD5 |
221af664bc19f3176120086bcb54f264
|
|
| BLAKE2b-256 |
07d795afcf4a1ab1e89d891304daa2df4a1661666e877934b0cd35e617cb8a16
|
