Zum Inhalt
DokumentationDoku
Doku-Navigation: macOSCLI Tool

macOS

CLI Tool

Ein shell-freundliches Kommandozeilen-Tool, das sich für Transkription, Modellverwaltung, Audioeinstellungen und portable Einstellungs-Backups mit dem lokalen TypeWhisper-API-Server verbindet.

Auf dieser Seite

Installation

Installiere die CLI über die TypeWhisper-App: Einstellungen > Erweitert > Kommandozeilen-Tool > Kommandozeilen-Tool installieren. Dies platziert die typewhisper Binary unter /usr/local/bin/typewhisper.

Wichtig

Die TypeWhisper-App muss mit aktiviertem API-Server laufen. Die CLI erkennt den aktuellen Port und das Token automatisch über api-discovery.json.

Befehle

status

Prüfen, ob der API-Server läuft und welches Modell geladen ist.

shell

typewhisper status

models

Alle verfügbaren Modelle und ihren Status auflisten.

shell

typewhisper models

models load

Verfügbar ab TypeWhisper 1.8.

Ein Modell bei Bedarf herunterladen, laden und für die Transkription auswählen. Die Engine- und Modell-IDs liefert typewhisper models. Der Befehl wartet, bis das Modell bereit ist, bei einem Download bis zu zehn Minuten, und gibt dann den Status aus. Mit --json erhältst du die API-Antwort.

shell

typewhisper models load --engine parakeet --model parakeet-tdt-0.6b-v3
Ausgabe

ready: parakeet parakeet-tdt-0.6b-v3

models unload

Verfügbar ab TypeWhisper 1.8.

Das aktive Modell einer Engine entladen, um Arbeitsspeicher freizugeben. Die heruntergeladenen Dateien bleiben auf deinem Mac. Der Befehl erwartet nur --engine; mit --model bricht er mit einem Fehler ab.

shell

typewhisper models unload --engine parakeet
Ausgabe

unloaded: parakeet parakeet-tdt-0.6b-v3

models delete

Verfügbar ab TypeWhisper 1.8.

Die heruntergeladenen Dateien eines Modells löschen. Das funktioniert nur bei Engines, die ihre Modelldownloads selbst verwalten, etwa WhisperKit. Bei anderen Engines wie Parakeet meldet TypeWhisper einen Fehler.

shell

typewhisper models delete --engine whisper --model openai_whisper-large-v3_turbo
Ausgabe

deleted: whisper openai_whisper-large-v3_turbo

HTTP-API: Modelle laden, entladen und löschen

transcribe

Eine Audiodatei oder per Pipe eingegebenes Audio transkribieren.

shell

typewhisper transcribe recording.wav

export

Alle unterstützten Einstellungen in eine JSON-Datei im TypeWhisper-Backupformat exportieren.

shell

typewhisper export typewhisper-settings.json

import

Alle Kategorien eines TypeWhisper-Einstellungs-Backups importieren und eine Zusammenfassung übernommener und übersprungener Daten ausgeben.

shell

typewhisper import typewhisper-settings.json

import --replace

Verfügbar ab TypeWhisper 1.8.

Ein Backup wie mit import importieren und zusätzlich Workflows, Profile und Prompt-Aktionen mit gleichem Namen sowie die Hotkey-Slots aus dem Backup überschreiben. So übernimmst du Änderungen, die du in einer exportierten Datei gemacht hast. Gelöscht wird nichts; Profile behalten ihre Priorität und Workflows ihre Position. Mit --json erhältst du die API-Antwort.

shell

typewhisper import typewhisper-settings.json --replace
Ausgabe

Workflows: 0 imported, 1 updated, 7 skipped
Dictionary: 0 imported, 52 skipped
Snippets: 0 imported, 6 skipped
Prompt Actions: 0 imported, 0 updated, 2 skipped
Profiles: 0 imported, 0 updated, 2 skipped
Hotkeys: 1 applied, 7 skipped
Plugins: 0 installed, 2 skipped
History: 0 imported, 41 skipped as duplicates, 0 skipped by retention
Preferences: 27 applied
Update channel applied

