Testing

Use targeted checks for small changes and broader checks before shipping cross-surface work.

Python

python3 -m venv .venv
source .venv/bin/activate
pip install -e .
pytest tests/

Focused examples:

pytest tests/test_config.py tests/test_cli_lifecycle.py
pytest tests/test_flow.py -v
pytest -m integration -v

tests/test_flow.py and integration tests can require live transcription and grammar services.

Swift

cd LocalWhisperUI
swift build -c release

Run this after Swift UI edits and whenever IPC message contracts change.

Flutter

cd src/flutter/local_whisper
flutter pub get
flutter analyze
flutter test
flutter build ios --simulator --debug
flutter build apk --debug

After a WhisperKit pack is installed in a simulator:

flutter test integration_test/native_transcription_test.dart -d <simulator-id> --dart-define=LOCAL_WHISPER_MODEL_PATH=<installed-model-folder>

Apple SpeechTranscriber uses the same integration test on supported physical iOS 26 hardware:

flutter test integration_test/native_transcription_test.dart -d <device-id> --dart-define=LOCAL_WHISPER_E2E_MODEL=apple_speech

An iOS 26 simulator can build and execute the availability path but may report SpeechTranscriber unavailable because the model runtime depends on supported hardware.

Documentation

Run from doc/:

mint validate
mint broken-links
mint export --output export.zip
mint dev --no-open --port 3333

The docs source is doc/. Keep Mintlify pages, assets, snippets, and configuration there.

Manual smoke checks

wh status
wh start
Double-tap Right Option to record.
Tap Right Option or Space to stop and verify the clipboard result.
Press Esc to cancel when needed.
Hold Right Option past the double-tap threshold, release to stop, and verify paste-at-cursor behavior.
Verify overlay states.
Verify menu bar state.
Verify selected-text shortcuts when those surfaces change.

Start

Product

Reference

Python

Swift

Flutter

Documentation

Manual smoke checks

​Python

​Swift

​Flutter

​Documentation

​Manual smoke checks

Python

Swift

Flutter

Documentation

Manual smoke checks