{"id":44484192,"url":"https://github.com/typewhisper/typewhisper-mac","last_synced_at":"2026-05-29T10:00:50.472Z","repository":{"id":338103630,"uuid":"1156604835","full_name":"TypeWhisper/typewhisper-mac","owner":"TypeWhisper","description":"Local speech-to-text for macOS  on-device AI, fully private, optional cloud","archived":false,"fork":false,"pushed_at":"2026-05-23T08:26:23.000Z","size":64775,"stargazers_count":1224,"open_issues_count":23,"forks_count":83,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-05-23T08:28:44.230Z","etag":null,"topics":["apple-silicon","dictation","macos","on-device","privacy","speech-to-text","swiftui","transcription","whisper","whisperkit"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TypeWhisper.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":"docs/support-matrix.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null},"funding":{"github":"seofood","ko_fi":"seofood"}},"created_at":"2026-02-12T20:54:53.000Z","updated_at":"2026-05-23T08:12:56.000Z","dependencies_parsed_at":"2026-05-08T17:03:30.422Z","dependency_job_id":null,"html_url":"https://github.com/TypeWhisper/typewhisper-mac","commit_stats":null,"previous_names":["typewhisper/typewhisper-mac"],"tags_count":449,"template":false,"template_full_name":null,"purl":"pkg:github/TypeWhisper/typewhisper-mac","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeWhisper%2Ftypewhisper-mac","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeWhisper%2Ftypewhisper-mac/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeWhisper%2Ftypewhisper-mac/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeWhisper%2Ftypewhisper-mac/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TypeWhisper","download_url":"https://codeload.github.com/TypeWhisper/typewhisper-mac/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeWhisper%2Ftypewhisper-mac/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33646428,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-29T02:00:06.066Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apple-silicon","dictation","macos","on-device","privacy","speech-to-text","swiftui","transcription","whisper","whisperkit"],"created_at":"2026-02-13T01:20:06.456Z","updated_at":"2026-05-29T10:00:50.454Z","avatar_url":"https://github.com/TypeWhisper.png","language":"Swift","funding_links":["https://github.com/sponsors/seofood","https://ko-fi.com/seofood"],"categories":[],"sub_categories":[],"readme":"# TypeWhisper for Mac\n\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![macOS](https://img.shields.io/badge/macOS-14.0%2B-black.svg)](https://www.apple.com/macos/)\n[![Swift](https://img.shields.io/badge/Swift-6-orange.svg)](https://swift.org)\n\nSpeech-to-text and AI text processing for macOS. Transcribe audio using on-device AI models or cloud APIs (Groq, OpenAI, xAI/Grok), then transform the result with reusable workflows. Your voice data stays on your Mac with local models - or use cloud APIs for faster processing.\n\nTypeWhisper `1.4` is the current stable release for macOS. It includes system-wide dictation, file transcription, unified workflows, history, dictionary, snippets, bundled integrations, the community plugin registry, and local automation APIs. Advanced surfaces like the HTTP API, CLI, widgets, watch folders, and the plugin SDK remain supported for power users and automation.\n\nSee the [release readiness guide](docs/release-readiness.md), [support matrix](docs/support-matrix.md), and [release checklist](docs/release-checklist.md) for the current release definition and ship gates.\n\n\u003cp align=\"center\"\u003e\n  \u003cvideo src=\"https://github.com/user-attachments/assets/22fe922d-4a4c-47d1-805e-684a148ebd03\" autoplay loop muted playsinline width=\"270\"\u003e\u003c/video\u003e\n\u003c/p\u003e\n\n## Screenshots\n\n\u003c!-- readme-screenshots:start --\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\".github/screenshots/home.png\"\u003e\u003cimg src=\".github/screenshots/home.png\" width=\"270\" alt=\"Home Dashboard\"\u003e\u003c/a\u003e\n  \u003ca href=\".github/screenshots/recording.png\"\u003e\u003cimg src=\".github/screenshots/recording.png\" width=\"270\" alt=\"Recording \u0026amp; Hotkeys\"\u003e\u003c/a\u003e\n  \u003ca href=\".github/screenshots/workflows.png\"\u003e\u003cimg src=\".github/screenshots/workflows.png\" width=\"270\" alt=\"Workflows\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\".github/screenshots/plugins.png\"\u003e\u003cimg src=\".github/screenshots/plugins.png\" width=\"270\" alt=\"Installed Integrations\"\u003e\u003c/a\u003e\n  \u003ca href=\".github/screenshots/integrations-available.png\"\u003e\u003cimg src=\".github/screenshots/integrations-available.png\" width=\"270\" alt=\"Available Integrations\"\u003e\u003c/a\u003e\n  \u003ca href=\".github/screenshots/file-transcription.png\"\u003e\u003cimg src=\".github/screenshots/file-transcription.png\" width=\"270\" alt=\"File Transcription\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\".github/screenshots/history.png\"\u003e\u003cimg src=\".github/screenshots/history.png\" width=\"270\" alt=\"History\"\u003e\u003c/a\u003e\n  \u003ca href=\".github/screenshots/dictionary.png\"\u003e\u003cimg src=\".github/screenshots/dictionary.png\" width=\"270\" alt=\"Dictionary\"\u003e\u003c/a\u003e\n  \u003ca href=\".github/screenshots/dictionary-term-packs.png\"\u003e\u003cimg src=\".github/screenshots/dictionary-term-packs.png\" width=\"270\" alt=\"Dictionary Term Packs\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\".github/screenshots/snippets.png\"\u003e\u003cimg src=\".github/screenshots/snippets.png\" width=\"270\" alt=\"Snippets\"\u003e\u003c/a\u003e\n  \u003ca href=\".github/screenshots/general.png\"\u003e\u003cimg src=\".github/screenshots/general.png\" width=\"270\" alt=\"General Settings\"\u003e\u003c/a\u003e\n  \u003ca href=\".github/screenshots/advanced.png\"\u003e\u003cimg src=\".github/screenshots/advanced.png\" width=\"270\" alt=\"Advanced Settings\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\".github/screenshots/recorder.png\"\u003e\u003cimg src=\".github/screenshots/recorder.png\" width=\"270\" alt=\"Recorder API\"\u003e\u003c/a\u003e\n  \u003ca href=\".github/screenshots/menu-bar.png\"\u003e\u003cimg src=\".github/screenshots/menu-bar.png\" width=\"270\" alt=\"Menu Bar\"\u003e\u003c/a\u003e\n  \u003ca href=\".github/screenshots/about.png\"\u003e\u003cimg src=\".github/screenshots/about.png\" width=\"270\" alt=\"About\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003c!-- readme-screenshots:end --\u003e\n\n## What's New in 1.4\n\n- **Redesigned Integrations** - Installed, Discover, and Manual tabs now group built-in, marketplace, community, and manually installed plugins with clearer source, hosting, and capability metadata\n- **Community plugin registry** - `1.4` builds can discover community plugins through the new registry feed while older `1.3.x` builds stay on the official marketplace feed\n- **Model download controls** - Local model plugins now have clearer downloaded model management, host-version gates, Hugging Face token support, and license acceptance flows where required\n- **New bundled providers** - xAI/Grok, Smallest AI Pulse, Supertonic TTS, refreshed OpenAI voices, Qwen3 ASR, Granite, Voxtral, and Gemma 4 expand the bundled plugin set\n- **Local automation APIs** - Recorder and dictionary HTTP endpoints, watch-folder file jobs, per-request STT engine/model overrides, and CLI/API improvements give power users more automation surface\n- **Workflow and hotkey polish** - Workflow drag reordering, multiple global hotkeys per action, prompt-boundary hardening, direct text hotkeys, and safer Apple Intelligence handling improve day-to-day dictation flows\n- **Dictation reliability pass** - Live transcript, recording indicators, fullscreen/fixed-display handling, USB and multichannel audio capture, route-change recovery, and hotkey startup latency all received focused fixes\n\n## Features\n\n### Transcription\n\n- **Eleven engines** - WhisperKit (99+ languages, streaming, translation), Parakeet TDT v3 (25 European languages, extremely fast), Apple SpeechAnalyzer (macOS 26+, no model download needed), Granite Speech (MLX-based), Qwen3 ASR (MLX-based), Voxtral (local Voxtral Mini 4B, MLX-based), Groq Whisper, OpenAI Whisper, Smallest Pulse, xAI/Grok STT, and OpenAI Compatible (any OpenAI-compatible API)\n- **On-device or cloud** - All processing happens locally on your Mac, or use Groq/OpenAI/xAI APIs for faster processing\n- **Streaming preview** - See partial transcription in real-time while speaking (WhisperKit)\n- **Short-clip handling** - Better retention of brief utterances and fewer false no-speech discards\n- **File transcription** - Batch-process multiple audio/video files with drag \u0026 drop\n- **Subtitle export** - Export transcriptions as SRT or WebVTT with timestamps\n\n### Dictation\n\n- **System-wide** - Push-to-talk, toggle, or hybrid mode via global hotkey, auto-pastes into any app\n- **Modifier-key hotkeys** - Use a single modifier key (Command, Shift, Option, Control) as your hotkey\n- **Indicator styles** - Choose Notch, Overlay, or Minimal, with optional live transcript preview where supported\n- **Sound feedback** - Audio cues for recording start, transcription success, and errors\n- **Microphone selection** - Choose a specific input device with live preview and improved recovery after route changes\n\n### AI Processing\n\n- **Workflows** - Build reusable transformations for translation, rewriting, extraction, formatting, and app-specific automation. Workflows can run automatically by app, website, or app + website combinations, from a dedicated hotkey, as a global fallback, or manually from the Workflow Palette. Hotkey workflows can either start dictation or process the current selection/clipboard directly.\n- **LLM providers** - Apple Intelligence (macOS 26+), Groq, OpenAI / ChatGPT, xAI/Grok, Gemini, and OpenAI Compatible with per-prompt provider and model override\n- **Speech providers** - System voices, xAI/Grok TTS, and experimental local Supertonic TTS can provide spoken feedback and readback\n- **Local prompt processing** - Gemma 4 via MLX runs on-device on Apple Silicon, with the current verified release path limited to the E2B/E4B 4-bit models\n- **Translation** - Translate transcriptions on-device using Apple Translate\n\n### Personalization\n\n- **Workflow triggers** - Per-app, per-website, combined app + website, hotkey, global fallback, and manual palette-only triggers for language, task, engine, prompt, and auto-submit behavior. Website matching supports subdomains\n- **Dictionary** - Terms improve cloud recognition accuracy. Corrections fix common transcription mistakes automatically. Auto-learns from manual corrections. Includes importable term packs\n- **Localized term packs** - Built-in term pack names and descriptions are localized in English and German\n- **Snippets** - Text shortcuts with trigger/replacement. Supports placeholders like `{{DATE}}`, `{{TIME}}`, and `{{CLIPBOARD}}`\n- **History** - Searchable transcription history with inline editing, correction detection, app context tracking, timeline grouping, filters, bulk delete, multi-select export, auto-retention, and a standalone window accessible from the tray menu\n\n### Integration \u0026 Extensibility\n\n- **Plugin system** - Extend TypeWhisper with custom LLM providers, transcription engines, TTS providers, post-processors, and action plugins. Gemini, Granite, Groq, Linear, OpenAI / ChatGPT, OpenAI Compatible, Qwen3, Smallest Pulse, Supertonic, Voxtral, Webhook, and xAI/Grok ship as bundled plugins, alongside the local engine plugins. Linear plugin enables voice-to-issue creation. See [TypeWhisperPluginSDK/Plugins/README.md](TypeWhisperPluginSDK/Plugins/README.md)\n- **Local model download controls** - Bundled Qwen3, Granite, Voxtral, and Supertonic plugins support an optional HuggingFace token for higher rate limits and clearer download errors. Supertonic requires explicit OpenRAIL-M model-license acceptance before model assets download.\n- **HTTP API** - Local REST API for integration with external tools and scripts\n- **CLI tool** - Shell-friendly transcription via the command line\n- **Discord claim service** - Optional external service for Polar supporter and GitHub Sponsors Discord role claims\n\n### General\n\n- **Home dashboard** - Usage statistics, activity chart, and onboarding tutorial\n- **Auto-update** - Built-in updates via Sparkle with stable, release-candidate, and daily channels\n- **Universal binary** - Runs natively on Apple Silicon and Intel Macs\n- **Widgets** - Desktop widgets for usage stats, last transcription, activity chart, and transcription history\n- **Multilingual UI** - English and German\n- **Launch at Login** - Start automatically with macOS\n\n## Install\n\n### Homebrew\n\n```bash\nbrew install --cask typewhisper/tap/typewhisper\n```\n\n### Direct Download\n\nDownload the latest DMG from [GitHub Releases](https://github.com/TypeWhisper/typewhisper-mac/releases/latest).\n\nStable direct-download releases use the default Sparkle channel. Release candidates such as `1.4.0-rc*` and daily builds are published as GitHub prereleases, update the shared Sparkle appcast on their own channels, and are excluded from Homebrew.\nInstalled builds can switch channels in `Settings -\u003e About` via the `Update Channel` picker.\n\n## Quick Start\n\n1. Install TypeWhisper from Homebrew or the latest DMG.\n2. Open Settings and grant Microphone plus Accessibility access.\n3. Pick an engine and, if needed, download a local model.\n4. Trigger the global hotkey and complete your first dictation.\n\n## Manual Uninstall (macOS)\n\nThese steps are for official TypeWhisper release builds on macOS. They remove the app itself, its local state, widget data, and stored secrets so you can reinstall from a clean slate.\n\nIf you installed via Homebrew, you can optionally start with:\n\n```bash\nbrew uninstall --cask typewhisper\n```\n\nThat removes the app bundle, but it does not reliably remove all files in `~/Library` or TypeWhisper entries in Keychain.\n\nIf `~/Library` is hidden in Finder, use `Go -\u003e Go to Folder...` and paste the paths below.\n\n1. Quit TypeWhisper if it is running.\n2. Delete the app bundle:\n   ```bash\n   rm -rf /Applications/TypeWhisper.app\n   ```\n3. Delete app data and plugins:\n   ```bash\n   rm -rf ~/Library/Application\\ Support/TypeWhisper\n   ```\n4. Delete preferences:\n   ```bash\n   rm -f ~/Library/Preferences/com.typewhisper.mac.plist\n   ```\n5. Delete widget and app group data used by official releases:\n   ```bash\n   rm -rf ~/Library/Group\\ Containers/2D8ALY3LCL.com.typewhisper.mac\n   ```\n6. Remove TypeWhisper secrets from Keychain:\n   - In Keychain Access, search for `com.typewhisper.mac.apikey` and delete matching items.\n   - This includes API and plugin secrets stored under the `com.typewhisper.mac.apikey.*` service prefix.\n   - Also remove the license items stored under service `com.typewhisper.mac.apikey.license`, especially the `polar-license` and `polar-supporter` accounts.\n7. If you installed the CLI tool from Settings \u003e Advanced, remove it too:\n   ```bash\n   rm -f /usr/local/bin/typewhisper\n   ```\n8. Optional: if you want to remove exported user files as well, delete:\n   ```bash\n   rm -rf ~/Documents/TypeWhisper\\ Recordings\n   ```\n9. Restart your Mac, then install the latest build again.\n\nIf a fresh install still crashes immediately after these steps, please open an issue and include your macOS version, how you installed TypeWhisper, and whether the crash happens on first launch or after granting permissions.\n\n## System Requirements\n\n- macOS 14.0 (Sonoma) or later\n- Apple Silicon (M1 or later) recommended\n- 8 GB RAM minimum, 16 GB+ recommended for larger models\n- Some features (Apple Translate, improved Settings UI) require macOS 15+. Apple Intelligence and SpeechAnalyzer require macOS 26+.\n\n## Gemma 4 Support\n\nTypeWhisper includes a bundled local Gemma 4 plugin powered by MLX for on-device prompt processing on Apple Silicon. In the current verified release path, Gemma 4 support is limited to the dense `E2B 4-bit` and `E4B 4-bit` variants; larger or unverified variants stay visible in the UI but remain disabled until they are validated end to end.\n\n## Model Recommendations\n\n| RAM | Recommended Models |\n|-----|-------------------|\n| \u003c 8 GB | Whisper Tiny, Whisper Base |\n| 8-16 GB | Whisper Small, Whisper Large v3 Turbo, Parakeet TDT v3, Voxtral Mini 4B |\n| \u003e 16 GB | Whisper Large v3 |\n\n## Build\n\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/TypeWhisper/typewhisper-mac.git\n   cd typewhisper-mac\n   ```\n\n2. Open in Xcode 16+:\n   ```bash\n   open TypeWhisper.xcodeproj\n   ```\n\n3. Select the TypeWhisper scheme and build (Cmd+B). Swift Package dependencies (WhisperKit, FluidAudio, Sparkle, TypeWhisperPluginSDK) resolve automatically.\n\n4. Run the app. It appears as a menu bar icon - open Settings to download a model.\n\n5. Run the automated checks before shipping changes:\n   ```bash\n   xcodebuild test -project TypeWhisper.xcodeproj -scheme TypeWhisper -destination 'platform=macOS,arch=arm64' -parallel-testing-enabled NO CODE_SIGN_IDENTITY='-' CODE_SIGNING_REQUIRED=NO CODE_SIGNING_ALLOWED=NO\n   swift test --package-path TypeWhisperPluginSDK\n   ```\n\n## HTTP API\n\nThe HTTP API is an advanced local automation surface. It binds to `127.0.0.1` only, is disabled by default, and is intended for local tools and scripts.\n\nEnable the API server in Settings \u003e Advanced (default port: `8978`).\n\n### Check Status\n\n```bash\ncurl http://localhost:8978/v1/status\n```\n\n```json\n{\n  \"status\": \"ready\",\n  \"engine\": \"whisper\",\n  \"model\": \"openai_whisper-large-v3_turbo\",\n  \"supports_streaming\": true,\n  \"supports_translation\": true\n}\n```\n\n### Transcribe Audio\n\n```bash\ncurl -X POST http://localhost:8978/v1/transcribe \\\n  -F \"file=@recording.wav\" \\\n  -F \"language=en\"\n\ncurl -X POST http://localhost:8978/v1/transcribe \\\n  -F \"file=@recording.wav\" \\\n  -F \"language_hint=de\" \\\n  -F \"language_hint=en\"\n```\n\n```json\n{\n  \"text\": \"Hello, world!\",\n  \"language\": \"en\",\n  \"duration\": 2.5,\n  \"processing_time\": 0.8,\n  \"engine\": \"whisper\",\n  \"model\": \"openai_whisper-large-v3_turbo\"\n}\n```\n\nOptional parameters:\n- `language` - ISO 639-1 code (e.g., `en`, `de`). Omit for full auto-detection.\n- `language_hint` - Repeatable, ordered language hint for restricted auto-detection. Hint-aware engines receive the full list; other engines use the first hint as the requested language. Do not combine with `language`.\n- `task` - `transcribe` (default) or `translate` (translates to English, WhisperKit only).\n- `target_language` - ISO 639-1 code for translation target language (e.g., `es`, `fr`). Uses Apple Translate.\n\nUploads to `/v1/transcribe` are limited to 256 MiB, including stdin uploads from the CLI. Requests above that size return `413 Payload Too Large`. Local CLI file paths use a direct handoff to the running TypeWhisper app instead of uploading the file bytes.\n\n### List Models\n\n```bash\ncurl http://localhost:8978/v1/models\n```\n\n```json\n{\n  \"models\": [\n    {\n      \"id\": \"openai_whisper-large-v3_turbo\",\n      \"engine\": \"whisper\",\n      \"ready\": true\n    }\n  ]\n}\n```\n\n### History\n\n```bash\n# Search history\ncurl \"http://localhost:8978/v1/history?q=meeting\u0026limit=10\u0026offset=0\"\n\n# Delete entry\ncurl -X DELETE \"http://localhost:8978/v1/history?id=\u003cuuid\u003e\"\n```\n\n### Dictionary\n\n```bash\n# List recognition terms\ncurl http://localhost:8978/v1/dictionary/terms\n\n# Merge terms, or set replace=true to replace all terms\ncurl -X PUT http://localhost:8978/v1/dictionary/terms \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"terms\":[\"TypeWhisper\",\"WhisperKit\"],\"replace\":false}'\n\n# Delete one term\ncurl -X DELETE http://localhost:8978/v1/dictionary/terms \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"term\":\"TypeWhisper\"}'\n\n# List post-transcription corrections\ncurl http://localhost:8978/v1/dictionary/corrections\n\n# Add or update one correction by original text\ncurl -X PUT http://localhost:8978/v1/dictionary/corrections \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"original\":\"teh\",\"replacement\":\"the\",\"caseSensitive\":false}'\n\n# Delete one correction\ncurl -X DELETE http://localhost:8978/v1/dictionary/corrections \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"original\":\"teh\"}'\n```\n\n### Workflows\n\n```bash\n# List all workflow-backed rules\ncurl http://localhost:8978/v1/rules\n\n# Toggle a workflow-backed rule on/off\ncurl -X PUT \"http://localhost:8978/v1/rules/toggle?id=\u003cuuid\u003e\"\n```\n\n### Dictation Control\n\n```bash\n# Start dictation (returns session id)\ncurl -X POST http://localhost:8978/v1/dictation/start\n\n# Stop dictation (returns same session id)\ncurl -X POST http://localhost:8978/v1/dictation/stop\n\n# Check whether dictation is currently recording\ncurl http://localhost:8978/v1/dictation/status\n\n# Fetch status/result for a specific dictation session\ncurl \"http://localhost:8978/v1/dictation/transcription?id=\u003cuuid\u003e\"\n```\n\nDictation control records microphone audio for system-wide insertion. A completed dictation session returns text that TypeWhisper can paste back into the active app.\n\n### Recorder Control\n\nRecorder control uses the same recorder path as the TypeWhisper UI, including microphone capture, optional system audio capture, mixing, finalization, and final transcription. Use it for automations that need a saved recording file or meeting/system-audio transcription without auto-pasting into another app.\n\n```bash\n# Start recorder with microphone and system audio\ncurl -X POST \"http://localhost:8978/v1/recorder/start?mic=true\u0026system_audio=true\"\n\n# Stop the active API recorder session\ncurl -X POST http://localhost:8978/v1/recorder/stop\n\n# Check whether the recorder is currently recording\ncurl http://localhost:8978/v1/recorder/status\n\n# Fetch status/result for a specific recorder session\ncurl \"http://localhost:8978/v1/recorder/session?id=\u003cuuid\u003e\"\n```\n\n`POST /v1/recorder/start` accepts optional query flags:\n- `mic` - `true`, `false`, `1`, or `0`. If omitted, TypeWhisper uses the current recorder microphone setting.\n- `system_audio` - `true`, `false`, `1`, or `0`. If omitted, TypeWhisper uses the current recorder system-audio setting.\n\nAt least one source must be enabled. If both resolved sources are disabled, the API returns `400 Bad Request`.\n\nStart response:\n\n```json\n{\n  \"id\": \"8F8C1F45-6D03-44D2-A38C-0C4DE4F7E5F7\",\n  \"status\": \"recording\"\n}\n```\n\nStop response:\n\n```json\n{\n  \"id\": \"8F8C1F45-6D03-44D2-A38C-0C4DE4F7E5F7\",\n  \"status\": \"finalizing\"\n}\n```\n\nStatus response:\n\n```json\n{\n  \"recording\": true\n}\n```\n\nSession response:\n\n```json\n{\n  \"id\": \"8F8C1F45-6D03-44D2-A38C-0C4DE4F7E5F7\",\n  \"status\": \"completed\",\n  \"text\": \"Meeting notes from the recording.\",\n  \"output_file\": \"/Users/alex/Documents/TypeWhisper Recordings/Recording 2026-05-20 14-30-00.m4a\"\n}\n```\n\nRecorder sessions move through `recording -\u003e finalizing -\u003e completed` or `failed`. If recorder transcription is disabled or produces no transcript, `text` is omitted and `output_file` still points to the finalized recording when available. Failed sessions include an `error` field.\n\nConflict and lookup behavior:\n- Starting while the recorder is already recording or finalizing returns `409 Conflict`.\n- Stopping without an active API recorder session returns `409 Conflict`.\n- Polling with a missing or invalid `id` returns `400 Bad Request`.\n- Polling a valid but unknown session id returns `404 Not Found`.\n\n## CLI Tool\n\nTypeWhisper includes a command-line tool for shell-friendly transcription. It is part of the advanced automation surface and connects to the running local API server.\n\n### Installation\n\nInstall via Settings \u003e Advanced \u003e CLI Tool \u003e Install. This places the `typewhisper` binary in `/usr/local/bin`.\n\n### Commands\n\n```bash\ntypewhisper status              # Show server status\ntypewhisper models              # List available models\ntypewhisper transcribe file.wav # Transcribe an audio file\n```\n\n### Options\n\n| Option | Description |\n|--------|-------------|\n| `--port \u003cN\u003e` | Server port (default: auto-detect) |\n| `--json` | Output as JSON |\n| `--language \u003ccode\u003e` | Source language (e.g. `en`, `de`) |\n| `--language-hint \u003ccode\u003e` | Repeatable, ordered language hint for restricted auto-detection; engines without hint support use the first hint |\n| `--task \u003ctask\u003e` | `transcribe` (default) or `translate` |\n| `--translate-to \u003ccode\u003e` | Target language for translation |\n\n### Examples\n\n```bash\n# Transcribe with language and JSON output\ntypewhisper transcribe recording.wav --language de --json\n\n# Restrict auto-detection to a shortlist\ntypewhisper transcribe recording.wav --language-hint de --language-hint en\n\n# Pipe audio from stdin\ncat audio.wav | typewhisper transcribe -\n\n# Use in a script\ntypewhisper transcribe meeting.m4a --json | jq -r '.text'\n```\n\nThe CLI requires the API server to be running (Settings \u003e Advanced) and follows the documented command and flag surface for the current stable release.\n\nLocal file paths are handed to the running TypeWhisper app directly, so large files do not need to fit inside an HTTP upload body. Stdin usage (`typewhisper transcribe -`) still uses the regular `/v1/transcribe` upload endpoint and is limited to 256 MiB.\n\n## Workflows\n\nWorkflows let you configure transcription, transformation, and automation behavior per application, website, combined app + website context, hotkey, global fallback, or manual palette-only workflow. For example:\n\n- **Mail** - German language, Whisper Large v3\n- **Slack** - English language, Parakeet TDT v3\n- **Terminal** - English language, auto-submit enabled\n- **github.com** - English cleanup workflow that matches in any browser\n- **docs.google.com** - German dictation workflow that translates to English\n\nCreate workflows in Settings \u003e Workflows. Choose a template, then use Automatic to enable app, website, hotkey, or any combination of those trigger components. Always stays the global fallback, and Manual keeps the workflow palette-only. Hotkey workflows choose whether the shortcut starts dictation or processes the current selection/clipboard through the same insertion path as the Workflow Palette. Spoken language can be left on full auto-detect, fixed to one exact language, or restricted to a shortlist of likely languages for better detection accuracy. Website patterns support subdomain matching - e.g. `google.com` also matches `docs.google.com`.\n\nWhen you start dictating, TypeWhisper matches the active app and browser URL against enabled workflows with the following priority:\n1. **App + URL match** - highest specificity (e.g. Chrome + github.com)\n2. **URL-only match** - cross-browser workflows (e.g. github.com in any browser)\n3. **App-only match** - generic app workflows (e.g. all of Chrome)\n4. **Always fallback** - global workflow when no more specific workflow matches\n\nHotkeys are direct workflow shortcuts, not context conditions in the app/URL matching order. Manual workflows are excluded from automatic dictation matching. They appear only in the Workflow Palette and use the existing Workflow Palette hotkey.\n\nThe active workflow name is shown as a badge in the indicator, together with a short explanation of why it matched.\n\nMultiple engines can be loaded simultaneously for instant switching between workflows. Note that loading multiple local models increases memory usage. Cloud engines (Groq, OpenAI, xAI/Grok) have negligible memory overhead.\n\n## Plugins\n\nTypeWhisper supports plugins for adding custom LLM providers, transcription engines, TTS providers, post-processors, and action plugins. Plugins are macOS `.bundle` files placed in `~/Library/Application Support/TypeWhisper/Plugins/`.\n\nBundled engines and integrations (WhisperKit, Parakeet, SpeechAnalyzer, Granite, Qwen3, Voxtral, Supertonic, Groq, OpenAI, xAI/Grok, OpenAI Compatible, Gemini, Linear, Webhook, and more) are implemented as plugins and serve as reference implementations.\n\nSee [TypeWhisperPluginSDK/Plugins/README.md](TypeWhisperPluginSDK/Plugins/README.md) for the full plugin development guide, including the event bus, host services API, and manifest format.\n\n## Architecture\n\n```\nTypeWhisper/\n├── typewhisper-cli/           # Command-line tool (status, models, transcribe)\n├── PluginRegistry/            # Source registry entries for community plugin feeds\n├── Plugins/                # Redirect docs and legacy entrypoint for moved first-party plugin sources\n├── TypeWhisperPluginSDK/   # Plugin SDK (Swift package)\n│   ├── Plugins/            # First-party plugin sources and manifests\n├── TypeWhisperWidgetExtension/ # WidgetKit widgets (stats, activity, history)\n├── TypeWhisperWidgetShared/    # Shared widget data models\n├── App/                    # App entry point, dependency injection\n├── Models/                 # Data models (TranscriptionResult, Profile, PromptAction, etc.)\n├── Services/\n│   ├── Cloud/              # KeychainService, WavEncoder (shared cloud utilities)\n│   ├── LLM/               # Apple Intelligence provider (cloud LLM providers are plugins)\n│   ├── HTTPServer/         # Local REST API (HTTPServer, APIRouter, APIHandlers)\n│   ├── ModelManagerService # Transcription dispatch (delegates to plugins)\n│   ├── AudioRecordingService\n│   ├── AudioFileService    # Audio/video - 16kHz PCM conversion\n│   ├── HotkeyService\n│   ├── TextInsertionService\n│   ├── WorkflowService     # Workflow matching and persistence\n│   ├── HistoryService      # Transcription history persistence (SwiftData)\n│   ├── DictionaryService   # Custom term corrections\n│   ├── SnippetService      # Text snippets with placeholders\n│   ├── PromptActionService # Prompt action persistence (SwiftData)\n│   ├── PromptProcessingService # LLM orchestration for prompt execution\n│   ├── PluginManager       # Plugin discovery, loading, and lifecycle\n│   ├── PluginRegistryService # Plugin marketplace (download, install, update)\n│   ├── PostProcessingPipeline # Priority-based text processing chain\n│   ├── EventBus            # Typed publish/subscribe event system\n│   ├── TranslationService  # On-device translation via Apple Translate\n│   ├── SubtitleExporter    # SRT/VTT export\n│   └── SoundService        # Audio feedback for recording events\n├── ViewModels/             # MVVM view models with Combine\n├── Views/                  # SwiftUI views\n└── Resources/              # Info.plist, entitlements, localization, sounds\n```\n\n**Patterns:** MVVM with `ServiceContainer` singleton for dependency injection. ViewModels use a static `_shared` pattern. Localization via `String(localized:)` with `Localizable.xcstrings`.\n\n## License\n\nGPLv3 - see [LICENSE](LICENSE) for details. Commercial licensing available - see [LICENSE-COMMERCIAL.md](LICENSE-COMMERCIAL.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypewhisper%2Ftypewhisper-mac","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftypewhisper%2Ftypewhisper-mac","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypewhisper%2Ftypewhisper-mac/lists"}