Aurum¶
Speech both ways. On-device by default.
Private speech I/O on your machine:
- STT — audio → text (whisper.cpp; optional OpenRouter)
- Cleanup — post-transcript flow styles (rules or LLM)
- TTS — text → mono WAV (local ONNX KittenTTS; no cloud)
The same core powers the aurum CLI, Rust embeds (aurum-core), and native STT embeds (aurum-ffi).
Local by default
No API key required on the default path. Models download once into the platform cache, then stay local.
30-second path¶
git clone https://github.com/joe-broadhead/aurum.git
cd aurum
./scripts/install.sh
# or: cargo install aurum-stt
aurum models
aurum meeting.m4a --model tiny-q5_1
aurum meeting.m4a --cleanup clean
aurum tts "Hello from aurum" --output-file /tmp/hello.wav
Architecture¶
flowchart LR
subgraph stt [STT]
A[Audio / PCM] --> B[Load]
B --> C{Provider}
C -->|local| D[whisper.cpp]
C -->|openrouter| E[LLM-assisted]
D --> F[postprocess]
E --> F
F --> G[cleanup]
G --> H[txt / srt / json]
end
subgraph tts [TTS]
T[Text] --> U[validate]
U --> V[KittenTTS ONNX]
V --> W[mono WAV]
end Workspace¶
| Crate | Role |
|---|---|
aurum-core | Engine (STT + TTS + cleanup) |
aurum-stt | CLI (aurum) |
aurum-ffi | C ABI for native STT hosts |
Where to go next¶
| Goal | Page |
|---|---|
| Install | Installation |
| Quickstart | Quickstart |
| CLI | CLI reference |
| TTS | TTS guide |
| Cleanup | Cleanup |
| Rust embed | Integration |
| Native STT | FFI |
| Contribute | Contributing |
Status¶
v0.0.17 — Group H 1.0 assurance slice: cosign, long fuzz, clean-install CI, repro.
APIs may change before 0.1.0; pin a release tag in dependents.