Voice Mode
Hermes Agent supports full voice interaction across CLI and messaging platforms. Talk to the agent using your microphone, hear spoken replies, and have live voice conversations in Discord voice channels.
If you want a practical setup walkthrough with recommended configurations and real usage patterns, see Use Voice Mode with Hermes.
Prerequisites
Before using voice features, make sure you have:
- Hermes Agent installed —
pip install hermes-agent(see Installation) - An LLM provider configured — run
hermes modelor set your preferred provider credentials in~/.hermes/.env - A working base setup — run
hermesto verify the agent responds to text before enabling voice
The ~/.hermes/ directory and default config.yaml are created automatically the first time you run hermes. You only need to create ~/.hermes/.env manually for API keys.
Overview
| Feature | Platform | Description |
|---|---|---|
| Interactive Voice | CLI | Press Ctrl+B to record, agent auto-detects silence and responds |
| Auto Voice Reply | Telegram, Discord | Agent sends spoken audio alongside text responses |
| Voice Channel | Discord | Bot joins VC, listens to users speaking, speaks replies back |
Requirements
Python Packages
# CLI voice mode (microphone + audio playback)
pip install hermes-agent[voice]
# Discord + Telegram messaging (includes discord.py[voice] for VC support)
pip install hermes-agent[messaging]
# Premium TTS (ElevenLabs)
pip install hermes-agent[tts-premium]
# Everything at once
pip install hermes-agent[all]
| Extra | Packages | Required For |
|---|---|---|
voice | sounddevice, numpy | CLI voice mode |
messaging | discord.py[voice], python-telegram-bot, aiohttp | Discord & Telegram bots |
tts-premium | elevenlabs | ElevenLabs TTS provider |
discord.py[voice] installs PyNaCl (for voice encryption) and opus bindings automatically. This is required for Discord voice channel support.
System Dependencies
# macOS
brew install portaudio ffmpeg opus
# Ubuntu/Debian
sudo apt install portaudio19-dev ffmpeg libopus0
| Dependency | Purpose | Required For |
|---|---|---|
| PortAudio | Microphone input and audio playback | CLI voice mode |
| ffmpeg | Audio format conversion (MP3 → Opus, PCM → WAV) | All platforms |
| Opus | Discord voice codec | Discord voice channels |
API Keys
Add to ~/.hermes/.env:
# Speech-to-Text — local provider needs NO key at all
# pip install faster-whisper # Free, runs locally, recommended
GROQ_API_KEY=your-key # Groq Whisper — fast, free tier (cloud)
VOICE_TOOLS_OPENAI_KEY=your-key # OpenAI Whisper — paid (cloud)
# Text-to-Speech (optional — Edge TTS works without any key)
ELEVENLABS_API_KEY=your-key # ElevenLabs — premium quality
If faster-whisper is installed, voice mode works with zero API keys for STT. The model (~150 MB for base) downloads automatically on first use.
CLI Voice Mode
Quick Start
Start the CLI and enable voice mode:
hermes # Start the interactive CLI
Then use these commands inside the CLI:
/voice Toggle voice mode on/off
/voice on Enable voice mode
/voice off Disable voice mode
/voice tts Toggle TTS output
/voice status Show current state
How It Works
- Start the CLI with
hermesand enable voice mode with/voice on - Press Ctrl+B — a beep plays (880Hz), recording starts
- Speak — a live audio level bar shows your input:
● [▁▂▃▅▇▇▅▂] ❯ - Stop speaking — after 3 seconds of silence, recording auto-stops
- Two beeps play (660Hz) confirming the recording ended
- Audio is transcribed via Whisper and sent to the agent
- If TTS is enabled, the agent's reply is spoken aloud
- Recording automatically restarts — speak again without pressing any key
This loop continues until you press Ctrl+B during recording (exits continuous mode) or 3 consecutive recordings detect no speech.
The record key is configurable via voice.record_key in ~/.hermes/config.yaml (default: ctrl+b).
Silence Detection
Two-stage algorithm detects when you've finished speaking:
- Speech confirmation — waits for audio above the RMS threshold (200) for at least 0.3s, tolerating brief dips between syllables
- End detection — once speech is confirmed, triggers after 3.0 seconds of continuous silence
If no speech is detected at all for 15 seconds, recording stops automatically.
Both silence_threshold and silence_duration are configurable in config.yaml.
Streaming TTS
When TTS is enabled, the agent speaks its reply sentence-by-sentence as it generates text — you don't wait for the full response:
- Buffers text deltas into complete sentences (min 20 chars)
- Strips markdown formatting and
<think>blocks - Generates and plays audio per sentence in real-time
Hallucination Filter
Whisper sometimes generates phantom text from silence or background noise ("Thank you for watching", "Subscribe", etc.). The agent filters these out using a set of 26 known hallucination phrases across multiple languages, plus a regex pattern that catches repetitive variations.
Gateway Voice Reply (Telegram & Discord)
If you haven't set up your messaging bots yet, see the platform-specific guides:
Start the gateway to connect to your messaging platforms:
hermes gateway # Start the gateway (connects to configured platforms)
hermes gateway setup # Interactive setup wizard for first-time configuration
Discord: Channels vs DMs
The bot supports two interaction modes on Discord:
| Mode | How to Talk | Mention Required | Setup |
|---|---|---|---|
| Direct Message (DM) | Open the bot's profile → "Message" | No | Works immediately |
| Server Channel | Type in a text channel where the bot is present | Yes (@botname) | Bot must be invited to the server |
DM (recommended for personal use): Just open a DM with the bot and type — no @mention needed. Voice replies and all commands work the same as in channels.
Server channels: The bot only responds when you @mention it (e.g. @hermesbyt4 hello). Make sure you select the bot user from the mention popup, not the role with the same name.
To disable the mention requirement in server channels, add to ~/.hermes/.env:
DISCORD_REQUIRE_MENTION=false
Or set specific channels as free-response (no mention needed):
DISCORD_FREE_RESPONSE_CHANNELS=123456789,987654321
Commands
These work in both Telegram and Discord (DMs and text channels):
/voice Toggle voice mode on/off
/voice on Voice replies only when you send a voice message
/voice tts Voice replies for ALL messages
/voice off Disable voice replies
/voice status Show current setting
Modes
| Mode | Command | Behavior |
|---|---|---|
off | /voice off | Text only (default) |
voice_only | /voice on | Speaks reply only when you send a voice message |
all | /voice tts | Speaks reply to every message |
Voice mode setting is persisted across gateway restarts.
Platform Delivery
| Platform | Format | Notes |
|---|---|---|
| Telegram | Voice bubble (Opus/OGG) | Plays inline in chat. ffmpeg converts MP3 → Opus if needed |
| Discord | Native voice bubble (Opus/OGG) | Plays inline like a user voice message. Falls back to file attachment if voice bubble API fails |
Discord Voice Channels
The most immersive voice feature: the bot joins a Discord voice channel, listens to users speaking, transcribes their speech, processes through the agent, and speaks the reply back in the voice channel.
Setup
1. Discord Bot Permissions
If you already have a Discord bot set up for text (see Discord Setup Guide), you need to add voice permissions.
Go to the Discord Developer Portal → your application → Installation → Default Install Settings → Guild Install:
Add these permissions to the existing text permissions:
| Permission | Purpose | Required |
|---|---|---|
| Connect | Join voice channels | Yes |
| Speak | Play TTS audio in voice channels | Yes |
| Use Voice Activity | Detect when users are speaking | Recommended |
Updated Permissions Integer:
| Level | Integer | What's Included |
|---|---|---|
| Text only | 274878286912 | View Channels, Send Messages, Read History, Embeds, Attachments, Threads, Reactions |
| Text + Voice | 274881432640 | All above + Connect, Speak |
Re-invite the bot with the updated permissions URL:
https://discord.com/oauth2/authorize?client_id=YOUR_APP_ID&scope=bot+applications.commands&permissions=274881432640
Replace YOUR_APP_ID with your Application ID from the Developer Portal.
Re-inviting the bot to a server it's already in will update its permissions without removing it. You won't lose any data or configuration.
2. Privileged Gateway Intents
In the Developer Portal → your application → Bot → Privileged Gateway Intents, enable all three:
| Intent | Purpose |
|---|---|
| Presence Intent | Detect user online/offline status |
| Server Members Intent | Map voice SSRC identifiers to Discord user IDs |
| Message Content Intent | Read text message content in channels |
All three are required for full voice channel functionality. Server Members Intent is especially critical — without it, the bot cannot identify who is speaking in the voice channel.
3. Opus Codec
The Opus codec library must be installed on the machine running the gateway:
# macOS (Homebrew)
brew install opus
# Ubuntu/Debian
sudo apt install libopus0
The bot auto-loads the codec from:
- macOS:
/opt/homebrew/lib/libopus.dylib - Linux:
libopus.so.0
4. Environment Variables
# ~/.hermes/.env
# Discord bot (already configured for text)
DISCORD_BOT_TOKEN=your-bot-token
DISCORD_ALLOWED_USERS=your-user-id
# STT — local provider needs no key (pip install faster-whisper)
# GROQ_API_KEY=your-key # Alternative: cloud-based, fast, free tier
# TTS — optional, Edge TTS (free) is the default
# ELEVENLABS_API_KEY=your-key # Premium quality
Start the Gateway
hermes gateway # Start with existing configuration
The bot should come online in Discord within a few seconds.
Commands
Use these in the Discord text channel where the bot is present:
/voice join Bot joins your current voice channel
/voice channel Alias for /voice join
/voice leave Bot disconnects from voice channel
/voice status Show voice mode and connected channel
You must be in a voice channel before running /voice join. The bot joins the same VC you're in.
How It Works
When the bot joins a voice channel, it:
- Listens to each user's audio stream independently
- Detects silence — 1.5s of silence after at least 0.5s of speech triggers processing
- Transcribes the audio via Whisper STT (local, Groq, or OpenAI)
- Processes through the full agent pipeline (session, tools, memory)
- Speaks the reply back in the voice channel via TTS
Text Channel Integration
When the bot is in a voice channel:
- Transcripts appear in the text channel:
[Voice] @user: what you said - Agent responses are sent as text in the channel AND spoken in the VC
- The text channel is the one where
/voice joinwas issued
Echo Prevention
The bot automatically pauses its audio listener while playing TTS replies, preventing it from hearing and re-processing its own output.
Access Control
Only users listed in DISCORD_ALLOWED_USERS can interact via voice. Other users' audio is silently ignored.
# ~/.hermes/.env
DISCORD_ALLOWED_USERS=284102345871466496
Configuration Reference
config.yaml
# Voice recording (CLI)
voice:
record_key: "ctrl+b" # Key to start/stop recording
max_recording_seconds: 120 # Maximum recording length
auto_tts: false # Auto-enable TTS when voice mode starts
silence_threshold: 200 # RMS level (0-32767) below which counts as silence
silence_duration: 3.0 # Seconds of silence before auto-stop
# Speech-to-Text
stt:
provider: "local" # "local" (free) | "groq" | "openai"
local:
model: "base" # tiny, base, small, medium, large-v3
# model: "whisper-1" # Legacy: used when provider is not set
# Text-to-Speech
tts:
provider: "edge" # "edge" (free) | "elevenlabs" | "openai"
edge:
voice: "en-US-AriaNeural" # 322 voices, 74 languages
elevenlabs:
voice_id: "pNInz6obpgDQGcFmaJgB" # Adam
model_id: "eleven_multilingual_v2"
openai:
model: "gpt-4o-mini-tts"
voice: "alloy" # alloy, echo, fable, onyx, nova, shimmer
Environment Variables
# Speech-to-Text providers (local needs no key)
# pip install faster-whisper # Free local STT — no API key needed
GROQ_API_KEY=... # Groq Whisper (fast, free tier)
VOICE_TOOLS_OPENAI_KEY=... # OpenAI Whisper (paid)
# STT advanced overrides (optional)
STT_GROQ_MODEL=whisper-large-v3-turbo # Override default Groq STT model
STT_OPENAI_MODEL=whisper-1 # Override default OpenAI STT model
GROQ_BASE_URL=https://api.groq.com/openai/v1 # Custom Groq endpoint
STT_OPENAI_BASE_URL=https://api.openai.com/v1 # Custom OpenAI STT endpoint
# Text-to-Speech providers (Edge TTS needs no key)
ELEVENLABS_API_KEY=... # ElevenLabs (premium quality)
# OpenAI TTS uses VOICE_TOOLS_OPENAI_KEY
# Discord voice channel
DISCORD_BOT_TOKEN=...
DISCORD_ALLOWED_USERS=...
STT Provider Comparison
| Provider | Model | Speed | Quality | Cost | API Key |
|---|---|---|---|---|---|
| Local | base | Fast (depends on CPU/GPU) | Good | Free | No |
| Local | small | Medium | Better | Free | No |
| Local | large-v3 | Slow | Best | Free | No |
| Groq | whisper-large-v3-turbo | Very fast (~0.5s) | Good | Free tier | Yes |
| Groq | whisper-large-v3 | Fast (~1s) | Better | Free tier | Yes |
| OpenAI | whisper-1 | Fast (~1s) | Good | Paid | Yes |
| OpenAI | gpt-4o-transcribe | Medium (~2s) | Best | Paid | Yes |
Provider priority (automatic fallback): local > groq > openai
TTS Provider Comparison
| Provider | Quality | Cost | Latency | Key Required |
|---|---|---|---|---|
| Edge TTS | Good | Free | ~1s | No |
| ElevenLabs | Excellent | Paid | ~2s | Yes |
| OpenAI TTS | Good | Paid | ~1.5s | Yes |
Troubleshooting
"No audio device found" (CLI)
PortAudio is not installed:
brew install portaudio # macOS
sudo apt install portaudio19-dev # Ubuntu
Bot doesn't respond in Discord server channels
The bot requires an @mention by default in server channels. Make sure you:
- Type
@and select the bot user (with the #discriminator), not the role with the same name - Or use DMs instead — no mention needed
- Or set
DISCORD_REQUIRE_MENTION=falsein~/.hermes/.env
Bot joins VC but doesn't hear me
- Check your Discord user ID is in
DISCORD_ALLOWED_USERS - Make sure you're not muted in Discord
- The bot needs a SPEAKING event from Discord before it can map your audio — start speaking within a few seconds of joining
Bot hears me but doesn't respond
- Verify STT is available: install
faster-whisper(no key needed) or setGROQ_API_KEY/VOICE_TOOLS_OPENAI_KEY - Check the LLM model is configured and accessible
- Review gateway logs:
tail -f ~/.hermes/logs/gateway.log
Bot responds in text but not in voice channel
- TTS provider may be failing — check API key and quota
- Edge TTS (free, no key) is the default fallback
- Check logs for TTS errors
Whisper returns garbage text
The hallucination filter catches most cases automatically. If you're still getting phantom transcripts:
- Use a quieter environment
- Adjust
silence_thresholdin config (higher = less sensitive) - Try a different STT model