Skip to main content

Wyoming Server for MLX whisper

Project description

Wyoming MLX Whisper

PyPI Python License Pre-commit

Wyoming protocol server for mlx-whisper speech-to-text on Apple Silicon.

Uses mlx-community/whisper-large-v3-turbo by default, which runs near real-time on M1 Pro and newer.

Available Models

Model Size Speed Quality
mlx-community/whisper-tiny 75 MB ⚡⚡⚡ Fastest Basic
mlx-community/whisper-small-mlx 481 MB ⚡⚡ Fast Good
mlx-community/whisper-large-v3-turbo 1.6 GB ⚡⚡ Near real-time Best (default)
mlx-community/whisper-large-v3-turbo-q4 464 MB ⚡⚡ Near real-time Near-best

Use --model <name> to select a different model. Use --initial-prompt <text> to guide recognition with custom vocabulary.

[ToC] 📚

Requirements

  • macOS with Apple Silicon (M1/M2/M3/M4)
  • Python 3.10-3.13 (3.14 not yet supported by numba)
  • uv (recommended) or pip

Installation

Using uvx (recommended, no install needed)

uvx --python 3.12 wyoming-mlx-whisper

Using pip

pip install wyoming-mlx-whisper
wyoming-mlx-whisper

Usage

Run directly

# With uvx (no install needed)
uvx --python 3.12 wyoming-mlx-whisper

# Or if installed with pip
wyoming-mlx-whisper

Run as macOS service (launchd)

Download and run the install script:

curl -fsSL https://raw.githubusercontent.com/basnijholt/wyoming-mlx-whisper/main/scripts/install_service.sh | bash

The server runs at tcp://localhost:10300 by default.

Uninstall the service:

curl -fsSL https://raw.githubusercontent.com/basnijholt/wyoming-mlx-whisper/main/scripts/uninstall_service.sh | bash

View logs:

tail -f ~/Library/Logs/wyoming-mlx-whisper/*.log

Options

See the output of wyoming-mlx-whisper --help

 Usage: wyoming-mlx-whisper [OPTIONS]

 Run the Wyoming MLX Whisper server.

╭─ Options ──────────────────────────────────────────────────────────────────────────────╮
│ --uri                               TEXT  unix:// or tcp://                            │
│                                           [env var: WHISPER_URI]                       │
│                                           [default: tcp://0.0.0.0:10300]               │
│ --model                             TEXT  Name of MLX Whisper model to use             │
│                                           [env var: WHISPER_MODEL]                     │
│                                           [default:                                    │
│                                           mlx-community/whisper-large-v3-turbo]        │
│ --language                          TEXT  Language code (e.g., 'en')                   │
│                                           [env var: WHISPER_LANGUAGE]                  │
│ --initial-prompt                    TEXT  Initial prompt to guide Whisper recognition  │
│                                           [env var: WHISPER_INITIAL_PROMPT]            │
│ --debug               --no-debug          Log DEBUG messages  [env var: WHISPER_DEBUG] │
│                                           [default: no-debug]                          │
│ --version                                 Print version and exit                       │
│ --help            -h                      Show this message and exit.                  │
╰────────────────────────────────────────────────────────────────────────────────────────╯

Home Assistant Integration

  1. Start the server (using any method above)
  2. In Home Assistant, go to Settings → Devices & Services → Add Integration
  3. Search for "Wyoming Protocol"
  4. Enter localhost (or your Mac's IP) and port 10300

The Whisper STT service will now be available for voice assistants.

Related Projects

  • agent-cli - Local-first AI-powered CLI agents for voice transcription, autocorrect, voice editing, and more. Uses wyoming-mlx-whisper as its default ASR backend on Apple Silicon.

Development

uv sync
uv run pre-commit install

Acknowledgements

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wyoming_mlx_whisper-1.5.0.tar.gz (104.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wyoming_mlx_whisper-1.5.0-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file wyoming_mlx_whisper-1.5.0.tar.gz.

File metadata

  • Download URL: wyoming_mlx_whisper-1.5.0.tar.gz
  • Upload date:
  • Size: 104.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for wyoming_mlx_whisper-1.5.0.tar.gz
Algorithm Hash digest
SHA256 81be86d1c4bbe346856e1b598590fc5693cbab50ec6e33312bbf21a0e53dd443
MD5 45f6172eeb80eee682ed3a587ae37d46
BLAKE2b-256 a2190842f2d493c9b560bb600b7939821da37ea148ce9d17b07800bcd697620c

See more details on using hashes here.

Provenance

The following attestation bundles were made for wyoming_mlx_whisper-1.5.0.tar.gz:

Publisher: release.yml on basnijholt/wyoming-mlx-whisper

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file wyoming_mlx_whisper-1.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for wyoming_mlx_whisper-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a6a93ef93b22217e99e63b62499618ccc0fb6dff598e6da24e59598a2d3fb5db
MD5 1d6c30a7f09baf2736524142dc9910a1
BLAKE2b-256 0f26e39334ced10c577d9ceef684df034989e3b200043bbce878a64366638994

See more details on using hashes here.

Provenance

The following attestation bundles were made for wyoming_mlx_whisper-1.5.0-py3-none-any.whl:

Publisher: release.yml on basnijholt/wyoming-mlx-whisper

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page