HTTP-API: Einstellungs-Backup: API und CLI

audio

Verfügbar ab TypeWhisper 1.8.

Den Eingang der nächsten Aufnahme, die Mikrofon-Priorität, die angeschlossenen Eingabegeräte mit ihren Geräte-IDs sowie die Einstellungen für Audio Ducking, Medienpause und Sound-Feedback anzeigen. Mit --json erhältst du die API-Antwort, etwa zum Speichern.

shell

typewhisper audio
Ausgabe

Active input: MacBook Pro Microphone [BuiltInMicrophoneDevice]
Input priority:
  1. HyperX QuadCast 2 [AppleUSBAudioEngine:HyperX:QuadCast 2] (not connected)
Available inputs:
  MacBook Pro Microphone [BuiltInMicrophoneDevice] (system default)
  BlackHole 2ch [BlackHole2ch_UID]
Audio ducking: on (20% volume)
Pause media during recording: off
Sound feedback: on

audio set

Verfügbar ab TypeWhisper 1.8.

Audioeinstellungen mit einem JSON-Objekt aus einer Datei oder mit - von stdin ändern. Wie in der API enthält das Objekt nur die Felder, die du ändern willst. Danach gibt der Befehl die neuen Einstellungen aus. Solange ein Diktat oder eine Recorder-Aufnahme läuft oder noch verarbeitet wird, lehnt TypeWhisper die Änderung ab.

shell

echo '{"input_priority":[{"id":"BlackHole2ch_UID"}]}' | typewhisper audio set -

HTTP-API: Audioeinstellungen

Große Dateien

Wenn du einen lokalen Dateipfad übergibst, reicht die CLI den Pfad an die laufende TypeWhisper-App weiter, statt die Dateibytes hochzuladen. Dadurch gilt das HTTP-Upload-Limit nicht für große Aufnahmen.

Per Pipe übergebenes stdin nutzt weiterhin den Upload-Endpunkt /v1/transcribe und ist auf 256 MiB begrenzt. Größere stdin-Uploads liefern 413 Payload Too Large.

Einstellungs-Backups und Dotfiles

export und import verwenden dasselbe JSON-Schema wie Einstellungen > Erweitert > Sicherung & Wiederherstellung. Relative Pfade beziehen sich auf das aktuelle Verzeichnis, ~ wird aufgelöst und Exporte werden atomar geschrieben. Mit --json erhältst du eine maschinenlesbare Exportbestätigung oder Importantwort.

shell

mkdir -p ~/.config/typewhisper
typewhisper export ~/.config/typewhisper/settings.json
typewhisper import ~/.config/typewhisper/settings.json
typewhisper import ~/.config/typewhisper/settings.json --json
typewhisper import ~/.config/typewhisper/settings.json --replace

Der Import führt Daten mit dem Ziel-Mac zusammen, statt ihn vorher zu leeren, und löscht nichts. Doppelte Wörterbucheinträge und Snippets sowie nicht verfügbare oder bereits installierte Plugins werden übersprungen, belegte Hotkey-Slots bleiben erhalten und alter Verlauf kann durch die Aufbewahrungsregel des Ziel-Macs ausgelassen werden. Ab TypeWhisper 1.8 werden auch Workflows, Profile, Prompt-Aktionen und Verlaufseinträge übersprungen, die unverändert vorhanden sind. Ein Backup auf den Mac zurückzuspielen, von dem es stammt, verdoppelt also nichts. Geänderte Einträge kommen als neue hinzu, außer du ergänzt --replace.

Wichtig

Backups können Transkriptionsverlauf, Prompts, App- und Website-Regeln sowie weitere persönliche Konfiguration enthalten. Prüfe ein Backup, bevor du es in ein Dotfiles-Repository eincheckst. Die CLI liest $XDG_CONFIG_HOME/typewhisper/config.toml nicht automatisch.

Optionen

