Skip to content

Latest commit

 

History

History
247 lines (167 loc) · 12.4 KB

README.md

File metadata and controls

247 lines (167 loc) · 12.4 KB
Raw

Whispering

Whispering

Seamless speech-to-text at your fingertips, powered by OpenAI

MIT License TypeScript Rust Chrome macOS Windows Linux

Introduction

Whispering is an open-source, cross-platform transcription app that harnesses the power of the OpenAI Whisper API to provide efficient speech-to-text conversion. It's designed to seamlessly integrate into your workflow, eliminating the need for manual transcription and streamlining your productivity.

Features

  1. Global Transcription: Access Whisper's speech-to-text functionality anywhere with a global keyboard shortcut or within two button clicks.

  2. Cross-Platform Experience:

    • Desktop App: Enables global transcription across all applications.
    • Browser Extension: Provides global transcription in the browser by communicating with the web app.

  3. Chat Integration: The browser extension adds a recording button to ChatGPT and Claude websites, allowing direct voice input and transcription in the chat interface.

  4. Transcription Management: Review and edit transcriptions within the Whispering app to ensure accuracy and clarity.

  5. Automatic Clipboard Integration: Once transcription is complete, the text is automatically copied to your clipboard. An option for automatic pasting is also available.

How It Works

  1. Trigger Whispering using the global shortcut or button.
  2. Speak your message.
  3. Whispering transcribes your speech using the OpenAI Whisper API.
  4. The transcription is copied to your clipboard and optionally pasted automatically.
  5. Review and edit the transcription in the Whispering app if needed.

Demo

demo_3.mp4

Sure, here's a revised version of the README with a more professional tone and best practices for the installation steps:

Installation

Web App

Visit whispering.bradenwong.com, which has the latest version of the apps/app folder hosted on Vercel.

Chrome Extension

Install the Chrome Extension from the Chrome Web Store here.

Desktop App

To download and install the Whispering desktop app, follow the steps for your operating system:

Windows

  1. Download the installation package ending in .msi from the latest releases page.
  2. Open the downloaded .msi file to run the installer.
  3. If prompted as unsafe, click on More Info -> Run Anyway to proceed with the installation.
  4. Follow the on-screen instructions to complete the installation.

MacOS

  1. Download the installation package ending in .dmg from the latest releases page.
  2. Open the downloaded .dmg file to run the installer.
  3. Drag the Whispering app to the Applications folder.
  4. If you encounter a warning that the developer cannot be verified, click Cancel, then right-click the app in Finder and select Open.

After installation, the app will be ready to use.

Linux

For Linux, there are multiple installation options available. Choose the one that suits your environment:

  1. AppImage:

    • Download the .AppImage file from the latest releases page.
    • Make the file executable: 
      chmod +x whispering_x.x.x_amd64.AppImage
    • Run the AppImage: 
      ./whispering_x.x.x_amd64.AppImage

  2. DEB Package (Debian/Ubuntu):

    • Download the .deb file from the latest releases page.
    • Install the package using dpkg: 
      sudo dpkg -i whispering_x.x.x_amd64.deb
    • Resolve any dependency issues: 
      sudo apt-get install -f

After installation, the app will be ready to use.

Usage

Chrome Extension

After installing the Chrome Extension, you will find a Whispering icon on the Chrome extensions bar. Click on this icon to open the extension. To use the Whisper API feature, simply click the 'Start Recording' microphone button to record your voice, and then 'Stop Recording' square button when you're done. Your transcription will appear in the text box below.

To access the ChatGPT feature, navigate to the ChatGPT web page. You'll see a new recording button in the chat interface. Click this button to start and stop recording, and the transcribed text will be automatically inserted into the chat input field.

To access the shortcut feature, press Control + Shift + X or Command + Shift + X to start recording from any website. The transcription will be automatically copied into your clipboard and paste into the current input field.

Web App

To start using the Whispering web app, click the button below:

Open Web App

Desktop App

