https://github.com/ashwin-pc/whisper-dictation
A macOS application that converts speech to text using OpenAI's Whisper model running locally. Press the Globe/Function key to start recording, press it again to stop recording, transcribe, and paste text at your current cursor position.
https://github.com/ashwin-pc/whisper-dictation
Last synced: about 1 year ago
JSON representation
A macOS application that converts speech to text using OpenAI's Whisper model running locally. Press the Globe/Function key to start recording, press it again to stop recording, transcribe, and paste text at your current cursor position.
- Host: GitHub
- URL: https://github.com/ashwin-pc/whisper-dictation
- Owner: ashwin-pc
- License: mit
- Created: 2025-02-27T22:03:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-10T03:21:58.000Z (over 1 year ago)
- Last Synced: 2025-03-27T09:23:34.944Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 13.7 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Whisper Dictation
**Note: This application is for macOS only.**
A macOS application that converts speech to text using OpenAI's Whisper model running locally. Press the Globe/Function key to start recording, press it again to stop recording, transcribe, and paste text at your current cursor position.
## Features
- System tray (menu bar) application that runs in the background
- Global hotkey (Globe/Function key) to trigger dictation
- Transcribes speech to text using OpenAI's Whisper model locally
- Automatically pastes transcribed text at your cursor position
- Visual feedback with menu bar icon status
## Setup and Installation
### Development Setup
1. Install Python dependencies:
```
pip install -r requirements.txt
```
2. Install PortAudio (required for PyAudio):
```
brew install portaudio
```
3. Run the application in development mode:
```
python src/main.py
```
### Running the Script in the Background
To run the script in the background:
1. Install all dependencies:
```
pip install -r requirements.txt
```
2. Run the script in the background:
```
nohup ./run.sh >/dev/null 2>&1 & disown
```
3. The script will continue running in the background. You can then use the app as described in the Usage section.
## Usage
1. Launch the Whisper Dictation app. You'll see a microphone icon (🎙️) in your menu bar.
2. Press the Globe key or Function key on your keyboard to start recording.
3. Speak clearly into your microphone.
4. Press the Globe/Function key again to stop recording.
5. The app will transcribe your speech and automatically paste it at your current cursor position.
You can also interact with the app through the menu bar icon:
- Click "Start/Stop Listening" to toggle recording
- Access Settings for configuration options
- Click "Quit" to exit the application
## Permissions
The app requires the following permissions:
- Microphone access (to record your speech).
Go to System Preferences → Security & Privacy → Privacy → Microphone and add your Terminal or the app.
- Accessibility access (to simulate keyboard presses for pasting).
Go to System Preferences → Security & Privacy → Privacy → Accessibility and add your Terminal or the app.
## Requirements
- macOS 10.14 or later
- Microphone
## Troubleshooting
If something goes wrong or you need to stop the background process, you can kill it by running one of the following commands in your Terminal:
1. List the running process(es):
```
ps aux | grep 'src/main.py'
```
2. Kill the process by its PID:
```
kill -9
```