VoiceKey 🎤

A powerful CLI tool that enables global keyboard shortcuts for voice-to-text transcription using the world’s most accurate transcription model; ElevenLabs's Scribe. Record your voice with a customizable shortcut and have it automatically transcribed and pasted into any application.

Features

• 🌐 Global Keyboard Shortcuts: Works across all applications
• 🎙️ High-Quality Transcription: Powered by ElevenLabs API
• 📋 Auto-Paste: Automatically copies and pastes transcribed text
• 🎛️ Two Recording Modes: Toggle mode (press to start/stop) or Hold mode (hold to record)
• 📊 Real-time Stats: Track your transcription usage and session statistics
• 🔔 System Notifications: Visual feedback for recording and transcription status
• ⚙️ Easy Setup: Interactive configuration for API key and shortcuts

Installation

npm install -g voicekey

Quick Start

1. Setup your configuration:

   voicekey setup

   This will guide you through:

   • Setting up your ElevenLabs API key
   • Choosing your global keyboard shortcut
   • Selecting recording mode (Toggle or Hold)

2. Start listening:

   voicekey

3. Use your shortcut to record and transcribe!

Commands

voicekey

Start the global keyboard listener. Uses your configured shortcut to record and transcribe audio.

voicekey setup

Interactive setup wizard to configure:

• ElevenLabs API key
• Global keyboard shortcut
• Recording mode

voicekey config

Display current configuration settings.

voicekey reset

Reset all configuration settings.

Recording Modes

Toggle Mode (Default)

• Press your shortcut to start recording
• Press again to stop recording and transcribe

Hold Mode

• Hold your shortcut to record
• Release to stop recording and transcribe

Keyboard Shortcuts

VoiceKey supports complex keyboard shortcuts including:

• Modifier combinations: Cmd+Ctrl+Alt+P, Shift+Ctrl+R
• Function keys: F1-F12
• Globe/Fn key: Globe+Space, Globe (alone)
• Special keys: Cmd+Space, Ctrl+Shift+V

Requirements

• Node.js: Version 14.0.0 or higher
• ElevenLabs API Key: Get yours at elevenlabs.io
• macOS: Currently optimized for macOS (uses sox for recording)

API Configuration

1. Visit ElevenLabs
2. Create an account and get your API key
3. Run voicekey setup and enter your API key when prompted

Troubleshooting

Recording Issues

• Ensure sox is installed: brew install sox (macOS)
• Check microphone permissions in System Preferences

Shortcut Not Working

• Try a different key combination
• Ensure no other application is using the same shortcut
• Run voicekey setup to reconfigure

Transcription Errors

• Check your ElevenLabs API key and account status
• Verify internet connection
• Ensure audio is clear and not too quiet

Examples

# Setup everything
voicekey setup

# Start listening with your configured shortcut
voicekey

# Check current settings
voicekey config

# Reset and start over
voicekey reset

Privacy & Security

• Audio is sent to ElevenLabs for transcription
• No audio is stored locally after transcription
• API keys are stored locally in your configuration file
• Review ElevenLabs Privacy Policy

Contributing

Issues and pull requests are welcome! Please visit our GitHub repository.

License

MIT License - see the LICENSE file for details.

Support

• 🐛 Bug Reports: GitHub Issues
• 💡 Feature Requests: GitHub Issues

Made with ❤️ for faster, hands-free typing