diff --git a/README.md b/README.md index 0db241a..a2c67f0 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Voice-to-text for the Noctalia bar, powered by Click the microphone (or bind a hotkey) to start recording — the capsule turns into a red record indicator with an elapsed timer while the microphone is live. Click again to stop: OSTT transcribes the audio and, by default, -**pastes the transcript straight into the focused app** (`ostt --paste`). +**copies the transcript to your clipboard** (`ostt -c`) — ready to paste. No popup terminal is spawned; the recorder runs headlessly and the bar capsule is the only UI. @@ -19,11 +19,23 @@ The indicator also lights up for recordings started outside Noctalia (e.g. an | --- | --- | | ID | `prdlk/ostt` | | Entries | Bar widget: `recorder`; service: `monitor` | -| Requires | [`ostt`](https://ostt.ai/guide/installation), `script` (util-linux) | +| Requires | [`ostt`](https://ostt.ai/guide/installation), `script` (util-linux), `wl-clipboard` on Wayland (`xclip` on X11) | -For paste output on Wayland you also need `wtype` or `ydotool` (`xdotool` on -X11) — see the [OSTT docs](https://ostt.ai). Pick a transcription model once -with `ostt model` / `ostt auth`. +Pick a transcription model once with `ostt model` / `ostt auth`. + +### Output modes + +**Clipboard (default)** — `ostt -c` copies the transcript with `wl-copy` +(Wayland) or `xclip` (X11). Paste it anywhere with your normal paste; the +transcript is also readable from scripts via `wl-paste`. + +**Paste (opt-in)** — `ostt --paste` copies the transcript, then injects a +single paste shortcut (`wtype`/`ydotool`/`xdotool`) into the focused app. Per +the [OSTT docs](https://ostt.ai/guide/configuration#paste-output) it sends +exactly one configurable key — default `ctrl+v` — and cannot detect success, +so it silently does nothing in apps with a different paste binding (terminals +usually want `ctrl+shift+v`). Tune `[output.paste] paste_key` in +`~/.config/ostt/ostt.toml` before enabling it. ## Usage @@ -41,7 +53,7 @@ spinner (transcribing). | Setting | Type | Default | Description | | --- | --- | --- | --- | -| `output_mode` | `select` | `paste` | Where the transcript goes: paste into the focused app, or copy to the clipboard. | +| `output_mode` | `select` | `clipboard` | Where the transcript goes: copy to the clipboard, or paste into the focused app. | | `model` | `string` | *(empty)* | Optional `provider/model` override (e.g. `deepgram/nova-3`, `whisper/turbo`). Empty uses the model selected with `ostt model`. | | `process_action` | `string` | *(empty)* | Optional post-processing action id from `ostt.toml` (`ostt -p `). | | `show_elapsed` | `bool` | `true` | Show the elapsed timer while recording. |