Voicemode

🚀 Voice Mode

Voice Mode enables natural voice conversations for AI assistants, bringing human-like voice interactions to Claude, ChatGPT, and other LLMs through the Model Context Protocol (MCP).

🚀 Quick Start

📖 Using a different tool? See our Integration Guides for Cursor, VS Code, Gemini CLI, and more!

npm install -g @anthropic-ai/claude-code
curl -LsSf https://astral.sh/uv/install.sh | sh
claude mcp add --scope user voice-mode uvx voice-mode
export OPENAI_API_KEY=your-openai-key
claude converse

✨ Features

• 🎙️ Voice conversations with Claude - ask questions and hear responses
• 🔄 Multiple transports - local microphone or LiveKit room-based communication
• 🗣️ OpenAI-compatible - works with any STT/TTS service (local or cloud)
• ⚡ Real-time - low-latency voice interactions with automatic transport selection
• 🔧 MCP Integration - seamless with Claude Desktop and other MCP clients
• 🎯 Silence detection - automatically stops recording when you stop speaking (no more waiting!)

📦 Installation

Prerequisites

• Python >= 3.10
• Astral UV - Package manager (install with curl -LsSf https://astral.sh/uv/install.sh | sh)
• OpenAI API Key (or compatible service)

System Dependencies

sudo apt update
sudo apt install -y python3-dev libasound2-dev libasound2-plugins libportaudio2 portaudio19-dev ffmpeg pulseaudio pulseaudio-utils

sudo dnf install python3-devel alsa-lib-devel portaudio-devel ffmpeg

# Install Homebrew if not already installed
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install dependencies
brew install portaudio ffmpeg

nix develop github:mbailey/voicemode

Quick Install

# Using Claude Code (recommended)
claude mcp add --scope user voice-mode uvx voice-mode

# Using Claude Code with Nix (NixOS)
claude mcp add voice-mode nix run github:mbailey/voicemode

# Using UV
uvx voice-mode

# Using pip
pip install voice-mode

# Using Nix (NixOS)
nix run github:mbailey/voicemode

Configuration for AI Coding Assistants

📖 Looking for detailed setup instructions? Check our comprehensive Integration Guides for step-by-step instructions for each tool!

Below are quick configuration snippets. For full installation and setup instructions, see the integration guides above.

claude mcp add voice-mode -- uvx voice-mode

claude mcp add voice-mode --env OPENAI_API_KEY=your-openai-key -- uvx voice-mode

{
  "mcpServers": {
    "voice-mode": {
      "command": "uvx",
      "args": ["voice-mode"],
      "env": {
        "OPENAI_API_KEY": "your-openai-key"
      }
    }
  }
}

{
  "mcpServers": {
    "voice-mode": {
      "command": "cmd",
      "args": ["/c", "uvx", "voice-mode"],
      "env": {
        "OPENAI_API_KEY": "your-openai-key"
      }
    }
  }
}

{
  "mcpServers": {
    "voice-mode": {
      "command": "uvx",
      "args": ["voice-mode"],
      "env": {
        "OPENAI_API_KEY": "your-openai-key"
      }
    }
  }
}

{
  "experimental": {
    "modelContextProtocolServers": [
      {
        "transport": {
          "type": "stdio",
          "command": "uvx",
          "args": ["voice-mode"],
          "env": {
            "OPENAI_API_KEY": "your-openai-key"
          }
        }
      }
    ]
  }
}

{
  "mcpServers": {
    "voice-mode": {
      "command": "uvx",
      "args": ["voice-mode"],
      "env": {
        "OPENAI_API_KEY": "your-openai-key"
      }
    }
  }
}

{
  "mcpServers": {
    "voice-mode": {
      "command": "uvx",
      "args": ["voice-mode"],
      "env": {
        "OPENAI_API_KEY": "your-openai-key"
      }
    }
  }
}

{
  "mcpServers": {
    "voice-mode": {
      "command": "uvx",
      "args": ["voice-mode"],
      "env": {
        "OPENAI_API_KEY": "your-openai-key"
      }
    }
  }
}

{
  "context_servers": {
    "voice-mode": {
      "command": {
        "path": "uvx",
        "args": ["voice-mode"],
        "env": {
          "OPENAI_API_KEY": "your-openai-key"
        }
      }
    }
  }
}

{
  "mcpServers": {
    "voice-mode": {
      "command": "uvx",
      "args": ["voice-mode"],
      "env": {
        "OPENAI_API_KEY": "your-openai-key"
      }
    }
  }
}

Alternative Installation Options

docker run -it --rm \
  -e OPENAI_API_KEY=your-openai-key \
  --device /dev/snd \
  -v /tmp/.X11-unix:/tmp/.X11-unix \
  -e DISPLAY=$DISPLAY \
  ghcr.io/mbailey/voicemode:latest

pipx install voice-mode

git clone https://github.com/mbailey/voicemode.git
cd voicemode
pip install -e .

nix profile install github:mbailey/voicemode

# In /etc/nixos/configuration.nix
environment.systemPackages = [
  (builtins.getFlake "github:mbailey/voicemode").packages.${pkgs.system}.default
];

# In home-manager configuration
home.packages = [
  (builtins.getFlake "github:mbailey/voicemode").packages.${pkgs.system}.default
];

nix run github:mbailey/voicemode

💻 Usage Examples

Basic Usage

Once configured, try these prompts with Claude:

👨‍💻 Programming & Development

• "Let's debug this error together" - Explain the issue verbally, paste code, and discuss solutions
• "Walk me through this code" - Have Claude explain complex code while you ask questions
• "Let's brainstorm the architecture" - Design systems through natural conversation
• "Help me write tests for this function" - Describe requirements and iterate verbally

💡 General Productivity

• "Let's do a daily standup" - Practice presentations or organize your thoughts
• "Interview me about [topic]" - Prepare for interviews with back-and-forth Q&A
• "Be my rubber duck" - Explain problems out loud to find solutions

🎯 Voice Control Features

• "Read this error message" (Claude speaks, then waits for your response)
• "Just give me a quick summary" (Claude speaks without waiting)
• Use converse("message", wait_for_response=False) for one-way announcements

Advanced Usage

The converse function makes voice interactions natural - it automatically waits for your response by default, creating a real conversation flow.

📚 Documentation

Getting Started

• Integration Guides - Step-by-step setup for all supported tools
• Configuration Guide - Complete environment variable reference

Development

• Using uv/uvx - Package management with uv and uvx
• Local Development - Development setup guide
• Audio Formats - Audio format configuration and migration
• Statistics Dashboard - Performance monitoring and metrics

Service Guides

• Whisper.cpp Setup - Local speech-to-text configuration
• Kokoro Setup - Local text-to-speech configuration
• LiveKit Integration - Real-time voice communication

Troubleshooting

• WSL2 Microphone Access - WSL2 audio setup
• Migration Guide - Upgrading from older versions

🔧 Technical Details

Tools

Note: The converse tool is the primary interface for voice interactions, combining speaking and listening in a natural flow.

New: The install_whisper_cpp and install_kokoro_fastapi tools help you set up free, private, open-source voice services locally. See Installation Tools Documentation for detailed usage.

Configuration

• 📖 Integration Guides - Step-by-step setup for each tool
• 🔧 Configuration Reference - All environment variables
• 📁 Config Examples - Ready-to-use configuration files

Quick Setup

The only required configuration is your OpenAI API key:

export OPENAI_API_KEY="your-key"

Optional Settings

# Custom STT/TTS services (OpenAI-compatible)
export STT_BASE_URL="http://127.0.0.1:2022/v1"  # Local Whisper
export TTS_BASE_URL="http://127.0.0.1:8880/v1"  # Local TTS
export TTS_VOICE="alloy"                        # Voice selection

# Or use voice preference files (see Configuration docs)
# Project: /your-project/voices.txt or /your-project/.voicemode/voices.txt
# User: ~/voices.txt or ~/.voicemode/voices.txt

# LiveKit (for room-based communication)
# See docs/livekit/ for setup guide
export LIVEKIT_URL="wss://your-app.livekit.cloud"
export LIVEKIT_API_KEY="your-api-key"
export LIVEKIT_API_SECRET="your-api-secret"

# Debug mode
export VOICEMODE_DEBUG="true"

# Save all audio (TTS output and STT input)
export VOICEMODE_SAVE_AUDIO="true"

# Audio format configuration (default: pcm)
export VOICEMODE_AUDIO_FORMAT="pcm"         # Options: pcm, mp3, wav, flac, aac, opus
export VOICEMODE_TTS_AUDIO_FORMAT="pcm"     # Override for TTS only (default: pcm)
export VOICEMODE_STT_AUDIO_FORMAT="mp3"     # Override for STT upload

# Format-specific quality settings
export VOICEMODE_OPUS_BITRATE="32000"       # Opus bitrate (default: 32kbps)
export VOICEMODE_MP3_BITRATE="64k"          # MP3 bitrate (default: 64k)

Audio Format Configuration

Voice Mode uses PCM audio format by default for TTS streaming for optimal real-time performance:

• PCM (default for TTS): Zero latency, best streaming performance, uncompressed
• MP3: Wide compatibility, good compression for uploads
• WAV: Uncompressed, good for local processing
• FLAC: Lossless compression, good for archival
• AAC: Good compression, Apple ecosystem
• Opus: Small files but NOT recommended for streaming (quality issues)

The audio format is automatically validated against provider capabilities and will fallback to a supported format if needed.

Local STT/TTS Services

For privacy-focused or offline usage, Voice Mode supports local speech services:

• Whisper.cpp - Local speech-to-text with OpenAI-compatible API
• Kokoro - Local text-to-speech with multiple voice options

These services provide the same API interface as OpenAI, allowing seamless switching between cloud and local processing.

OpenAI API Compatibility Benefits

By strictly adhering to OpenAI's API standard, Voice Mode enables powerful deployment flexibility:

• 🔀 Transparent Routing: Users can implement their own API proxies or gateways outside of Voice Mode to route requests to different providers based on custom logic (cost, latency, availability, etc.)
• 🎯 Model Selection: Deploy routing layers that select optimal models per request without modifying Voice Mode configuration
• 💰 Cost Optimization: Build intelligent routers that balance between expensive cloud APIs and free local models
• 🔧 No Lock-in: Switch providers by simply changing the BASE_URL - no code changes required

Example: Simply set OPENAI_BASE_URL to point to your custom router:

export OPENAI_BASE_URL="https://router.example.com/v1"
export OPENAI_API_KEY="your-key"
# Voice Mode now uses your router for all OpenAI API calls

The OpenAI SDK handles this automatically - no Voice Mode configuration needed!

Architecture

┌─────────────────────┐     ┌──────────────────┐     ┌─────────────────────┐
│   Claude/LLM        │     │  LiveKit Server  │     │  Voice Frontend     │
│   (MCP Client)      │◄────►│  (Optional)     │◄───►│  (Optional)         │
└─────────────────────┘     └──────────────────┘     └─────────────────────┘
         │                            │
         │                            │
         ▼                            ▼
┌─────────────────────┐     ┌──────────────────┐
│  Voice MCP Server   │     │   Audio Services │
│  • converse         │     │  • OpenAI APIs   │
│  • listen_for_speech│◄───►│  • Local Whisper │
│  • check_room_status│     │  • Local TTS     │
│  • check_audio_devices    └──────────────────┘
└─────────────────────┘

🐛 Troubleshooting

Common Issues

⚠️ Important Note

• No microphone access: Check system permissions for terminal/application. For WSL2 users, see WSL2 Microphone Access Guide.
• UV not found: Install with curl -LsSf https://astral.sh/uv/install.sh | sh.
• OpenAI API error: Verify your OPENAI_API_KEY is set correctly.
• No audio output: Check system audio settings and available devices.

Debug Mode

export VOICEMODE_DEBUG=true

Debug audio files are saved to: ~/voicemode_recordings/

Audio Diagnostics

python scripts/diagnose-wsl-audio.py

This will check for required packages, audio services, and provide specific recommendations.

Audio Saving

export VOICEMODE_SAVE_AUDIO=true

Audio files are saved to: ~/voicemode_audio/ with timestamps in the filename.

📄 License

MIT - A Failmode Project

_{Project Statistics}

📎 Links

• Website: getvoicemode.com
• Documentation: voice-mode.readthedocs.io
• GitHub: github.com/mbailey/voicemode
• PyPI: pypi.org/project/voice-mode
• npm: npmjs.com/package/voicemode

Community

• Discord: Join our community
• Twitter/X: @getvoicemode
• YouTube: @getvoicemode

See Also

• 🚀 Integration Guides - Setup instructions for all supported tools
• 🔧 Configuration Reference - Environment variables and options
• 🎤 Local Services Setup - Run TTS/STT locally for privacy
• 🐛 Troubleshooting - Common issues and solutions