Quickstart

Get from zero to your first voice dictation in under 5 minutes

Prerequisites

Before you begin, make sure you have the following installed:

Requirement	Version	Notes
Node.js	v18+	nodejs.org
Rust	Latest stable	rustup.rs
Groq API Key	—	console.groq.com/keys

Groq offers a free tier that is sufficient for personal use with Trueears. No credit card is required to get started.

Install Rust

Windows

winget install Rustlang.Rustup

Get up and running

1. Clone the repository and install dependencies

   git clone https://github.com/devv-shayan/Trueears.git
   cd Trueears
   npm install
   
2. Copy the environment file

   cp .env.example .env
   

   You can leave the defaults for now. The Groq API key is configured inside the app — not in .env.

3. Start the development build

   npm run dev
   

   This launches the Tauri dev server with hot-reload. The app window will appear after the Rust backend compiles (typically 30–60 seconds on first run).

4. Configure your Groq API key

   1. Press Ctrl+Shift+S to open Settings
   2. Go to the Transcription tab
   3. Paste your Groq API key
   4. Select a Whisper model (default: whisper-large-v3-turbo)

   Settings are saved automatically.

5. Make your first dictation

   1. Click into any text field — a browser address bar, a code editor, a chat input, anything
   2. Press Ctrl+Shift+K to start recording
   3. Speak your text
   4. Press Ctrl+Shift+K again to stop
   5. Trueears transcribes your speech and pastes it automatically

Keyboard shortcuts

Action	Windows / Linux	macOS
Record	Ctrl+Shift+K	Cmd+Shift+K
Settings	Ctrl+Shift+S	Cmd+Shift+S

Next steps

Installation

Download a pre-built binary instead of running from source

App Profiles

Configure per-app formatting so Trueears speaks the right language for every context