Thanks to visit codestin.com
Credit goes to github.com

Skip to content

TakanariShimbo/open-super-whisper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

63 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Open Super Whisper

Open Super Whisper Icon

Simple desktop application for speech transcription with global hotkey control. Record, transcribe, and paste - all without switching applications.

Quick Start - Just 3 Steps!

  1. Start Recording - Press the global hotkey (default: Ctrl+Shift+R) from any application
  2. Stop Recording - Press the same hotkey again when you're done speaking
  3. Paste Text - The transcription is automatically copied to your clipboard, just paste it wherever you need

That's it! No need to switch applications during your workflow.

Features

  • πŸŽ™οΈ Record audio directly from your microphone
  • 🌎 Support for 100+ languages with automatic language detection
  • πŸ“ Custom vocabulary support to improve transcription accuracy
  • πŸ”§ System instructions for controlling transcription behavior
  • πŸ“‹ Copy transcription to clipboard
  • πŸ”„ Real-time recording status and timer

Available Models

Open Super Whisper supports the following AI transcription models:

  • Whisper-1 - OpenAI's original open-source Whisper model
  • GPT-4o Transcribe - High-performance transcription model offering superior accuracy
  • GPT-4o Mini Transcribe - Lightweight and fast transcription model with a good balance of speed and accuracy

Demo

Demo of Open Super Whisper in action

Download

You can download the latest executable file (.exe) for Windows from our GitHub Releases page.

Requirements

  • OpenAI API key
  • Windows or macOS operating system

Installation

Using UV Package Manager

UV is a fast and efficient Python package installer and environment manager. It's faster than traditional pip and venv, and provides better dependency resolution.

  1. Check if UV is installed:
uv --version
  1. If not installed, you can install it with:
# Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh
  1. Clone or download this repository

  2. Set up the project using UV's sync command, which will create a virtual environment and install all dependencies:

uv sync
  1. Activate the virtual environment:
# Windows (PowerShell)
.\.venv\Scripts\activate.ps1

# macOS/Linux
source .venv/bin/activate

Note: If you get a "execution of scripts is disabled on this system" error when using activate.ps1 in PowerShell, try one of these solutions:

  1. Use Command Prompt (cmd.exe) and run .venv\Scripts\activate.bat instead
  2. Run the following command in PowerShell to change the execution policy for the current session only:
    Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process
    Then run .\.venv\Scripts\activate.ps1
  3. Run PowerShell as Administrator and change the execution policy for your user account (do this only if you understand the security implications):
    Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
  1. Run the application:
python main.py

Building the Application

To create a standalone executable, you can use PyInstaller:

# Windows (PowerShell)
python -m PyInstaller --onefile --windowed --icon assets/icon.ico --name "OpenSuperWhisper" --add-data "assets;assets" main.py

# For macOS
python -m PyInstaller --onefile --windowed --icon assets/icon.icns --name "OpenSuperWhisper" --add-data "assets:assets" main.py

# For Linux
python -m PyInstaller --onefile --windowed --icon assets/linux_pngs/icon_256.png --name "OpenSuperWhisper" --add-data "assets:assets" main.py

The Windows command does the following:

  • --onefile: Creates a single executable file
  • --windowed: Prevents a console window from appearing
  • --icon assets/icon.ico: Sets the application icon
  • --name "OpenSuperWhisper": Specifies the output filename
  • --add-data "assets;assets": Includes the entire assets directory in the executable

Once the build is complete, you'll find OpenSuperWhisper.exe in the dist folder on Windows, OpenSuperWhisper.app in the dist folder on macOS, or OpenSuperWhisper in the dist folder on Linux.

Usage

Setting up your API Key

  1. On first launch, you'll be prompted to enter your OpenAI API key
  2. If you don't have an API key, you can get one from OpenAI's website
  3. Your API key will be saved for future use
  4. To change it later, click "API Key Settings" in the toolbar

Recording Audio

  1. Click the "Start Recording" button to begin recording from your microphone
  2. Click "Stop Recording" when you're done
  3. The application will automatically transcribe your recording
  4. You can also use the global hotkey (default: Ctrl+Shift+R) to start/stop recording even when the application is in the background

Using Global Hotkeys

  1. The default hotkey is set to "Ctrl+Shift+R"
  2. Pressing this hotkey will start/stop recording even when the application is in the background
  3. To change the hotkey, click "Hotkey Settings" in the toolbar

Using the System Tray (Windows) or Menu Bar (macOS)

  1. The application stays resident in your system tray (Windows) or menu bar (macOS)
  2. Closing the window will keep the application running in the background
  3. Click the system tray/menu bar icon to toggle the application's visibility
  4. Right-click the system tray icon (Windows) or click the menu bar icon (macOS) to access a context menu with options to:
    • Show the application
    • Start/stop recording
    • Completely exit the application

Language Selection

  1. Select a language from the dropdown menu before recording or importing audio
  2. Choose "Auto-detect" to let Whisper identify the language automatically

Model Selection

  1. Select the Whisper model to use from the dropdown menu
  2. Different models offer different balances of accuracy and processing speed
  3. Your selected model will be remembered for future sessions

Custom Vocabulary

  1. Click "Custom Vocabulary" in the toolbar
  2. Add specific terms, names, or phrases that might appear in your audio
  3. These terms will help improve transcription accuracy

System Instructions

  1. Click "System Instructions" in the toolbar
  2. Add specific instructions to control transcription behavior, such as:
    • "Ignore filler words like um, uh, er"
    • "Add proper punctuation"
    • "Format text into paragraphs"
  3. These instructions help refine transcription results without manual editing

Managing Transcriptions

  1. View the transcription in the main text area
  2. Edit the text if needed (the text area is editable)
  3. Use the toolbar buttons to:
    • Copy the transcription to clipboard

Other Settings

  1. "Auto Copy" option: Toggle automatic copying of transcription to clipboard when completed

Command Line Options

The application supports the following command line arguments:

python main.py -m
# or
python main.py --minimized

Using the -m or --minimized option will start the application minimized to the system tray only, without showing the window.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages