Skip to content

kleinq/bettervoice

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BetterVoice

macOS voice-to-text application with real-time transcription using Whisper.

Features

  • 🎤 Push-to-talk recording with customizable hotkeys
  • 🧠 Local AI transcription using Whisper
  • Text enhancement with context-aware formatting
  • 📋 Auto-paste to any application
  • 🔒 Privacy-first - all processing happens locally
  • ⚙️ Customizable settings - hotkeys, audio input, models, and more

Quick Start

Building

# Clone the repository
git clone <repository-url>
cd bettervoice

# Build and run
make run

Important: Always use make build or make run to ensure proper library linking. See docs/BUILDING.md for details.

First Launch

  1. Permissions Setup - On first launch, BetterVoice will guide you through:

    • Microphone access (required for recording)
    • Accessibility access (required for auto-paste)
  2. Recording - Press ⌘R (or your custom hotkey) to start recording, release to transcribe and paste

  3. Settings - Access via menu bar icon:

    • Change hotkeys
    • Select audio input device
    • Download/select Whisper models
    • Configure cloud enhancement (optional)

Distribution

For End Users

Quick Install:

  1. Download the DMG file
  2. Drag BetterVoice.app to Applications
  3. Right-click and select "Open" (first time only)
  4. Grant required permissions

See QUICK_DISTRIBUTION_GUIDE.md for detailed installation instructions.

For Developers

Package for distribution:

make release    # Build and create DMG in one step

This creates a BetterVoice-v1.0.dmg ready to distribute.

See docs/DISTRIBUTION.md for:

  • Detailed packaging options
  • Code signing & notarization
  • Distribution methods
  • Release checklist

Development

See docs/BUILDING.md for detailed build instructions and troubleshooting.

Requirements

  • macOS 12.0+
  • Xcode 14.0+
  • Swift 5.9+

Available Commands

make build      # Build the app in Debug mode
make run        # Build and run the app
make clean      # Clean build artifacts
make package    # Package for distribution
make release    # Build Release and create DMG
make help       # Show all commands

Project Structure

BetterVoice/
├── App/                    # App lifecycle and state
├── Views/                  # SwiftUI views
├── Services/              # Core services (audio, whisper, paste)
├── Models/                # Data models
└── Utilities/             # Helpers and extensions

scripts/                   # Build and setup scripts
docs/                      # Documentation

License

[License details here]

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors