Metadata-Version: 2.5
Name: tuxwhisper
Version: 0.2.3
Summary: Private, offline push-to-talk dictation for Linux, on X11 and Wayland
Project-URL: Homepage, https://github.com/ialmajai/tuxwhisper
Project-URL: Documentation, https://github.com/ialmajai/tuxwhisper#readme
Project-URL: Issues, https://github.com/ialmajai/tuxwhisper/issues
Author: Ibrahim Almajai
License-Expression: MIT
License-File: LICENSE
Keywords: dictation,linux,speech-to-text,voice-typing,wayland,whisper
Classifier: Environment :: X11 Applications
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
Requires-Python: <3.15,>=3.11
Requires-Dist: evdev-binary>=1.6
Requires-Dist: faster-whisper<2,>=1.2
Requires-Dist: numpy>=1.24
Requires-Dist: sounddevice>=0.5
Provides-Extra: cuda
Requires-Dist: nvidia-cublas-cu12; extra == 'cuda'
Requires-Dist: nvidia-cudnn-cu12==9.*; extra == 'cuda'
Provides-Extra: vulkan
Requires-Dist: pywhispercpp<2,>=1.5; extra == 'vulkan'
Description-Content-Type: text/markdown

# TuxWhisper

**Private, offline dictation for Linux.** Press a key, speak, and your words are typed wherever
your cursor is: a browser text box, an LLM chat prompt, your editor or your terminal. Speech
recognition ([faster-whisper](https://github.com/SYSTRAN/faster-whisper)) and the optional LLM
cleanup ([Ollama](https://ollama.com)) run on your own machine with free, open models.

![TuxWhisper demo](https://raw.githubusercontent.com/ialmajai/tuxwhisper/main/docs/demo.gif)

## Install

```bash
uv tool install tuxwhisper        # NVIDIA GPU: uv tool install 'tuxwhisper[cuda]'
tuxwhisper setup
```

`tuxwhisper setup` installs the system packages it needs (Debian, Ubuntu, Fedora, Arch and
openSUSE), sets up the background service and, on GNOME, binds the keys. It says what each step
does and asks before anything that needs your password. On an AMD or Intel GPU, it builds the
Vulkan engine for you.

Then click into any text box, press the dictation key, wait for the start sound, speak, and press
it again.

| Key | Action |
|-----|--------|
| **Dictation key** | Tap to start and stop, or hold to talk |
| **Cleanup key** | The same, with local LLM cleanup |
| **Save key** | Save the last recording for fine-tuning |
| **Settings key** | Settings menu |

On GNOME, setup binds them to F5, F3, F4 and Alt+F9; change them under **Keys** in the settings
menu.

Documentation, other desktops and troubleshooting: <https://github.com/ialmajai/tuxwhisper>
