summaryrefslogtreecommitdiff
path: root/docs/CONFIGURATION.md
blob: 529fab7543b91cce165d701acc72d20370dd24f3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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
```