CLI

CLI

The Linux build ships a typewhisper CLI client that talks to the local HTTP API. Use it to check status, list models, and transcribe audio from scripts or the terminal.

Installing

Install the client from the General settings page (or by running typewhisper's installer logic). It lands in ~/.local/bin/typewhisper.

The CLI talks to the local API, so make sure the API is enabled on the General page first.

Commands

Command	Description
typewhisper status	Show app status and active model.
typewhisper models	List available models.
typewhisper transcribe <file|->	Transcribe an audio file. Use - to read WAV bytes from stdin.

Options for transcribe

Option	Description
--language <code>	Force a transcription language.
--language-hint <code>	Hint to bias language detection (repeatable).
--task transcribe|translate	Transcribe in the source language, or translate.
--translate-to <code>	Target language when translating.
--response-format json|verbose_json	Response shape; verbose_json adds per-segment timing.
--prompt <text>	Prompt/context passed to the engine.
--engine <id>	Override the transcription engine.
--model <id>	Override the model.
--await-download	Wait while the active engine restores or downloads its model before transcribing.

Global options

Option	Description
--port <N>	Port to connect to. Defaults to 9876.
--token <token>	Bearer token. You can also set TYPEWHISPER_API_TOKEN.
--json	Emit machine-readable JSON output.
--version	Print the client version.
--help	Show usage.

Examples

typewhisper status --token "$TYPEWHISPER_API_TOKEN"
typewhisper transcribe recording.wav --language de --json
typewhisper transcribe recording.wav --engine groq --model whisper-large-v3-turbo
typewhisper transcribe - < audio.wav

Related pages

• HTTP API — the endpoints the CLI calls and their request fields.
• General settings — enable the API and install the CLI.

---

Changelog

Date	Change
2026-06-17	Initial version.