# Hushtype

Hold a key, speak, and cleaned-up text is pasted at your cursor: an alternative to Wispr Flow for Linux and Android.

Hushtype runs on **Hushtype Cloud**: one subscription (with a free trial) covers transcription and cleanup on all your devices, and keeps your dictionary, snippets, styles and history in sync. No API keys to manage.

## Install (Ubuntu or Debian, GNOME on Wayland or X11)
Open a terminal (Ctrl+Alt+T) and paste:
```sh
curl -fsSL https://apt.gethushtype.com/install.sh | sh
```
Or download [hushtype_latest_amd64.deb](https://apt.gethushtype.com/hushtype_latest_amd64.deb) and open it. Either way it takes a few seconds: it adds the Hushtype apt repository, installs Hushtype, lets it type into your apps and read its hotkey (no logout needed) and starts it with your session. Open **Hushtype** from your apps and click **Sign in or create an account**: your browser opens, you approve this computer, and you're ready.

Then focus any text field, hold **Right Ctrl**, speak, release.

- Updates come with your system's normal updates (Software Updater, or `sudo apt upgrade`). The running daemon switches to the new version by itself the next time it's idle.
- Something not working? `hushtype doctor` says what's wrong and how to fix it.
- Remove: `sudo apt remove hushtype` (your settings, sign-in and history in your home folder are kept). `sudo apt purge hushtype` also removes the apt source.
- Turn off the repository the package adds: put `HUSHTYPE_APT_SOURCE=0` in `/etc/default/hushtype` before installing.

### From source (development)
`./install.sh` installs the build tools and Rust, builds Hushtype into `~/.cargo/bin` and sets it up for your user (`./uninstall.sh` removes it). Don't use it alongside the package: its per-user service hides the package's (`hushtype doctor` flags this, and the one-line installer above cleans it up).

## Features
- Record, transcribe, paste: [daemon](docs/daemon.md), [recording](docs/record.md), [paste](docs/paste.md)
- LLM cleanup and backtracking ("2, no, 3 pm" → "3 pm"): [cleanup](docs/cleanup.md)
- Hold-to-talk and GNOME shortcut: [hotkeys](docs/hotkeys.md)
- Personal dictionary and voice snippets: [dictionary-snippets](docs/dictionary-snippets.md)
- Per-app styles and paste keys: [styles](docs/styles.md)
- Command mode (rewrite the selection by voice): [command-mode](docs/command-mode.md)
- History as plain Markdown files and retry: [history](docs/history.md)
- Hushtype Cloud sign-in and subscription: [account](docs/account.md); sync between your devices: [sync](docs/sync.md)
- The window, `hushtype ui` (press Super, type "Hushtype"): overview, history with audio playback and style rewrites, account, settings, help, in the style of herdr-app; its whole interface is files you or an agent can restyle live: [app](docs/app.md), [launcher](docs/launcher.md)
- Owl in the top bar that changes colour while recording: [tray](docs/tray.md)
- All settings: [config](docs/config.md)

## Android
A keyboard (IME) and a floating mic bubble with the same cleanup, dictionary, snippets, per-app styles, command mode and history, plus meeting notes. Sign in with the same account and everything syncs. Download: https://gethushtype.com/download/android. Code: the `hushtype-android` repo.

## Privacy: what is sent where
- **Audio** goes to Hushtype Cloud, which passes it to your plan's speech-to-text provider to transcribe it. The gateway keeps usage counts (duration, tokens), never the audio or the text.
- **Transcript text** goes the same way for cleanup (set `[cleanup] enabled = false` to skip it). In command mode the selected text and your instruction go too.
- **Synced data** (dictionary, snippets, styles, settings, history text; never audio) is encrypted before it leaves your computer and stored as ciphertext. Hushtype Cloud holds the key, so there is no passphrase, and it is not end-to-end encrypted ([sync](docs/sync.md)).
- This computer's **key** is its own, revocable from your account, kept in a mode-600 file and never logged.
- The hotkey reader looks only at the configured keys and never stores keystrokes. Paste keys are sent through Hushtype's own virtual keyboard (`/dev/uinput`); no ydotool daemon. Dictation history stays on disk under `~/.local/share/hushtype/`.
- No telemetry.

## Changing Hushtype with an AI agent
Features live in `src/features/`. Build needs the `contracts` repo checked out at `../../contracts` (see the home repo).