FlagBeschreibung
--portDen automatisch erkannten API-Server-Port überschreiben
--api-tokenDas erkannte Bearer-Token überschreiben; TYPEWHISPER_API_TOKEN bietet dieselbe Möglichkeit
--devDie Discovery-Datei von TypeWhisper-Dev statt der Release-App verwenden
--jsonMaschinenlesbares JSON ausgeben
--help / -h / --versionBefehlshilfe oder installierte CLI-Version anzeigen
--languageISO 639-1-Sprachcode (z.B. en, de)
--language-hintWiederholbare, geordnete Sprachauswahl; nicht mit --language kombinierbar
--tasktranscribe (Standard) oder Sprache mit WhisperKit über translate ins Englische übersetzen
--translate-toEinen Apple-Translate-Schritt für die Zielsprache ausführen (z.B. de, fr; macOS 15+)
--enginetranscribe: die Transkriptions-Engine für diesen Request überschreiben. models load, models unload und models delete: die Engine, auf die sich der Befehl bezieht
--modeltranscribe: das Transkriptionsmodell für diesen Request überschreiben. models load und models delete: das Modell, auf das sich der Befehl bezieht
--await-downloadAuf Wiederherstellung oder Modelldownload einer lokalen Engine warten, statt 409 zurückzugeben
--no-correctionsRohe Engine-Ausgabe ohne nachträgliche Wörterbuchkorrekturen zurückgeben
--replaceimport: zusätzlich Workflows, Profile und Prompt-Aktionen mit gleichem Namen sowie die Hotkey-Slots aus dem Backup überschreibenVerfügbar ab TypeWhisper 1.8.

Beispiele

Datei transkribieren:

shell

typewhisper transcribe meeting.m4a

Audio von stdin einlesen:

shell

ffmpeg -i video.mp4 -f wav - | typewhisper transcribe -

JSON-Ausgabe mit jq:

shell

typewhisper transcribe --json recording.wav | jq .text

Ins Deutsche übersetzen:

shell

typewhisper transcribe --translate-to de recording.wav

Benutzerdefinierten Port verwenden:

shell

typewhisper --port 9000 status

Ein portables Backup in ein Dotfiles-Verzeichnis exportieren:

shell

mkdir -p ~/.config/typewhisper
typewhisper export ~/.config/typewhisper/settings.json

Ein Backup wiederherstellen und eine maschinenlesbare Zusammenfassung erhalten:

shell

typewhisper import settings.json --json

Verfügbar ab TypeWhisper 1.8. Änderungen übernehmen, die du in dieser Datei gemacht hast, auch geänderte Hotkeys:

shell

typewhisper import ~/.config/typewhisper/settings.json --replace

Verfügbar ab TypeWhisper 1.8. Für einen Auftrag zu einem anderen Modell wechseln und es danach entladen, um Arbeitsspeicher freizugeben. models load macht das Modell auch zum ausgewählten Modell in TypeWhisper. Lade danach dein übliches Modell, um zurückzuwechseln:

shell

typewhisper models
typewhisper models load --engine whisper \
  --model openai_whisper-large-v3_turbo
typewhisper transcribe interview.m4a > interview.txt
typewhisper models unload --engine whisper

Verfügbar ab TypeWhisper 1.8. Eine Zeit lang von BlackHole 2ch aufnehmen und danach deine Audioeinstellungen wiederherstellen:

shell

if typewhisper audio --json > audio-settings.json.tmp &&
  mv audio-settings.json.tmp audio-settings.json; then
  echo '{"input_priority":[{"id":"BlackHole2ch_UID"}],"audio_ducking_enabled":false}' |
    typewhisper audio set -
  printf '%s ' "Spiele Sprache in BlackHole 2ch ab, diktiere sie und drücke dann die Eingabetaste, um deine Einstellungen wiederherzustellen."
  read -r _
  jq 'del(.input_devices, .active_input)' audio-settings.json |
    typewhisper audio set -
fi

Bleib bei TypeWhisper dran

Folge uns für Release-Hinweise, Workflow-Tipps und Produkt-Updates, während die App lädt.