Installation¶

Quick Install¶

pipuv (tool)

pip install mlx-audio

Install the CLI tools globally with uv:

# Latest release from PyPI
uv tool install --force mlx-audio --prerelease=allow

Or install from the latest source:

# Latest code from GitHub
uv tool install --force git+https://github.com/Blaizzy/mlx-audio.git --prerelease=allow

Optional Extras¶

mlx-audio ships optional dependency groups so you only install what you need:

Extra	What it includes
`tts`	Text-to-speech dependencies
`stt`	Speech-to-text dependencies
`sts`	Speech-to-speech dependencies
`docs`	MkDocs and API reference tooling
`all`	Everything (TTS + STT + STS)
`dev`	Development and testing tools

Install extras with bracket syntax:

# TTS only
pip install "mlx-audio[tts]"

# STT only
pip install "mlx-audio[stt]"

# Everything
pip install "mlx-audio[all]"

# Documentation tooling
pip install "mlx-audio[docs]"

Development Setup¶

Clone the repository and install in editable mode with dev dependencies:

git clone https://github.com/Blaizzy/mlx-audio.git
cd mlx-audio
pip install -e ".[dev]"

If you are working on the docs site, use:

pip install -e ".[dev,docs]"

ffmpeg¶

ffmpeg is required for saving audio in MP3, FLAC, OGG, Opus, or Vorbis format. WAV works without it.

macOS (Homebrew)Ubuntu / Debian

brew install ffmpeg

sudo apt install ffmpeg

Tip

If you only need WAV output, you can skip installing ffmpeg entirely.