After installing the Whispering desktop app, press Control + Shift + ; or Command + Shift + ; to start recording from anywhere on your desktop. The application will come into focus while recording, and will minimize when you stop recording. The transcription will be automatically copied into your clipboard and can be configured to automatically paste.

Built With

Web and Desktop

Whispering web and desktop app is built using the following technologies and libraries:

  • Tauri: A framework for building lightweight, secure, and fast cross-platform applications with web technologies.
  • SvelteKit: A framework for building web applications and the Tauri frontend.
  • svelte-french-toast: A simple, customizable toast library for Svelte applications.
  • TailwindCSS: A utility-first CSS framework for rapidly building custom user interfaces.
  • Cloudflare Pages: A global cloud platform for deploying static pages.

Extension

The Whispering Chrome extension is built using:

  • Plasmo: A framework for building Chrome extensions.
  • Svelte: A JavaScript framework for building user interfaces.
  • svelte-french-toast: A simple, customizable toast library for Svelte applications.
  • TailwindCSS: A utility-first CSS framework for rapidly building custom user interfaces.
  • Chrome API: The Chrome extension API.
  • Zapsplat.com: A royalty-free sound effects library.

Run Whispering in Local Development Mode

To set up the project on your local machine, follow these steps:

  1. Clone the repository: git clone https://github.com/braden-w/whispering.git
  2. Change into the project directory: cd whispering
  3. Install the necessary dependencies: pnpm i

To run the Whispering desktop app and website in development mode:

  1. Change into the app directory: cd apps/app
  2. Run the development server: pnpm tauri dev

The desktop app should automatically open for local development. To develop the web app, open your browser and navigate to http://localhost:5173.

To run the Whispering Chrome extension in development mode:

  1. Change into the extension directory: cd apps/extension
  2. Run the development server: pnpm dev --target=chrome-mv3

To develop the chrome extension, load it into Chrome by navigating to chrome://extensions, enabling developer mode, and loading the apps/extension/build/{platform}-{manifest-version}-dev folder as an unpacked extension.

Build The Executable Yourself

If you ever have concerns regarding the trustworthiness of the installers or would like more control, you can always build the executable yourself. This requires more setup, but it ensures that you are running the code you expect. Such is the beauty of open-source software!

Chrome

  1. Change into the extension directory: cd apps/extension
  2. Install the necessary dependencies: pnpm i
  3. Run Plasmo build: pnpm plasmo build --target=chrome-mv3
  4. Output should be found in apps/extension/build/chrome-mv3-prod, which can be loaded into Chrome as an unpacked extension.
  5. Alternatively, you can build the extension for the Chrome Web Store: pnpm plasmo build --target=chrome-mv3 --release

Firefox

  1. Change into the extension directory: cd apps/extension
  2. Install the necessary dependencies: pnpm i
  3. Run Plasmo build: pnpm plasmo build --target=firefox-mv3
  4. Output should be found in apps/extension/build/firefox-mv3-prod, which can be loaded into Chrome as an unpacked extension.
  5. Alternatively, you can build the extension for the Chrome Web Store: pnpm plasmo build --target=firefox-mv3 --release

Desktop

  1. Change into the app directory: cd apps/app
  2. Install the necessary dependencies: pnpm i
  3. Run Tauri Build: pnpm tauri build
  4. You can find the executable in the apps/app/target/release directory.

Contributing

We welcome contributions from the community! If you'd like to contribute to Whispering, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix: git checkout -b feature/your-feature-name or git checkout -b fix/your-bugfix-name
  3. Make your changes and commit them with a descriptive message.
  4. Push your branch to your forked repository: git push origin your-branch-name
  5. Create a pull request from your forked repository to the original one.

Please ensure your code follows established conventions and is well-documented.

License

Whispering is released under the MIT License.

Sponsors

This project is supported by the following amazing people and organizations:

Chris Burgess

Support and Feedback

If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub iusses tab. I really appreciate your feedback!

Thank you for using Whispering and happy writing!