157 lines
3.9 KiB
Markdown
157 lines
3.9 KiB
Markdown
# aman
|
|
> Local amanuensis
|
|
|
|
Python X11 STT daemon that records audio, runs Whisper, applies local AI cleanup, and injects text.
|
|
|
|
## Requirements
|
|
|
|
- X11
|
|
- `sounddevice` (PortAudio)
|
|
- `faster-whisper`
|
|
- `llama-cpp-python`
|
|
- Tray icon deps: `gtk3`, `libayatana-appindicator3`
|
|
- Python deps (core): `numpy`, `pillow`, `faster-whisper`, `llama-cpp-python`, `sounddevice`
|
|
- X11 extras: `PyGObject`, `python-xlib`
|
|
|
|
System packages (example names): `portaudio`/`libportaudio2`.
|
|
|
|
<details>
|
|
<summary>Ubuntu/Debian</summary>
|
|
|
|
```bash
|
|
sudo apt install -y portaudio19-dev libportaudio2 python3-gi gir1.2-gtk-3.0 libayatana-appindicator3-1
|
|
```
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Arch Linux</summary>
|
|
|
|
```bash
|
|
sudo pacman -S --needed portaudio gtk3 libayatana-appindicator
|
|
```
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Fedora</summary>
|
|
|
|
```bash
|
|
sudo dnf install -y portaudio portaudio-devel gtk3 libayatana-appindicator-gtk3
|
|
```
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>openSUSE</summary>
|
|
|
|
```bash
|
|
sudo zypper install -y portaudio portaudio-devel gtk3 libayatana-appindicator3-1
|
|
```
|
|
|
|
</details>
|
|
|
|
## Python Daemon
|
|
|
|
Install Python deps:
|
|
|
|
X11 (supported):
|
|
|
|
```bash
|
|
uv sync --extra x11
|
|
```
|
|
|
|
## Config
|
|
|
|
Create `~/.config/aman/config.json` (or let `aman` create it automatically on first start if missing):
|
|
|
|
```json
|
|
{
|
|
"daemon": { "hotkey": "Cmd+m" },
|
|
"recording": { "input": "0" },
|
|
"stt": { "model": "base", "device": "cpu" },
|
|
"injection": {
|
|
"backend": "clipboard",
|
|
"remove_transcription_from_clipboard": false
|
|
},
|
|
"vocabulary": {
|
|
"replacements": [
|
|
{ "from": "Martha", "to": "Marta" },
|
|
{ "from": "docker", "to": "Docker" }
|
|
],
|
|
"terms": ["Systemd", "Kubernetes"]
|
|
},
|
|
"domain_inference": { "enabled": true }
|
|
}
|
|
```
|
|
|
|
Recording input can be a device index (preferred) or a substring of the device
|
|
name.
|
|
|
|
Hotkey notes:
|
|
|
|
- Use one key plus optional modifiers (for example `Cmd+m`, `Super+m`, `Ctrl+space`).
|
|
- `Super` and `Cmd` are equivalent aliases for the same modifier.
|
|
|
|
AI cleanup is always enabled and uses the locked local Llama-3.2-3B GGUF model
|
|
downloaded to `~/.cache/aman/models/` during daemon initialization.
|
|
|
|
Use `-v/--verbose` to enable DEBUG logs, including recognized/processed
|
|
transcript text and llama.cpp logs (`llama::` prefix). Without `-v`, logs are
|
|
INFO level.
|
|
|
|
Vocabulary correction:
|
|
|
|
- `vocabulary.replacements` is deterministic correction (`from -> to`).
|
|
- `vocabulary.terms` is a preferred spelling list used as hinting context.
|
|
- Wildcards are intentionally rejected (`*`, `?`, `[`, `]`, `{`, `}`) to avoid ambiguous rules.
|
|
- Rules are deduplicated case-insensitively; conflicting replacements are rejected.
|
|
|
|
Domain inference:
|
|
|
|
- Domain context is advisory only and is used to improve cleanup prompts.
|
|
- When confidence is low, it falls back to `general` context.
|
|
|
|
STT hinting:
|
|
|
|
- Vocabulary is passed to Whisper as `hotwords`/`initial_prompt` only when those
|
|
arguments are supported by the installed `faster-whisper` runtime.
|
|
|
|
## systemd user service
|
|
|
|
```bash
|
|
mkdir -p ~/.local/share/aman/src/assets
|
|
cp src/*.py ~/.local/share/aman/src/
|
|
cp src/assets/*.png ~/.local/share/aman/src/assets/
|
|
cp systemd/aman.service ~/.config/systemd/user/aman.service
|
|
systemctl --user daemon-reload
|
|
systemctl --user enable --now aman
|
|
```
|
|
|
|
## Usage
|
|
|
|
- Press the hotkey once to start recording.
|
|
- Press it again to stop and run STT.
|
|
- Press `Esc` while recording to cancel without processing.
|
|
- Transcript contents are logged only when `-v/--verbose` is used.
|
|
|
|
Wayland note:
|
|
|
|
- Running under Wayland currently exits with a message explaining that it is not supported yet.
|
|
|
|
Injection backends:
|
|
|
|
- `clipboard`: copy to clipboard and inject via Ctrl+Shift+V (GTK clipboard + XTest)
|
|
- `injection`: type the text with simulated keypresses (XTest)
|
|
- `injection.remove_transcription_from_clipboard`: when `true` and backend is `clipboard`, restores/clears the clipboard after paste so the transcript is not kept there
|
|
|
|
AI processing:
|
|
|
|
- Local llama.cpp model only (no remote provider configuration).
|
|
|
|
Control:
|
|
|
|
```bash
|
|
make run
|
|
make check
|
|
```
|