Configuration
Attyx is configured via a TOML file at ~/.config/attyx/attyx.toml. Every setting can also be overridden with CLI flags.
Config file location
Section titled “Config file location”The config file is read from $XDG_CONFIG_HOME/attyx/attyx.toml. On most systems this resolves to:
~/.config/attyx/attyx.tomlOverride the path with --config <path>, or skip the config file entirely with --no-config.
Precedence
Section titled “Precedence”Settings are loaded in three layers, each overriding the previous:
Defaults → Config file → CLI flagsSee the CLI reference for all available flags.
Quick start
Section titled “Quick start”Copy the example config and edit it:
mkdir -p ~/.config/attyxcp /path/to/attyx/config/attyx.toml.example ~/.config/attyx/attyx.tomlOr start from scratch — only add the settings you want to change. Anything you leave out uses the default.
Hot reload
Section titled “Hot reload”Send SIGUSR1 or press Ctrl+Shift+R to reload the config at runtime.
Reloads immediately: cursor shape, cursor blink, cursor trail, scrollback lines, font family, font size, cell width, cell height, status bar settings, tab appearance, theme, keybindings, splits, popups
Requires restart: background opacity, background blur, logging level, logging file, program settings, updates
Logging
Section titled “Logging”[logging]level = "info"file = "/tmp/attyx.log"| Option | Type | Default | Description |
|---|---|---|---|
level | string | "info" | "err", "warn", "info", "debug", or "trace" |
file | string | — | Append logs to this file |
Updates
Section titled “Updates”[updates]check_updates = true| Option | Type | Default | Description |
|---|---|---|---|
check_updates | boolean | true | Enable automatic update checking |
All sections
Section titled “All sections”| Section | Page |
|---|---|
[font] | Font |
[cursor] | Cursor |
[window] / [background] | Window |
[program] | Shell |
[scrollback] / [reflow] | Scrollback |
[theme] | Themes |
[keybindings] | Keybindings |
[sequences] | Custom Sequences |
[tabs] / [splits] | Tabs & Splits |
[[popup]] | Popups |
[statusbar] | Status Bar |
[sessions] | Sessions |