Skip to content

Commit ea2ed90

Browse files
sprawfsprawf
committed
Add README
1 parent b017f51 commit ea2ed90

1 file changed

Lines changed: 148 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
# ⚡ Hotkeys
2+
3+
> **Rewrite any text, in any app, in under a second. No copy-paste. No switching windows. Just a hotkey.**
4+
5+
Hotkeys sits silently in your system tray and gives you two superpowers:
6+
7+
- **AI Text Refiner** — select any text anywhere, press a hotkey, it gets rewritten by AI and pasted back instantly
8+
- **Voice-to-Text** — press a hotkey, speak, release — your words appear wherever your cursor is
9+
10+
Works in every app. Notion, Gmail, Slack, Word, VS Code, browsers — anywhere.
11+
12+
---
13+
14+
## What makes it different
15+
16+
Most AI writing tools live inside a browser tab or a separate window. You have to copy your text, switch apps, paste, wait, copy again, switch back, paste again.
17+
18+
Hotkeys does it **in place**. Select text → press `Alt+Shift+W` → it's already rewritten and pasted back. Never leave the app you're in.
19+
20+
The **prompt library** is what makes it powerful. Build a collection of reusable instructions:
21+
22+
- *"Fix grammar and spelling"*
23+
- *"Make this sound more professional"*
24+
- *"Translate to Spanish"*
25+
- *"Make this shorter"*
26+
- *"Rewrite this as bullet points"*
27+
28+
One click on any prompt → applied to your selected text → pasted back. Instantly.
29+
30+
---
31+
32+
## Features
33+
34+
| Feature | Description |
35+
|---|---|
36+
| 🎙️ Voice to text | Press hotkey → speak → text appears in any app |
37+
| ✍️ AI text refiner | Select text → hotkey → AI rewrites it in place |
38+
| 📚 Prompt library | Save and reuse your favourite AI instructions |
39+
| 🔍 Live search | Search your prompt library as you type |
40+
| 🔄 Drag to reorder | Drag prompts to organise them your way |
41+
| 📋 History | Browse all your past transcriptions |
42+
| 🔇 Noise reduction | Works even in noisy environments |
43+
| 🚀 Push-to-talk | Hold hotkey to record, release to transcribe |
44+
| ⚡ Instant paste | Output appears directly where your cursor is |
45+
| 🖥️ System tray | Runs in the background, zero UI clutter |
46+
47+
---
48+
49+
## Hotkeys
50+
51+
| Action | Shortcut |
52+
|---|---|
53+
| Start / stop voice recording | `Ctrl + Enter` |
54+
| Refine selected text with AI | `Alt + Shift + W` |
55+
| Open prompt library | `Alt + Shift + E` |
56+
| Cancel recording | `Escape` |
57+
58+
All hotkeys are customisable in Settings.
59+
60+
---
61+
62+
## AI Providers
63+
64+
Hotkeys works with **Cerebras** and **Groq** — both offer free API tiers that are fast enough for real-time use.
65+
66+
| Provider | Speed | Free tier |
67+
|---|---|---|
68+
| Cerebras | ~0.3s | ✅ Yes — [cerebras.ai](https://cerebras.ai) |
69+
| Groq | ~0.5s | ✅ Yes — [console.groq.com](https://console.groq.com) |
70+
71+
Sign up, grab a free API key, paste it in Settings. Done.
72+
73+
---
74+
75+
## Installation
76+
77+
### Windows
78+
79+
1. Download the latest release: **[Hotkeys-v1.0-win64.zip](https://github.com/sprawf/hotkeys/releases)**
80+
2. Extract anywhere
81+
3. Double-click `Hotkeys.exe`
82+
4. The ⚡HK icon appears in your taskbar tray
83+
84+
No Python. No setup. No dependencies. Just run it.
85+
86+
---
87+
88+
### Mac
89+
90+
1. Download the installer: **[install_mac.command](https://github.com/sprawf/hotkeys/raw/main/install_mac.command)**
91+
2. Right-click it → **Open** (Mac security step, one time only)
92+
3. A terminal window opens and installs everything automatically (~10 min)
93+
4. Follow the on-screen prompt to grant keyboard permission
94+
5. Double-click **Hotkeys.command** on your Desktop to launch
95+
96+
The installer handles Python, all packages, and the AI models (~600 MB download). You don't need to install anything manually.
97+
98+
---
99+
100+
## Screenshots
101+
102+
*Coming soon*
103+
104+
---
105+
106+
## Running from source
107+
108+
```bash
109+
git clone https://github.com/sprawf/hotkeys.git
110+
cd hotkeys
111+
112+
# Windows
113+
python -m venv venv
114+
venv\Scripts\pip install -r requirements.txt
115+
venv\Scripts\python main.py
116+
117+
# Mac
118+
python3 -m venv venv
119+
venv/bin/pip install -r requirements_mac.txt
120+
venv/bin/python3 main.py
121+
```
122+
123+
Models are downloaded automatically on first run if not present locally.
124+
125+
---
126+
127+
## Tech stack
128+
129+
- **UI** — CustomTkinter (dark themed, no web view)
130+
- **Speech-to-text** — faster-whisper (Whisper small/base models, runs fully offline)
131+
- **VAD** — Silero VAD (auto-stops recording when you stop speaking)
132+
- **AI providers** — Cerebras, Groq (cloud, requires API key)
133+
- **Hotkeys** — keyboard library (global, works across all apps)
134+
- **Tray** — pystray
135+
136+
---
137+
138+
## Privacy
139+
140+
- Voice is transcribed **locally on your device** — never sent to any server
141+
- Text refinement is sent to Cerebras or Groq (whichever you configure) — same as any AI assistant
142+
- No analytics, no telemetry, no accounts required
143+
144+
---
145+
146+
## License
147+
148+
MIT — free to use, modify, and distribute.

0 commit comments

Comments
 (0)