Skip to main content

Crate whisrs

Crate whisrs 

Source
Expand description

whisrs — shared types for CLI and daemon communication.

Re-exports§

pub use service::RestartOutcome;
pub use config::types::*;
pub use ipc::*;

Modules§

agent
Agent mode: send a voice (or typed) instruction to a coding agent session running in a configured directory, and hear a short reply when its turn ends ([[agents]]).
audio
Audio capture and recovery.
config
Configuration management and interactive setup for whisrs.
history
Transcription history — append-only JSONL storage.
hooks
Hooks fired when a recording session starts/stops. Driven by the state broadcast channel (see [crate::daemon::hooks::hook_dispatch_loop]).
hotkey
Global hotkey listener via evdev input devices.
ipc
IPC protocol: CLI↔daemon commands, responses, socket path, and wire framing.
llm
LLM integration for command mode and [[llm_commands]].
mcp
whisrs mcp: a read-only MCP server over stdio for the recordings folder, so an AI agent can find, read and search the user’s recordings.
mpris
Native MPRIS v2 pause/resume over the session D-Bus. Every player (browsers, Spotify, VLC, MPV, KDE Connect) registers as org.mpris.MediaPlayer2.*, so the session bus is the integration.
overlay
On-screen overlays: the recording pill, and the agent overlay (a row per active agent in a screen corner of its own).
recording
The recording feature: record mic + system audio to disk, transcribe afterwards.
replacements
User-defined word/phrase replacements ([replacements] in config.toml).
service
Init-system abstraction for controlling the whisrs user service.
state
Daemon state machine.
transcription
Transcription backends: trait definition and implementations.
tray
System tray indicator via StatusNotifierItem (KDE/freedesktop SNI protocol).
tts
Text-to-speech backends: trait definition and implementations.
window
Window tracking: detect focused window and restore focus.

Enums§

WhisrsError