Getting Started with VoiceMode¶
VoiceMode brings voice conversations to AI coding assistants. It works as both an MCP server for Claude Code and as a standalone CLI tool.
What is VoiceMode?¶
VoiceMode provides:
- MCP Server: Adds voice tools to Claude Code - no installation needed
- CLI Tool: Use VoiceMode's tools directly from your terminal
- Local Services: Optional privacy-focused speech processing
Quick Start: Using with Claude Code¶
The fastest way to get started is using VoiceMode with Claude Code.
Installation¶
Install UV package manager (if not already installed), then run the VoiceMode installer:
# Install UV package manager (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh
# Install VoiceMode and configure services
uvx voice-mode-install
# Add to Claude Code MCP
claude mcp add --scope user voicemode -- uvx --refresh voice-mode
The installer will:
- Install missing system dependencies (FFmpeg, PortAudio, etc.)
- Set up your environment for VoiceMode
- Offer to install local voice services (Whisper STT and Kokoro TTS)
Alternative UV installation methods: - macOS: brew install uv - With pip: pip install uv
Learn more: UV Installation Guide
2. Configure Your API Key¶
Set your OpenAI API key as an environment variable:
Or add it to your shell configuration file (~/.bashrc, ~/.zshrc, etc.)
3. Verify Installation¶
You should see voicemode in the list of connected servers.
4. Start Using Voice¶
In Claude Code, simply type:
Speak when you hear the chime, and Claude will respond with voice!
Alternative: Using as a CLI Tool¶
If you want to use VoiceMode from the command line:
Installation¶
# Install with pip
uv tool install voice-mode
# Or install from source in editable mode
git clone https://github.com/mbailey/voicemode
cd voicemode
uv tool install -e .
Basic Usage¶
# Set your API key
export OPENAI_API_KEY="sk-your-api-key-here"
# Start a voice conversation
voicemode converse
Setting Up Local Services (Optional)¶
For complete privacy, you can run voice services locally instead of using OpenAI.
Quick Setup¶
# Install local services
voicemode whisper install # Speech-to-text
voicemode kokoro install # Text-to-speech
# Start services
voicemode whisper start
voicemode kokoro start
VoiceMode will automatically detect and use these local services when available.
Learn more: Whisper Setup Guide | Kokoro Setup Guide
Configuration¶
VoiceMode works out of the box with sensible defaults. To customize:
Select Your Voice¶
# OpenAI voices
export VOICEMODE_VOICES="nova,shimmer"
# Or Kokoro voices (if using local TTS)
export VOICEMODE_VOICES="af_sky,am_adam"
Available OpenAI voices: alloy, echo, fable, onyx, nova, shimmer
Project-Specific Settings¶
Create .voicemode.env in your project:
Learn more: Configuration Guide
Troubleshooting¶
Voice Not Working in Claude?¶
-
Check MCP connection:
-
Verify OPENAI_API_KEY is set in your MCP configuration
-
Add to your MCP config:
No Audio Input?¶
Service Issues?¶
# Check service status
voicemode whisper status
voicemode kokoro status
# View logs
voicemode logs --tail 50
Next Steps¶
- Configuration Guide - Customize VoiceMode
- Development Setup - Contribute to VoiceMode
- Service Guides - Set up Whisper, Kokoro, or LiveKit
- CLI Reference - All available commands
Getting Help¶
- GitHub Issues: github.com/mbailey/voicemode/issues
- Discord: Join our community for support
Welcome to voice-enabled AI coding! 🎙️