From 58b465b5b84cb90424eeffd6f877c8e5ad7bd647 Mon Sep 17 00:00:00 2001 From: Yuval Adam <_@yuv.al> Date: Fri, 24 Jul 2026 13:27:46 +0200 Subject: Replace environment configuration with TOML --- docs/CONFIGURATION.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs/CONFIGURATION.md (limited to 'docs') diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md new file mode 100644 index 0000000..529fab7 --- /dev/null +++ b/docs/CONFIGURATION.md @@ -0,0 +1,46 @@ +# Configuration + +Parley works without a configuration file. System executables are discovered on +`PATH`, the model uses the standard Parley data directory, IBus insertion is +enabled, and notifications are disabled. + +Optional settings live in: + +```text +~/.config/parley/config.toml +``` + +Only settings that differ from the defaults need to be present: + +```toml +[audio] +ffmpeg = "ffmpeg" +device = "default" +sample_rate = 16000 + +[transcription] +command = "transcribe-cli" +model = "~/.local/share/parley/models/parakeet-unified-en-0.6b-Q8_0.gguf" +language = "en" + +[storage] +transcript_directory = "~/.local/share/parley/transcripts" + +[insertion] +enabled = true +mode = "ibus" # "ibus" or "clipboard" + +[notifications] +enabled = false +``` + +Executable settings may be command names on `PATH` or absolute paths. The +configured transcription command must currently support the same command-line +and JSONL output contract as `transcribe-cli`. Supporting unrelated runtimes +requires a separate adapter and is not implied by changing `command`. + +Restart the daemon after editing the file: + +```bash +systemctl --user restart parley.service +``` -- cgit v1.3.1