@@ -13,6 +13,7 @@ This is not just another dictation app. Onevox is:
1313> ** A Local Speech Inference Layer for the Operating System**
1414
1515It's designed for developers, power users, and anyone who values:
16+
1617- ** Privacy** : 100% local processing, no cloud dependencies
1718- ** Speed** : Sub-350ms latency for real-time dictation
1819- ** Flexibility** : Multiple model backends (Whisper, ONNX, etc.)
@@ -36,6 +37,7 @@ It's designed for developers, power users, and anyone who values:
3637### 🎉 Currently Working
3738
3839The app is ** fully functional** on macOS! You can:
40+
3941- Start the daemon and have it listen for hotkeys
4042- Speak and get real-time transcription from Whisper models
4143- Inject transcribed text into any application
@@ -53,6 +55,7 @@ The app is **fully functional** on macOS! You can:
5355### Prerequisites
5456
5557** Rust 1.93+ Required** :
58+
5659``` bash
5760# Install Rust (if not already installed)
5861curl --proto ' =https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
@@ -62,11 +65,13 @@ rustc --version # Should show 1.93 or higher
6265```
6366
6467** macOS** :
68+
6569``` bash
6670xcode-select --install
6771```
6872
6973** Linux (Ubuntu/Debian)** :
74+
7075``` bash
7176sudo apt-get install build-essential cmake pkg-config
7277```
@@ -96,10 +101,31 @@ cargo build --release
96101
97102to add command ` onevox ` (mac):
98103
99- ``` bash
104+ ``` bash
100105sudo ln -sf /Users/kevinsepulveda/Documents/onevox/target/release/onevox /usr/local/bin/onevox
101106onevox --help
102107```
108+
109+ to install whisper-cli:
110+
111+ ```
112+ # 1. Clone & build
113+ git clone https://github.com/ggerganov/whisper.cpp /tmp/whisper.cpp
114+ cd /tmp/whisper.cpp
115+ cmake -B build \
116+ -DCMAKE_C_COMPILER=$(xcrun -find clang) \
117+ -DCMAKE_CXX_COMPILER=$(xcrun -find clang++) \
118+ -DGGML_METAL=ON
119+ cmake --build build --config Release -j$(sysctl -n hw.logicalcpu)
120+
121+ # 2. Install
122+ mkdir -p ~/Library/Caches/com.onevox.onevox/bin
123+ cp build/bin/whisper-cli ~/Library/Caches/com.onevox.onevox/bin/whisper-cli
124+
125+ ```
126+
127+ ---
128+
103129### For TypeScript/Node Developers
104130
105131If you're coming from TypeScript/pnpm, see ** [ CHEATSHEET.md] ( CHEATSHEET.md ) ** for command equivalents!
@@ -110,8 +136,10 @@ cargo build # = pnpm install + build
110136cargo test # = pnpm test
111137cargo fmt # = pnpm format
112138```
139+
113140 libasound2-dev libx11-dev portaudio19-dev
114- ```
141+
142+ ````
115143
116144### Installation (Future)
117145
@@ -124,7 +152,7 @@ brew install onevox
124152
125153# Or download binary
126154curl -L https://github.com/yourusername/onevox/releases/latest/download/onevox-macos.tar.gz | tar xz
127- ```
155+ ````
128156
129157### macOS Installer (Phase 8)
130158
@@ -146,6 +174,7 @@ curl -fsSL https://raw.githubusercontent.com/kssgarcia/onevox/main/install.sh |
146174```
147175
148176` curl|sh ` options:
177+
149178``` bash
150179# System install
151180curl -fsSL https://raw.githubusercontent.com/kssgarcia/onevox/main/install.sh | sh -s -- --system
@@ -156,11 +185,14 @@ curl -fsSL https://raw.githubusercontent.com/kssgarcia/onevox/main/install.sh |
156185```
157186
158187Releases are published automatically when you push a version tag:
188+
159189``` bash
160190git tag v0.1.0
161191git push origin v0.1.0
162192```
193+
163194This creates release assets used by the installer:
195+
164196- ` onevox-macos-arm64.tar.gz `
165197- ` onevox-macos-x86_64.tar.gz `
166198
@@ -240,11 +272,13 @@ Onevox includes a **production-ready** terminal interface built with **OpenTUI**
240272### Quick Start
241273
242274** Prerequisites:** Install [ Bun] ( https://bun.sh )
275+
243276``` bash
244277curl -fsSL https://bun.sh/install | bash
245278```
246279
247280** Launch TUI:**
281+
248282``` bash
249283# Method 1: Via Rust CLI (recommended - auto-installs dependencies)
250284onevox tui
@@ -258,21 +292,23 @@ cd tui && bun install && bun start
258292
259293### Keyboard Shortcuts
260294
261- | Key | Action |
262- | -----| --------|
263- | ` Tab ` | Switch tabs (Config ↔ History ↔ Help) |
264- | ` t ` | Toggle dark/light theme |
265- | ` Ctrl+S ` | Save configuration |
266- | ` ? ` | Show help overlay |
267- | ` q ` / ` Ctrl+C ` | Quit |
295+ | Key | Action |
296+ | -------------- | --------------------------------------- |
297+ | ` Tab ` | Switch tabs (Config ↔ History ↔ Help) |
298+ | ` t ` | Toggle dark/light theme |
299+ | ` Ctrl+S ` | Save configuration |
300+ | ` ? ` | Show help overlay |
301+ | ` q ` / ` Ctrl+C ` | Quit |
268302
269303** Config Panel:**
304+
270305- ` Tab ` / ` Shift+Tab ` - Navigate fields
271306- ` Space ` - Toggle switches
272307- ` ← ` / ` → ` - Adjust steppers
273308- Click any control with mouse!
274309
275310** History Panel:**
311+
276312- ` ↑ ` / ` ↓ ` or ` j ` / ` k ` - Navigate entries
277313- ` c ` - Copy transcription to clipboard
278314- ` e ` - Export entry to file
@@ -350,6 +386,7 @@ auto_save = true
350386### History Format
351387
352388Each entry contains:
389+
353390- ** ID** : Unique identifier
354391- ** Timestamp** : When the transcription occurred
355392- ** Text** : The transcribed content
@@ -360,6 +397,7 @@ Each entry contains:
360397### TUI Integration
361398
362399The Terminal UI includes a dedicated ** History Panel** where you can:
400+
363401- Browse all past transcriptions
364402- View detailed metadata
365403- Copy transcriptions to clipboard
@@ -404,6 +442,7 @@ See [ARCHITECTURE.md](docs/ARCHITECTURE.md) for detailed design.
404442### Current Phase: ** Phase 8/8 Complete - Ready for Distribution** 🎉
405443
406444** What's Working:**
445+
407446- ✅ ** Phase 1** : Core infrastructure (daemon, IPC, config)
408447- ✅ ** Phase 2** : Audio pipeline (capture, streaming, device selection)
409448- ✅ ** Phase 3** : Voice Activity Detection (energy-based VAD)
@@ -422,6 +461,7 @@ See [PROGRESS.md](PROGRESS.md) for detailed implementation status.
422461## 🛠️ Technology Stack
423462
424463### Core (Rust)
464+
425465- ** Language** : Rust 1.93+ (Edition 2024)
426466- ** Audio** : ` cpal ` for cross-platform capture
427467- ** VAD** : Energy-based VAD with adaptive thresholding
@@ -431,6 +471,7 @@ See [PROGRESS.md](PROGRESS.md) for detailed implementation status.
431471- ** IPC** : Unix domain sockets with ` bincode `
432472
433473### Terminal UI (TypeScript)
474+
434475- ** Framework** : OpenTUI (flexbox-based TUI framework)
435476- ** Runtime** : Bun (fast TypeScript runtime)
436477- ** Config** : TOML parsing
@@ -442,13 +483,13 @@ See [DEPENDENCIES.md](docs/DEPENDENCIES.md) for full dependency list.
442483
443484## 📊 Performance Targets
444485
445- | Metric | Target | Hardware |
446- | --------| --------| ----------|
486+ | Metric | Target | Hardware |
487+ | ------------------------------- | ------ | ------------------ |
447488| End-to-end latency (1sec audio) | <350ms | M1 Pro, Tiny model |
448- | Model inference (tiny) | <100ms | M1 Pro, Metal |
449- | Hotkey activation | <10ms | Any |
450- | Memory usage (idle) | <500MB | Any |
451- | Memory usage (active) | <1.5GB | With base model |
489+ | Model inference (tiny) | <100ms | M1 Pro, Metal |
490+ | Hotkey activation | <10ms | Any |
491+ | Memory usage (idle) | <500MB | Any |
492+ | Memory usage (active) | <1.5GB | With base model |
452493
453494See [ PERFORMANCE.md] ( docs/PERFORMANCE.md ) for benchmarks and optimization guide.
454495
@@ -545,18 +586,21 @@ This project is licensed under the **MIT License** - see the [LICENSE](LICENSE)
545586## 🔮 Roadmap
546587
547588### Version 0.1.0 (MVP) - Q2 2026
589+
548590- ✅ Core daemon infrastructure
549591- ✅ macOS support
550592- ✅ whisper.cpp integration (tiny/base models)
551593- ✅ Basic TUI
552594
553595### Version 0.2.0 - Q3 2026
596+
554597- ✅ Linux support
555598- ✅ Multiple model backends (ONNX, Candle)
556599- ✅ Advanced VAD
557600- ✅ Performance optimizations
558601
559602### Version 1.0.0 - Q4 2026
603+
560604- ✅ Windows support
561605- ✅ Plugin system
562606- ✅ Multi-language support
@@ -568,7 +612,7 @@ This project is licensed under the **MIT License** - see the [LICENSE](LICENSE)
568612
569613- ** Issues** : [ GitHub Issues] ( https://github.com/yourusername/onevox/issues )
570614- ** Discussions** : [ GitHub Discussions] ( https://github.com/yourusername/onevox/discussions )
571- - ** Email** : your.email@example.com
615+ - ** Email** : < your.email@example.com >
572616
573617---
574618
0 commit comments