Squeak

Local voice dictation for Windows. Speech stays on your PC.

_{Purple pill at the bottom of the screen = ready. Hold Win+Ctrl to dictate.}

_{Other releases}

---

How to use

1. Install and launch Squeak (see below). Allow microphone access when Windows asks.
2. Look for the purple pill along the bottom edge of your screen and the tray icon in the taskbar.
3. Dictate:
   • Push-to-talk — hold Win+Ctrl, speak, release. Hold at least ~300 ms so recording starts.
   • Hands-free — double-tap Win+Ctrl to start; double-tap again to stop.
4. Text is typed at the caret. Shift+Alt+Z pastes the last transcript again.
5. Tray menu — speech model, settings, Open config.toml, Check for updates…, quit.

On first dictation, speech models download once to %LOCALAPPDATA%\Squeak\models\ (not included in the installer). Settings live in %APPDATA%\Squeak\config.toml.

Updates (MSI installs): Tray → Check for updates… looks for a newer release on GitHub, asks for confirmation, then downloads the MSI and restarts Squeak.

Tips if accuracy feels off

======= Squeak types what you say at the cursor: email, docs, chat, editors. Push-to-talk, optional hands-free, light cleanup (fillers and punctuation). Not for meeting transcription or macOS/Linux.

Install the MSI, allow the microphone, launch from the Start Menu. Hold Win+Ctrl while you talk (wait ~300 ms before speaking). Double-tap Win+Ctrl for hands-free; double-tap again to stop. Shift+Alt+Z pastes the last transcript again. Tray menu: model, settings, config.toml, quit.

Models download on first dictation to %LOCALAPPDATA%\Squeak\models\. Settings: %APPDATA%\Squeak\config.toml.

Recognition off? Hold Win+Ctrl the whole time, try Moonshine Small or Medium in the tray, check Settings → Privacy → Microphone.

---

Install

Windows 10+, a mic, admin rights for the MSI.

Use the download button above, or grab Squeak-*-x64.msi from Releases. Installs to C:\Program Files\Squeak\. Remove via Settings → Apps.

msiexec /i ".\Squeak-0.1.0-x64.msi"

Build from source (Rust on Windows): clone, cargo run --release. MSI: .\installer\build.ps1 (WiX 3.14, e.g. choco install wixtoolset --version=3.14.1 -y).

---

CI

• ci.yml — runs on every push to main and every pull request targeting main:
  • validate-linux — cargo fmt, Clippy, unit tests
  • validate-windows — release compile check, ASR smoke/bench on a committed fixture
  • build-msi — builds the MSI only after both validation jobs pass
• msi.yml — runs on version tags (v*) or manual dispatch: same validation + MSI build, then uploads the MSI to the GitHub release.

main is branch-protected: merges require validate-linux, validate-windows, and build-msi to pass.

See the Actions tab for workflow runs.

---

Contributing

Open an issue or pull request. Note what you tested on Windows. Background in docs/.

---

_MIT