Skip to content

Glossardi/Dictator-Speech-to-Text

Repository files navigation

Dictator: High-Performance Voice-to-Text for macOS

Dictator is a lightweight macOS menubar application that provides near-instant speech-to-text transcription using OpenAI's Whisper API. Powered by Hammerspoon, it offers a seamless workflow for dictating text directly into any application.

macOS Hammerspoon License


πŸš€ Essentials

Dictator converts speech to text with professional accuracy using the latest Whisper AI models. It sits quietly in your menubar, ready to transcribe your thoughts the moment you press a key.

Key Benefits:

  • Fast & Reliable: Near-instant transcription via Groq or OpenAI.
  • BYOK (OpenAI Standard): Support for any OpenAI-compatible API provider.
  • Privacy First: Audio is processed only by your chosen API provider.
  • Smart Formatting: Optional AI-powered grammar and punctuation refinement.
  • Native Experience: A sleek macOS menubar app that works with any text field.
  • Context Awareness: (New) Automatically detects the active app and window to adapt the correction style accordingly.

πŸ“¦ Installation

To get started, ensure you have Hammerspoon and SoX installed: brew install --cask hammerspoon sox

# 1. Clone the repository
git clone https://github.com/Glossardi/Dictator-Speech-to-Text.git ~/Documents/Dictator

# 2. Run the installer
cd ~/Documents/Dictator
./install.sh

The installer will guide you through the initial setup, including API key configuration and system permissions.


πŸ”„ Updating

Stay current with the latest transcription models and features:

Method 1: Menubar (Recommended)

Click the Dictator icon (πŸŽ™οΈ) and select Update Dictator.... This handles everything automatically.

Method 2: Terminal

cd ~/Documents/Dictator
make update

⌨️ Quick Start

  1. Grant Permissions: Ensure Hammerspoon has Accessibility and Microphone access in System Settings > Privacy & Security.
  2. Setup API: Click the πŸŽ™οΈ icon > Settings > Set API Key.
  3. Dictate: Hold the Fn key, speak, and release to transcribe directly into your focused app.

�️ Manual Override

If the automated script fails or you prefer full control, use these commands to manually install or update:

# 1. Install dependencies
brew install --cask hammerspoon sox

# 2. Copy application files
mkdir -p ~/.hammerspoon
cp -v ~/Documents/Dictator/*.lua ~/.hammerspoon/

# 3. Reload Hammerspoon
# Click icon (πŸŽ™οΈ or πŸ”¨) > Reload Config

οΏ½πŸ”§ Features at a Glance

  • πŸŽ™οΈ Hold-to-Record: Minimalist workflow with customizable hotkeys.
  • ⚑ Performance: Optimized for Groq (transcription often under 500ms).
  • πŸ”‘ BYOK: Compatible with all OpenAI-standard API providers.
  • 🎯 Precision: Support for custom technical glossaries to avoid mistakes.
  • 🧠 Context Awareness: Detects active apps (Slack, Mail, VS Code), window titles, and integrates your personal glossary to provide smarter, context-aware corrections that respect your specific terminology.
  • 🌍 Global: Multi-language support via Whisper-v3 Large models.

πŸ“„ License

This project is licensed under the MIT License.

About

πŸŽ™οΈ Lightweight macOS menubar app for voice-to-text dictation using OpenAI Whisper API. Hold-to-record with Fn key, instant transcription, auto-paste. Built with Hammerspoon.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors