General Settings

General Settings

The General page is where you turn on the local HTTP API, choose its port, set an optional bearer token, and install the typewhisper CLI client.

📸 Screenshot needed: The General page in full, showing the Enable local API toggle, the Port field (default 9876), the optional bearer token field, and the CLI install control.

Local API

The Linux app includes a local HTTP API for integrations and desktop automation. You enable and configure it here.

Setting	What it does
Enable local API	Turns the local HTTP API on or off.
Port	The port the API listens on. Defaults to 9876.
Bearer token	An optional token. When configured, requests must present it.

When enabled, TypeWhisper listens on http://localhost:<port>/. The API binds to localhost only.

📸 Screenshot needed: The Enable local API toggle in the on state with the Port field showing 9876 and a bearer token entered.

See HTTP API for the full list of endpoints and request options.

Installing the typewhisper CLI

The Linux build ships a typewhisper CLI client that talks to the local API. You can install it directly from this page. It lands in ~/.local/bin/typewhisper.

📸 Screenshot needed: The CLI install control on the General page.

Once installed, you can run commands like:

typewhisper status
typewhisper models
typewhisper transcribe recording.wav

See CLI for the full command and option reference.

Related pages

• HTTP API — endpoints, request fields, and limitations.
• CLI — commands, options, and examples for the typewhisper client.

---

Changelog

Date	Change
2026-06-17	Initial version.