# marmalade-tts

> Unified local TTS CLI: a single command (`marmalade-tts`) wraps seven
> local TTS engines (kitten, kokoro, piper, coqui, pocket, matcha,
> emojivoice) behind one interface, one config file, one set of flags.
> No cloud APIs. Each engine installs into its own venv.

Repo: https://github.com/maxwhipw/marmalade-tts
License: MIT

## Documentation

- [README.md](README.md): project overview, quick install, examples — see "Voice aliases / personas" for config-defined named bundles (narrator/villain/etc.) invoked positionally like an engine name, "Subtitles (SRT / WebVTT)" for the `--srt` / `--vtt` flags that emit a synchronized subtitle file per batch (cue text is the user's raw input, so typed emoji/markdown survive even though they're stripped before synthesis), "Uninstalling" under "Installing engines" for the tiered `marmalade-tts uninstall [<engine>] [--engines] [--purge] [--dry-run] [-y]` command (whitelisted-path safety, never touches the CLI binary or HF cache), and "Batch synthesis" for the streaming-playback note (line N plays as soon as it renders, while line N+1 is still being synthesized in the background)
- [INSTALL.md](INSTALL.md): platform-specific install paths (pip, .deb, AUR, docker)
- [docs/engine-knobs.md](docs/engine-knobs.md): every per-engine parameter (voice, speed, expressivity knobs, model-specific options) and how to pass it
- [docs/voice-cloning.md](docs/voice-cloning.md): voice cloning how-to — pocket (English, instant) and Coqui XTTS v2 (17 languages), with reference-clip quality tips
- [docs/mcp.md](docs/mcp.md): MCP (Model Context Protocol) server — three tools (synthesize, list_voices, find_voice) for AI agents to drive marmalade-tts directly; install with `pip install marmalade-tts[mcp]`
- [docs/ROADMAP.md](docs/ROADMAP.md): planned and in-flight work
- [ENGINE-GUIDE.md](ENGINE-GUIDE.md): step-by-step guide for adding a new TTS engine (14-file checklist + speed-handling convention)
- [config-default.yaml](config-default.yaml): annotated default config — copy to `~/.config/marmalade-tts/config.yaml`
- [SPEC.md](SPEC.md): CLI surface specification
- [PACKAGING.md](PACKAGING.md): notes for distro packagers

## Optional

- [CHANGELOG.md](CHANGELOG.md): version history
- [CONTRIBUTING.md](CONTRIBUTING.md): contribution guide
- [SECURITY.md](SECURITY.md): security policy
