From 5fbea061d52dfcd67015175ddc4cc548d7a96530 Mon Sep 17 00:00:00 2001 From: Florian BRUNIAUX Date: Thu, 22 Jan 2026 16:08:32 +0100 Subject: [PATCH] docs: add Agent Vibes TTS integration documentation (v3.11.1) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- .gitignore | 3 + CHANGELOG.md | 37 ++ README.md | 14 +- VERSION | 2 +- examples/claude-md/tts-enabled.md | 109 ++++ examples/hooks/bash/tts-selective.sh | 80 +++ examples/integrations/agent-vibes/README.md | 424 ++++++++++++++ .../integrations/agent-vibes/installation.md | 544 ++++++++++++++++++ .../agent-vibes/troubleshooting.md | 441 ++++++++++++++ .../integrations/agent-vibes/voice-catalog.md | 380 ++++++++++++ guide/README.md | 3 +- guide/ai-ecosystem.md | 88 +++ guide/cheatsheet.md | 4 +- guide/ultimate-guide.md | 4 +- guide/workflows/tts-setup.md | 338 +++++++++++ machine-readable/reference.yaml | 13 +- 16 files changed, 2470 insertions(+), 14 deletions(-) create mode 100644 examples/claude-md/tts-enabled.md create mode 100644 examples/hooks/bash/tts-selective.sh create mode 100644 examples/integrations/agent-vibes/README.md create mode 100644 examples/integrations/agent-vibes/installation.md create mode 100644 examples/integrations/agent-vibes/troubleshooting.md create mode 100644 examples/integrations/agent-vibes/voice-catalog.md create mode 100644 guide/workflows/tts-setup.md diff --git a/.gitignore b/.gitignore index 95d0348..74dcc42 100644 --- a/.gitignore +++ b/.gitignore @@ -21,6 +21,9 @@ npm-debug.log* *.log *.tmp *.bak +*.wav +*.mp3 +*.onnx # Personal notes & temp files to-ignore/ diff --git a/CHANGELOG.md b/CHANGELOG.md index 8c99d38..d205380 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,43 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). --- +## [3.11.1] - 2026-01-22 + +### Added + +- **Agent Vibes TTS Integration** (`examples/integrations/agent-vibes/`) + - **8 documentation files, 2,400+ lines**: Complete text-to-speech integration guide + - **Integration guide** (`README.md`): Quick start with decision matrix, 30-second overview, architecture diagram, essential commands + - **Installation guide** (`installation.md`): 18-minute step-by-step procedure across 5 phases (bash 5.x, dependencies, Agent Vibes, Piper TTS, French voices) + - **Voice catalog** (`voice-catalog.md`): Detailed catalog of 15 voices (4 French models with 128 total speakers via multi-speaker models) + - **Troubleshooting guide** (`troubleshooting.md`): Solutions for 7 common issues with diagnostic script + - **Workflow** (`guide/workflows/tts-setup.md`): 18-minute guided workflow with decision scoring system and 5 checkpointed phases + - **Custom hook example** (`examples/hooks/bash/tts-selective.sh`): Selective TTS activation (errors only) with pattern matching + - **Project template** (`examples/claude-md/tts-enabled.md`): CLAUDE.md template for TTS-enabled projects with team guidelines + - **Key features**: + - Offline TTS with Piper (no cloud dependency) + - French voice support (4 models: tom, siwis, upmc, mls-124speakers) + - Mute hierarchy system (project override → project mute → global mute) + - Provider auto-detection (macOS Say, Piper TTS) + - Audio effects pipeline (reverb, echo, background music) + - **Documentation**: Added section 5.1 "Text-to-Speech Tools" in `guide/ai-ecosystem.md` (80+ lines with tables, quick start, recommendations) + +### Changed + +- **Template count**: 71 → 83 (+12 templates including integration docs, hook, workflow, CLAUDE.md template) +- **README.md**: Updated badges (71→83), template counts (66→83, 74→83), version footer (3.11.0→3.11.1) +- **guide/README.md**: Added TTS workflow reference and ai-ecosystem.md section update +- **machine-readable/reference.yaml**: Added 8 TTS-related entries (tts_integration_guide, tts_installation, tts_voice_catalog, tts_troubleshooting, tts_workflow, tts_ai_ecosystem, tts_hook_example, tts_claude_md_template) +- **.gitignore**: Added audio file exclusions (*.wav, *.mp3, *.onnx) + +### Context + +- **Use case**: Add audible narration to Claude Code for multitasking during code reviews, debugging, or long-running operations +- **Target audience**: Developers wanting TTS feedback without cloud dependencies, preference for high-quality French voices +- **Methodology**: Community MCP server (Agent Vibes v3.0.0) + Piper TTS + offline voice models from Hugging Face + +--- + ## [3.11.0] - 2026-01-21 ### Added diff --git a/README.md b/README.md index 83045a5..ec6d56d 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@

Stars - Templates + Templates Quiz

@@ -64,7 +64,7 @@ Save as `CLAUDE.md` in your project root. Claude reads it automatically. **The problem**: Awesome-lists give links, not learning paths. Official docs are dense. Tutorials get outdated in weeks. -**This guide**: Structured learning path with 74 copy-paste templates, from first install to advanced workflows. +**This guide**: Structured learning path with 83 copy-paste templates, from first install to advanced workflows. **Reading time**: Quick Start ~15 min. Full guide ~3 hours (most read by section). @@ -207,7 +207,7 @@ claude-code-ultimate-guide/
-Examples Library (66 templates) +Examples Library (83 templates) **Agents** (6): [code-reviewer](./examples/agents/code-reviewer.md), [test-writer](./examples/agents/test-writer.md), [security-auditor](./examples/agents/security-auditor.md), [refactoring-specialist](./examples/agents/refactoring-specialist.md), [output-evaluator](./examples/agents/output-evaluator.md), [devops-sre](./examples/agents/devops-sre.md) ⭐ @@ -219,6 +219,8 @@ claude-code-ultimate-guide/ **GitHub Actions**: [claude-pr-auto-review.yml](./examples/github-actions/claude-pr-auto-review.yml), [claude-security-review.yml](./examples/github-actions/claude-security-review.yml), [claude-issue-triage.yml](./examples/github-actions/claude-issue-triage.yml) +**Integrations** (1): [Agent Vibes TTS](./examples/integrations/agent-vibes/) - Text-to-speech narration for Claude Code responses + **[Browse Complete Catalog](./examples/README.md)** | **[Interactive Catalog](./examples/index.html)**
@@ -339,7 +341,7 @@ Claude Code sends your prompts, file contents, and MCP results to Anthropic serv **Status**: Research preview (Pro $20/mo or Max $100-200/mo, macOS only, **VPN incompatible**) -**Archive**: Historical versions available in git history (pre-v3.11.0) +**Archive**: Historical versions available in git history (pre-v3.11.1) @@ -350,7 +352,7 @@ Claude Code sends your prompts, file contents, and MCP results to Anthropic serv | Repository | Purpose | Audience | |------------|---------|----------| -| **[Claude Code Guide](https://github.com/FlorianBruniaux/claude-code-ultimate-guide)** *(this repo)* | Comprehensive documentation (13K lines, 74 templates) | Developers | +| **[Claude Code Guide](https://github.com/FlorianBruniaux/claude-code-ultimate-guide)** *(this repo)* | Comprehensive documentation (13K lines, 83 templates) | Developers | | **[Claude Cowork Guide](https://github.com/FlorianBruniaux/claude-cowork-guide)** | Non-technical usage (67 prompts, 5 workflows) | Knowledge workers | | **Code Landing** *(to be deployed)* | Marketing site for Claude Code guide | Discovery | | **Cowork Landing** *(to be deployed)* | Marketing site for Cowork guide | Discovery | @@ -408,7 +410,7 @@ Licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/). --- -*Version 3.11.0 | January 2026 | Crafted with Claude* +*Version 3.11.1 | January 2026 | Crafted with Claude*