Skip to content

Raunaks068619/VoiceFlow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🎙️ VoiceFlow

VoiceFlow is a macOS menu-bar voice typing app inspired by Freeflow workflows.

✨ Highlights

  • Hold a hotkey to record, release to transcribe
  • Smart output modes: Verbatim, Clean, Clean + Hinglish
  • Dictation vs Rewrite mode
  • Background-noise filtering
  • Paste-based insertion for stable typing

🖼️ Product Showcase

Menu Bar Popover

VoiceFlow Menu

Settings (General)

VoiceFlow Settings

Settings (Advanced)

VoiceFlow Advanced Settings

Onboarding Flow

VoiceFlow Onboarding

English Transcription Example

English Transcription Example

Hindi + English (Hinglish) Example

Hindi English Hinglish Example

🧰 Requirements

  • macOS 13+
  • Xcode 15+
  • OpenAI API key

🚀 Run Locally

  1. Open VoiceFlow.xcodeproj in Xcode
  2. Select scheme VoiceFlow
  3. Run: Product -> Run

VoiceFlow runs as a menu-bar app (no Dock icon by design).

🔐 First-Time Setup

  1. Add your OpenAI API key
  2. Grant Microphone permission
  3. Grant Accessibility permission
  4. Recommended: grant Input Monitoring
    • System Settings -> Privacy & Security -> Input Monitoring
    • Add VoiceFlow.app from Xcode build output if needed

⌨️ Hotkeys

  • Primary: Fn
  • Fallback: Right Option

If Fn does not work:

  1. Set System Settings -> Keyboard -> Press 🌐 key to = Do Nothing
  2. Disable/reassign Dictation shortcut from Press 🌐 Twice
  3. Use Right Option fallback

⚙️ Settings Guide

  • Language: Auto-detect recommended
  • Output Quality:
    • Verbatim: closest to raw speech
    • Clean: grammar/punctuation cleanup
    • Clean + Hinglish: English stays English, Hindi becomes Latin-script Hindi
  • Transcription Mode:
    • Dictation: preserve spoken phrasing
    • Rewrite: cleaner final intent text
  • Microphone Filter:
    • Higher value = more background filtering
    • Good starting range: 0.008 to 0.012

🧠 Transcription Pipeline

  1. Record audio
  2. Voice activity filtering (with fallback)
  3. STT transcription (primary + fallback model)
  4. Post-processing by mode/style
  5. Inject text into active app

🛠️ Troubleshooting

UI works but no transcription output

Check Xcode logs:

  • Recording started
  • Recording stopped
  • Transcription success: ... chars
  • Transcription error: ...

Hotkey not triggering

  • Verify Accessibility permission
  • Verify Input Monitoring permission
  • Try Right Option fallback

Too much background speech

  • Increase Microphone Filter
  • Reduce ambient noise / use better mic

Wrong language/script style

Use:

  • Language: Auto-detect
  • Output Quality: Clean + Hinglish
  • Transcription Mode: Dictation

📁 Project Structure

  • Sources/App - app lifecycle and menu bar behavior
  • Sources/Services - recording, hotkeys, transcription, injection
  • Sources/Views - popover, onboarding, settings, overlay
  • Resources - plist and entitlements

📝 Notes

  • Built for local development and testing with Xcode
  • OpenAI API usage incurs model-based costs

About

VoiceFlow is a macOS menu-bar voice typing app inspired by Freeflow workflows.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages