Skip to main content

Cross-platform voice-to-text typing assistant with GPU acceleration and automatic CPU fallback

Project description

STT Type v2.0.3

Cross-platform voice-to-text typing assistant with GPU acceleration and automatic CPU fallback.

Hold F2 (configurable) to record your voice, release to transcribe and type the text automatically at your cursor position.

Features

  • Cross-platform - Works on Windows, Linux, and macOS
  • Hold hotkey to record - Audio captures while key is held (default: F2)
  • Visual indicator - Transparent red dot with hotkey label appears in top-right corner while recording
  • Bell sounds - Audio feedback when recording starts/stops
  • GPU-accelerated STT - Uses faster-whisper on your NVIDIA GPU
  • Auto CPU fallback - Automatically falls back to CPU if GPU is not available
  • Clipboard typing - Types text via Ctrl+V paste for reliability (no key interference)
  • System tray mode - Runs silently in background
  • Auto-startup - Starts automatically on login (Windows)
  • Settings GUI - stttype --config to change model, language, device, compute type, and hotkey

Requirements

  • Python 3.9+
  • Microphone
  • NVIDIA GPU with CUDA support (optional, for GPU mode)

Installation

From PyPI (Recommended)

pip install stttype

Prerequisites (Optional GPU Support)

Install PyTorch with CUDA support for GPU acceleration:

# Windows/Linux with CUDA 11.8
pip install torch torchaudio --index-url https://download.pytorch.org/whl/cu118

# macOS (CPU only, no CUDA)
pip install torch torchaudio

Without PyTorch, STT Type will still work — it automatically falls back to CPU.

Windows (Local Install)

cd "E:\Lucas\STT Type"
.\install.ps1

Then restart PowerShell.

Linux

cd /path/to/stttype
chmod +x install.sh
./install.sh

If sounddevice fails, install PortAudio:

# Debian/Ubuntu
sudo apt-get install portaudio19-dev

# Fedora
sudo dnf install portaudio-devel

# Arch
sudo pacman -S portaudio

macOS

cd /path/to/stttype
chmod +x install.sh
./install.sh

If sounddevice fails, install PortAudio:

brew install portaudio

Note: On macOS, you need to grant Accessibility permissions for pynput to capture global hotkeys. Go to System Settings > Privacy & Security > Accessibility and add your terminal application.

Commands

Once installed, stttype works from any terminal.

Command Description
stttype --start Start STT Type in background
stttype --shutdown Stop all STT Type processes
stttype --status Check if STT Type is running
stttype --restart Restart STT Type
stttype --config Open settings GUI
stttype --addtostartup Add to startup (Windows only)
stttype --rmtostartup Remove from startup (Windows only)
stttype --model <size> Set Whisper model (tiny/base/small/medium/large-v3)
stttype --lang <code> Set language (en/zh/auto/etc)
stttype --help Show help

Examples

# Start with default settings
stttype --start

# Start with a larger model for better accuracy
stttype --start --model small

# Start with Chinese language
stttype --start --lang zh

# Start with small model and auto-detect language
stttype --start --model small --lang auto

# Open settings GUI
stttype --config

Settings GUI

Run stttype --config to open a settings window where you can configure:

Setting Options
Whisper Model tiny, base, small, medium, large-v3
Language Auto-detect, English, Chinese, Spanish, French, German, Japanese, Korean, Russian, Italian, Portuguese, Arabic, Hindi
Device Auto (GPU if available), GPU (CUDA), CPU
Compute Type Auto, Float16 (GPU), Int8 (CPU)
Hotkey F1 - F12

Settings are saved to ~/.config/stttype/config.json and persist across restarts.

How It Works

  1. Hold hotkey (default F2) - A transparent red dot appears in the top-right corner, microphone starts recording
  2. Release hotkey - Red dot disappears, recording stops
  3. GPU/CPU transcribes - Whisper processes audio (GPU if available, else CPU)
  4. Text is pasted - Result is pasted at your cursor position via Ctrl+V

Models

Model Size VRAM Speed Accuracy
tiny 39 MB ~1 GB Fastest Basic
base 74 MB ~1 GB Fast Good
small 244 MB ~2 GB Medium Better
medium 769 MB ~5 GB Slower Best
large-v3 1550 MB ~10 GB Slowest Excellent

Default is base - a good balance of speed and accuracy.

Uninstall

Windows

cd "E:\Lucas\STT Type"
.\uninstall.ps1

Linux/macOS

cd /path/to/stttype
chmod +x uninstall.sh
./uninstall.sh

Troubleshooting

Issue Solution
stttype not found Restart terminal after installation
"CUDA not available" Install NVIDIA drivers and CUDA toolkit, or STT Type will auto-fallback to CPU
No sound on start/stop Check system volume
Text not typing Make sure the target window is focused
Model download fails Check internet connection
Hotkeys don't work (macOS) Grant Accessibility permissions to your terminal
Hotkeys don't work (Linux) Make sure you're running under X11 (not Wayland)
Garbled text when typing Fixed in v2.0.2+ — uses clipboard paste instead of key simulation

Publish to PyPI

# Install build tools
pip install build twine

# Build
cd /path/to/stttype
python -m build

# Upload
python -m twine upload dist/*

When prompted:

  • Username: __token__
  • Password: Your PyPI API token

Author: LucasApps
Version: 2.0.3
License: MIT

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

stttype-2.0.4.tar.gz (18.5 kB view details)

Uploaded Source

Built Distribution

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

stttype-2.0.4-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file stttype-2.0.4.tar.gz.

File metadata

  • Download URL: stttype-2.0.4.tar.gz
  • Upload date:
  • Size: 18.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.1

File hashes

Hashes for stttype-2.0.4.tar.gz
Algorithm Hash digest
SHA256 dcf2f5d789bb43c02078ca42bdc5a4311a823249e2a2f48b9e607e67c192152f
MD5 89cb4088cdda776945ac4b033a631b00
BLAKE2b-256 3a69ba2c13a74daa4e5b2f4df743f469782388635276e9935ca3875b1dfe4f30

See more details on using hashes here.

File details

Details for the file stttype-2.0.4-py3-none-any.whl.

File metadata

  • Download URL: stttype-2.0.4-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.1

File hashes

Hashes for stttype-2.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4d0cdb4f25b8d8d7387a6e4dba5f5b6b74845575990baa4428d39b43d56df91e
MD5 b478f0214b3f9bac8448f06d9e18edd5
BLAKE2b-256 cb021e0edc40b64da2a03dadda6532ea6b18fca7611199e742264c54e818ed8b

See more details on using hashes here.

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