Skip to content

README.md

Latest commit

 

History

History
89 lines (63 loc) · 2.42 KB

README.md

File metadata and controls

89 lines (63 loc) · 2.42 KB

QuillScribe

Voice-powered transcription — local or cloud, always private.

Release License Build

Install

Linux (one-click):

curl -fsSL https://raw.githubusercontent.com/theguy000/QuillScribe/main/install.sh | bash

Windows / Manual download: Latest Release

Features

  • Local & cloud transcription — Whisper models offline, or OpenAI / Groq APIs
  • Global hotkey — Record from any application
  • Flexible output — Clipboard, auto-type, or both
  • Floating overlay — Always-on-top recording timer
  • System tray — Background mode with quick-access menu
  • History — Browse and search past transcriptions
  • 12 themes — 6 light + 6 dark
  • Auto-updates — Seamless OTA via GitHub Releases

Tech Stack

Svelte 5 · Tauri 2 · Rust · whisper.cpp · cpal

Development

Prerequisites

Quick Start

npm install
npx tauri dev

Build

npx tauri build          # NSIS (Windows) · deb / AppImage (Linux)

Lint

cargo fmt --check --manifest-path src-tauri/Cargo.toml
cargo clippy --manifest-path src-tauri/Cargo.toml -- -D warnings

Architecture

Tauri two-process model — Svelte 5 frontend in a WebView, Rust backend for audio, transcription, and system integration. IPC via invoke() commands and Tauri events.

Module Role
audio.rs Microphone capture, device enumeration
whisper.rs Model management, transcription
commands.rs IPC command handlers
config.rs Settings persistence
output.rs Clipboard & auto-type
tray.rs System tray
hotkey.rs Global shortcuts
window.rs Window & overlay management

License

MIT