5fbea061d5
Added comprehensive documentation for text-to-speech integration via Agent Vibes MCP server. New files (8): - examples/integrations/agent-vibes/README.md - Quick start guide - examples/integrations/agent-vibes/installation.md - 18-minute setup procedure - examples/integrations/agent-vibes/voice-catalog.md - 15 voices (4 FR models, 128 speakers) - examples/integrations/agent-vibes/troubleshooting.md - 7 common issues solved - guide/workflows/tts-setup.md - Step-by-step workflow - examples/hooks/bash/tts-selective.sh - Custom selective TTS hook - examples/claude-md/tts-enabled.md - Project template Documentation: - guide/ai-ecosystem.md (section 5.1) - TTS tools overview - guide/README.md - Added TTS workflow reference - machine-readable/reference.yaml - 8 TTS entries Version updates: - VERSION: 3.11.0 → 3.11.1 - README.md: Template count 71 → 83 - CHANGELOG.md: Added v3.11.1 entry - Synced version across all docs (cheatsheet, ultimate-guide, reference.yaml) Other: - .gitignore: Added audio file exclusions (*.wav, *.mp3, *.onnx) Context: Tested Agent Vibes v3.0.0 + Piper TTS with French voices. Works offline, no cloud dependency. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
109 lines
2.8 KiB
Markdown
109 lines
2.8 KiB
Markdown
# Project with TTS Enabled
|
|
|
|
This is a template `CLAUDE.md` file for projects using Agent Vibes TTS.
|
|
|
|
## TTS Configuration
|
|
|
|
**Provider**: Piper TTS
|
|
**Voice**: fr_FR-tom-medium (French male)
|
|
**Verbosity**: Low (recommended)
|
|
**Effects**: Light reverb
|
|
**Background Music**: Disabled
|
|
|
|
## Project-Specific TTS Settings
|
|
|
|
### Mute During Focus Work
|
|
|
|
When working on tasks requiring deep concentration, mute TTS:
|
|
|
|
```bash
|
|
# Mute for this session
|
|
/agent-vibes:mute
|
|
|
|
# Unmute when done
|
|
/agent-vibes:unmute
|
|
```
|
|
|
|
### Selective TTS (Errors Only)
|
|
|
|
For this project, TTS speaks only error messages:
|
|
|
|
- ✅ Errors, failures, exceptions
|
|
- ❌ Regular responses, confirmations
|
|
- ❌ Informational messages
|
|
|
|
**Reason**: This is a critical production system where audio alerts for errors are valuable, but constant narration is distracting.
|
|
|
|
## Voice Preferences
|
|
|
|
| Task Type | Recommended Voice | Reason |
|
|
|-----------|-------------------|--------|
|
|
| Code reviews | fr_FR-tom-medium | Professional, clear |
|
|
| Documentation | fr_FR-siwis-medium | Warm, educational tone |
|
|
| Debugging | fr_FR-tom-medium (low verbosity) | Critical alerts only |
|
|
|
|
## Commands Reference
|
|
|
|
Quick reference for team members:
|
|
|
|
```bash
|
|
# Check current voice
|
|
/agent-vibes:whoami
|
|
|
|
# Switch voice
|
|
/agent-vibes:switch fr_FR-tom-medium
|
|
|
|
# Mute/unmute
|
|
/agent-vibes:mute
|
|
/agent-vibes:unmute
|
|
|
|
# Adjust verbosity
|
|
/agent-vibes:verbosity low
|
|
|
|
# Disable effects (faster)
|
|
/agent-vibes:effects off
|
|
```
|
|
|
|
## Team Guidelines
|
|
|
|
### When to Mute
|
|
|
|
- Pair programming sessions (speaker explains, TTS distracts)
|
|
- Video meetings (avoid audio conflicts)
|
|
- Deep focus work (flow state priority)
|
|
- Public spaces (avoid disturbing others)
|
|
|
|
### When to Enable
|
|
|
|
- Solo code reviews (listen while reviewing diffs)
|
|
- Long-running tasks (audio completion notifications)
|
|
- Background monitoring (alerts for errors)
|
|
- Learning mode (dual-language practice)
|
|
|
|
## Installation for Team Members
|
|
|
|
New team members should follow:
|
|
|
|
1. **Installation Guide**: [Agent Vibes Installation](../../integrations/agent-vibes/installation.md)
|
|
2. **Voice Selection**: Use `fr_FR-tom-medium` for consistency
|
|
3. **Configuration**: Copy settings from this file
|
|
|
|
## Troubleshooting
|
|
|
|
Common issues:
|
|
|
|
- **No audio**: Check `cat .claude/tts-provider.txt` → should be `piper`
|
|
- **Wrong voice**: Run `/agent-vibes:switch fr_FR-tom-medium`
|
|
- **Too verbose**: Run `/agent-vibes:verbosity low`
|
|
|
|
**Full troubleshooting**: [Agent Vibes Troubleshooting](../../integrations/agent-vibes/troubleshooting.md)
|
|
|
|
## Notes
|
|
|
|
- TTS is **optional** - not required for project contribution
|
|
- Mute status is **project-specific** (`.claude/agentvibes-muted`)
|
|
- Voice models are **shared globally** (`~/.claude/piper-voices/`)
|
|
|
|
---
|
|
|
|
*For more information about Agent Vibes TTS, see [Integration Guide](../../integrations/agent-vibes/README.md)*
|