Skip to content

mpushkin/whisper-term

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Whisper Term

A terminal app for whisper speech to text model.

Features

  • Interactive speech-to-text transcription using OpenAI Whisper
  • Local processing with automatic model management
  • Organized session storage with date-based folders
  • Simple terminal interface with keyboard controls

Installation

Prerequisites

  • Python 3.8-3.11 (recommended: 3.10.x for best compatibility)
  • uv package manager (see installation instructions below)

Installing uv

uv is a fast Python package manager written in Rust. Install it using:

macOS/Linux:

curl -LsSf https://astral.sh/uv/install.sh | sh

Windows:

powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

Alternative methods:

# With pip
pip install uv

# With Homebrew (macOS)
brew install uv

Project Setup

  1. Clone the repository:
git clone <repository-url>
cd whisper-term
  1. Install dependencies using uv:
uv sync
  1. Run the application:
uv run whisper-term

Using uv for Development

uv provides modern Python project management with automatic virtual environment handling:

# Add new dependencies
uv add package-name

# Remove dependencies
uv remove package-name

# Run scripts in project environment
uv run python main.py

# Install the project in development mode
uv sync

CLI Options

# Show all available options
uv run whisper-term --help

# Interactive mode (default)
uv run whisper-term

# Direct recording mode
uv run whisper-term --record

# Specify model and language
uv run whisper-term --model small --language spanish

# Direct mode with custom settings
uv run whisper-term -r -m turbo -l english

# Show recent sessions
uv run whisper-term --recent 5

Usage

Interactive Mode

  1. Launch the application:
uv run whisper-term
  1. Press ENTER to start recording
  2. Speak into your microphone
  3. Press ENTER again to stop recording
  4. Wait for transcription to complete
  5. Find your audio and text files in the data/recordings/ folder

Direct CLI Mode

For quick transcription with automatic clipboard copy:

# Quick recording with default settings
uv run whisper-term --record

# Specify model and language
uv run whisper-term --record --model small --language spanish

# Short flags for power users
uv run whisper-term -r -m base -l english

Direct mode features:

  • Starts recording immediately
  • Automatically copies transcription to clipboard
  • Saves audio file immediately after recording stops
  • Perfect for quick voice notes and automation

File Organization

The application automatically organizes your recordings:

data/
├── models/              # Whisper model cache
│   └── base.pt         # Downloaded base model
└── recordings/         # Session recordings
    └── 2025-07/
        └── 2025-07-08/
            ├── 20250708_143022.wav
            └── 20250708_143022.txt

Development

This project uses uv for dependency management and virtual environment handling. Key benefits:

  • Fast: 10-100x faster than pip for package installation
  • Modern: Uses pyproject.toml and uv.lock for deterministic builds
  • Automatic: Handles virtual environments automatically
  • Comprehensive: Replaces pip, pip-tools, pipx, poetry, and more

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages