README.md
April 3, 2026 · View on GitHub
Yap
Push-to-talk dictation for macOS. Hold a hotkey, speak, text appears.
Features
- Push-to-talk — Hold
⌥Spaceto record, or press once to toggle - Auto-paste — Transcribed text is pasted directly into the active app
- Multi-provider STT — Groq (Whisper v3 Turbo), OpenAI (Whisper-1), Deepgram (Nova-3)
- Vietnamese + English — Auto-detect or lock to a specific language
- Recording controls — Mic selector, noise suppression, live input meter, mic test
- Transcription history — Copy any previous transcription with one click
- Menu bar app — Always ready, no dock icon
Install
Homebrew (recommended)
brew install --cask sonpiaz/tap/yap
Build from source
git clone https://github.com/sonpiaz/yap.git
cd yap
brew install xcodegen # if not installed
make run
Quick Start
- Open Yap from menu bar
- Go to Settings → add your API key (Groq, OpenAI, or Deepgram)
- Choose STT provider and language
- Hold
⌥Spaceand speak
Requirements
- macOS 14.0 (Sonoma) or later
- API key from one of: Groq, OpenAI, or Deepgram
- Accessibility permission (for auto-paste)
- Microphone permission
Privacy
Yap sends audio data only to the STT provider you choose for transcription. No audio is stored locally or sent anywhere else. API keys are stored in UserDefaults on your Mac.
Development
make generate # Generate Xcode project
make build # Build via xcodebuild
make run # Build and run
make clean # Clean build artifacts
Project Structure
Sources/Yap/
├── YapApp.swift — App entry, menu bar
├── Audio/ — AVFoundation audio capture
├── Transcription/ — STT provider integration (Groq/OpenAI/Deepgram)
├── Input/ — Hotkey management, text insertion
├── Settings/ — Settings UI
└── History/ — Transcription history
Tech Stack
| Technology | Purpose |
|---|---|
| Swift 5.9 | Language |
| SwiftUI | UI framework |
| AVFoundation | Audio capture |
| Cloud STT APIs | Groq, OpenAI, Deepgram |
| XcodeGen | Project generation |
Contributing
Contributions are welcome. See CONTRIBUTING.md for guidelines.
Related
- Kapt — macOS screenshot tool with annotation & OCR
- hidrix-tools — MCP server for web & social search
- affiliate-skills — 45 AI agent skills
- content-pipeline — AI-powered LinkedIn content generation
License
MIT — see LICENSE for details.
Built by Son Piaz