Imported from Aditya190803/dictate (
AGENTS.md). Install upstream withnpx skills add Aditya190803/dictate. Copyright stays with the author.
dictate — agent setup (local)
Follow INSTALL.md → “For AI Coding Agents”. This file is the checklist for this machine.
Install (already on PATH)
cargo build --release --features words-ui
cp target/release/dictate ~/.local/bin/
Verify: dictate --version (expect 1.2.0 at the v1.2.0 tag; dev builds after it are 1.2.0-dev).
Non-interactive config
dictate config set SHORTCUT_DESKTOP gnome # match $XDG_CURRENT_DESKTOP
dictate config set SHORTCUT_OUTPUT type # type | paste | clipboard | stdout
dictate config set SHORTCUT_KEY_LIVE 'SUPER,R'
# API keys: dictate config set MISTRAL_API_KEY '...' (never commit)
Shortcuts
dictate setup
dictate doctor
GNOME / Windows: dictate setup installs the shortcut (dictate on the key).
Hyprland/Niri: bind the key to dictate (see INSTALL.md).
Run
- Dictation:
dictate(or your shortcut). - Dictionary:
dictate words/dictate words Hyprland(GTK UI needswords-ui).
Windows
Supported target; not a fork — one binary, #[cfg] split. Guide: docs/windows.md.
| Concern | Linux | Windows |
|---|---|---|
Output sinks (type/paste/clipboard) |
ydotool, wl-copy subprocesses |
in-process Win32 SendInput / clipboard |
| Daemon toggle | SIGUSR1 |
named pipe \\.\pipe\dictate-main (legacy live/smart pipes still work) |
| Global shortcuts | compositor binds | hotkey agent (RegisterHotKey, installed by dictate setup) |
| Autostart | systemd user units | HKCU\...\CurrentVersion\Run + %APPDATA%\dictate\hotkey-agent.vbs |
| Config dir | ~/.config/dictate |
%APPDATA%\dictate |
| TLS | rustls + ring | SChannel via native-tls (keep it — ring needs a C compiler) |
Code: src/platform/ (mod.rs routes in-process sinks via the @dictate pseudo-command; unix.rs vs windows/{input,clipboard,hotkeys,autostart}.rs) and src/control.rs (toggle transport).
Not built on Windows: words-ui (GTK4) and local (whisper-rs).
No C compiler is needed — that is why the Windows TLS backend is SChannel, not ring. A linker still is: x86_64-pc-windows-msvc uses the VS Build Tools, and x86_64-pc-windows-gnu needs MinGW-w64 binutils on PATH (dlltool + as, for the raw-dylib import libraries tokio and windows-sys generate). rustup's bundled dlltool is not sufficient — it shells out to as, which rustup does not ship.
Default SUPER,R cannot register on Windows (Win+R is the Run dialog); use CTRL,ALT,R.
Optional
~/.config/dictate/text.toml— dictionary, snippets, cleanup,[polish].docs/wispr-flow-gap.md— Wispr Flow vs dictate.