Skip to content

Configuration

Attyx is configured via a TOML file at ~/.config/attyx/attyx.toml. Every setting can also be overridden with CLI flags.

The config file is read from $XDG_CONFIG_HOME/attyx/attyx.toml. On most systems this resolves to:

~/.config/attyx/attyx.toml

Override the path with --config <path>, or skip the config file entirely with --no-config.

Settings are loaded in three layers, each overriding the previous:

Defaults → Config file → CLI flags

See the CLI reference for all available flags.

Copy the example config and edit it:

Terminal window
mkdir -p ~/.config/attyx
cp /path/to/attyx/config/attyx.toml.example ~/.config/attyx/attyx.toml

Or start from scratch — only add the settings you want to change. Anything you leave out uses the default.

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]
level = "info"
file = "/tmp/attyx.log"
OptionTypeDefaultDescription
levelstring"info""err", "warn", "info", "debug", or "trace"
filestringAppend logs to this file
[updates]
check_updates = true
OptionTypeDefaultDescription
check_updatesbooleantrueEnable automatic update checking
SectionPage
[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