Skip to content

General Settings

Chris Smashe edited this page Jun 17, 2026 · 5 revisions

General Settings

The General page covers interface language, startup and window behaviour, the local HTTP API and its port, the auto-generated bearer token, and installing the typewhisper CLI client.

The General page: Language (Interface Language not yet implemented), Startup, Window (close-to-tray), and the Services section

Language

Setting What it does
Interface Language Dropdown for the UI language. Not implemented in the Linux build yet — the control is disabled and a note says so.

Startup

Setting What it does
Start automatically at system startup Registers an XDG autostart entry so TypeWhisper launches when you log in.

Window

Setting What it does
Close button hides to tray On: the close (X) button hides the window to the tray icon and keeps the app running. Off: the close button quits TypeWhisper.

This toggle is disabled when no system tray is detected — the close button will quit the app. On GNOME, install the AppIndicator extension to enable it.

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 (valid range 1–65535). Defaults to 9876.
Bearer token Auto-generated on first run and shown read-only. Requests must present it; you cannot type your own.

The bearer token is a random value generated by the app, not something you enter. Clients pass it via the TYPEWHISPER_API_TOKEN environment variable or the --token option.

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

The Services section: Enable local API, Port (9876), the read-only Bearer token field, and the API examples with curl commands

The API examples panel shows ready-to-copy curl commands. 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. The Command line section (with the Install button and CLI examples) only appears once the API is enabled. Install copies the bundled launcher to ~/.local/bin/typewhisper; Refresh re-checks whether the CLI is already installed.

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.
2026-06-17 Added General settings and API screenshots.
2026-06-17 Removed unused screenshot placeholders.
2026-06-17 Corrected bearer token to auto-generated/read-only; added Language, Startup, Window sections, port range, Refresh button, and API/CLI visibility notes.

Clone this wiki locally