Skip to main content

Linux-first speech-to-text terminal UI

Project description

sttui logo

sttui: Speech To Text in your terminal

No browser. No Web UI. Fast speech-to-text with the best models

PyPI version

https://github.com/user-attachments/assets/252ba77e-d3f3-4689-bcc1-77f536f10c60

Setup

pip install sttui

(or if you have uv installed, uvx sttui)

Then, you must have an account on openrouter, and get an API key.

To register it, run:

sttui auth
Storage of your key

Your key will be stored inside ~/.config/sttui/auth.json

Make sure you don't commit this file !

Config

When you first start the app, a config file is created at: ~/.config/sttui/config.toml

You can specify the default model (without the openrouter prefix), the prompt, and the maximum audio length.

[transcription]
model = "mistralai/voxtral-small-24b-2507"
prompt = """
You are a helpful assistant that can hear audio and write text.
Return a transcription of the user audio as json. If the user request is empty, return null.
<format>
{
  "transcription": ""
}
</format>
<format>
{
  "transcription": null
}
</format>
"""
max_seconds = 600

⚠️ Make sure that the prompt asks the model to answer in this json format, it's the one expected by sttui

Commands

# Start interactive dictation TUI
sttui

# Equivalent explicit run command
sttui run

# Show CLI help
sttui --help

# Set or update API key
sttui auth

# TUI + write transcript to stdout on Enter
sttui --stdout

# Override model and recording cap for this run
sttui --model google/gemini-2.5-flash --max-seconds 120

# Use a custom config file
sttui --config ~/.config/sttui/config.toml

# Background lifecycle (no TUI)
sttui background start
sttui background stop
sttui background toggle

# Same with desktop notifications
sttui background --notify start

All recordings and transcripts are stored in ~/.local/share/sttui/recordings/.

Contributing

This is a side-project of mine. I must admit there is mostly AI-generated code, but I try to review and ensure good practices.

I don't have strong opinions about how this project should evolve. If you find it useful, feel free to contribute !

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sttui-0.2.2.tar.gz (22.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sttui-0.2.2-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

Details for the file sttui-0.2.2.tar.gz.

File metadata

  • Download URL: sttui-0.2.2.tar.gz
  • Upload date:
  • Size: 22.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sttui-0.2.2.tar.gz
Algorithm Hash digest
SHA256 92f93f43cfde5c6af58b2bda94ced68cdd290f9a47d290bd0bfa4b67b7cd5423
MD5 fbe03040fcd20b0dd6f37677cd2df190
BLAKE2b-256 7706d5ed1685c9f64113d977786d8275bdd8d64b9ccc499c74fda10310ef437b

See more details on using hashes here.

Provenance

The following attestation bundles were made for sttui-0.2.2.tar.gz:

Publisher: publish.yaml on rambip/sttui

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sttui-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: sttui-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 22.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sttui-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4f1fa938a1c4911fa849915f046bd3dbbfcd18b7ecdd56d2579a7051acf6b64e
MD5 00bfe9647114a71ca7b9a443c6fc42f5
BLAKE2b-256 4cf3434c7cacfd11ca757dfe7a284a880202e5ddbe6ae8a107e9b3c86319acc6

See more details on using hashes here.

Provenance

The following attestation bundles were made for sttui-0.2.2-py3-none-any.whl:

Publisher: publish.yaml on rambip/sttui

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page