Stable

Windows is a stable desktop release. The optional Windows CLI uses the local HTTP API.

CLI Tool

Use TypeWhisper from PowerShell, scripts, and local automation.

Install and prepare

Open Settings > Advanced > Command Line Tool and click Install.
Open a new terminal afterward so the updated user PATH is loaded.
Enable the local server in Settings > Advanced > API Server.
Verify the connection with typewhisper status.

typewhisper status

The CLI is a client for the local HTTP API. TypeWhisper must be running and the API server must be enabled.

Automatic discovery and token

Without --port, the CLI first reads %LOCALAPPDATA%\TypeWhisper\api-discovery.json, then the legacy api-port file, and finally falls back to 8978.

Current stable client note: the app now writes its discovery files to %LOCALAPPDATA%\TypeWhisper-UserData, but the CLI still checks the former folder shown above. Port 8978 works through the fallback. Use --port for a different port.

A token is used when the CLI finds its discovery file. With the current stable client, set TYPEWHISPER_API_TOKEN or --api-token explicitly when token protection is enabled. Priority is --api-token, environment variable, then discovery.

Commands

status

Shows API, engine, and model status.

typewhisper status

models

Lists the currently available local and cloud models.

typewhisper models

transcribe <file|->

Transcribes a local file path or raw audio from stdin.

typewhisper transcribe meeting.m4a
typewhisper transcribe - < audio.wav

Global flags

Flag	Description
--port <N>	Override the port; otherwise try CLI discovery, then fallback 8978
--api-token <token>	Override the discovery and environment token
--json	Machine-readable JSON output
--version	Print the CLI version
--help, -h	Show help

transcribe flags

Flag	Description
--language <code>	Set one exact source language
--language-hint <code>	Repeatable ordered hint for auto-detection
--task <task>	transcribe or translate
--translate-to <code>	Translation target language
--engine <id>	Override the engine for this request
--model <id>	Override the model for this request
--await-download	Wait for a local model restore or download

--language and --language-hint cannot be combined. Repeat --language-hint for multiple hints in the desired order.

Examples

typewhisper transcribe recording.wav --language de --json
typewhisper transcribe recording.wav --language-hint de --language-hint en
typewhisper transcribe recording.wav --engine <engine-id> --model <model-id>
typewhisper transcribe recording.wav --task translate --translate-to en
typewhisper transcribe recording.wav --await-download
typewhisper --port 9000 status

HTTP API and authentication