Fügt generierte OpenWiki-Docs (Architektur, Domain, Betrieb, Tests, Workflows) sowie den GitHub-Actions-Workflow zur automatischen Aktualisierung hinzu. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
3.4 KiB
type, title, description, tags
| type | title | description | tags | |||||
|---|---|---|---|---|---|---|---|---|
| Quickstart | whisper-local — Schnellstart | Lokales Push-to-Talk Speech-to-Text-Tool mit faster-whisper. Hotkey halten, sprechen, loslassen — Text wird ins aktive Textfeld eingefügt. Kein Cloud-Service, kein Netzwerk. |
|
whisper-local — Schnellstart
whisper-local ist ein lokales Speech-to-Text-Tool für Linux (KDE Plasma / Wayland) und Windows 10/11. Ein systemweiter Hotkey (Standard: F12) wird gehalten, um Audio aufzunehmen; beim Loslassen transkribiert faster-whisper lokal und der Text wird ins aktive Textfeld eingefügt. Die App läuft als Hintergrunddienst mit Tray-Icon.
Installation
Voraussetzung: uv (Python-Paketmanager), Python ≥ 3.13.
git clone <repo-url> whisper-local
cd whisper-local
uv sync
Linux-Systemabhängigkeiten
sudo pacman -S ydotool wl-clipboard libayatana-appindicator gobject-introspection
sudo systemctl enable --now ydotool
sudo usermod -aG input $USER # Neu-Login nötig
ydotool simuliert Tastatureingaben unter Wayland, wl-clipboard ermöglicht Clipboard-Zugriff, libayatana-appindicator + gobject-introspection stellen das Tray-Icon bereit.
Windows benötigt keine zusätzlichen System-Dependencies.
Starten
uv run whisper-local
Beim ersten Start lädt faster-whisper das Whisper-Modell (Standard: small) herunter — ein Fortschrittsdialog erscheint. Danach ist der Hotkey aktiv und das Tray-Icon zeigt den Zustand an (grau = warten, rot = aufnehmen, gelb = transkribieren).
Konfiguration
Die Konfigurationsdatei wird beim ersten Start automatisch angelegt:
- Linux:
~/.config/whisper-local/config.toml - Windows:
%APPDATA%\whisper-local\config.toml
Vorlage: config.example.toml. Hotkey und Mikrofon lassen sich auch über den Einstellungs-Dialog im Tray-Icon ändern (Rechtsklick → „Einstellungen"). Änderungen greifen sofort ohne Neustart. Siehe Operations-Runbook für Details.
Entwicklung
uv run pytest # Tests
uv run python -m whisper_local # Direkt starten
Wiki-Übersicht
| Bereich | Seite | Inhalt |
|---|---|---|
| Architektur | Architektur-Übersicht | Factory-Pattern, Protocol-Interfaces, Plattform-Dispatch, Modul-Graph |
| Architektur | Source-Map | Verzeichnisstruktur, Datei-Referenzen |
| Workflows | Aufnahme-Zyklus | Push-to-Talk-Flow, Media-Pause, Mikrofon-Überwachung |
| Domain | Plattform-Abstraktionen | Hotkey, Inserter, Media, Microphone — Backends je Plattform |
| Operations | Runbook | Konfiguration, Autostart, Build/Packaging, CI, Versionsverwaltung |
| Testing | Test-Leitfaden | pytest-Setup, plattformspezifische Tests, Mocking-Muster |
Backlog
- Linux-Inserter unter X11: Aktuell nur Wayland (
wl-copy+ydotool). X11 wird nicht unterstützt. — Grund: Projekt zielt auf KDE/Wayland ab. - Silero VAD-Integration: faster-whisper enthält Silero VAD, wird aber nicht explizit konfiguriert. — Grund: Keine Quell-Referenz gefunden; nur in PyInstaller-Spec als Bundle-Dependency sichtbar.