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:

PlatformPath
macOS / Linux~/.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 ([live]): font family, font size, cell width, cell height, font fallback, ligatures, theme, theme background, scrollback lines, reflow, agent status, MCP settings, cursor shape, cursor blink, cursor trail, background opacity, background blur, window decorations, scrollbar, padding, option-as-alt, tab always-show, tab side, split resize step, keybindings, sequences, popups, status bar

Requires restart ([restart]): tab appearance, dim unfocused, sessions, logging, updates, xyron

[logging]
level = "warn"
file = "/tmp/attyx.log"
OptionTypeDefaultDescription
levelstring"warn""err", "warn", "info", "debug", or "trace"
filestringAppend logs to this file (defaults to stderr)
[updates]
check_updates = true
OptionTypeDefaultDescription
check_updatesbooleantrueEnable automatic update checking
[keyboard]
option_as_alt = true
OptionTypeDefaultDescription
option_as_altboolean or stringtruemacOS only. How the Option (⌥) key behaves: true sends Alt/Meta (ESC-prefixed) sequences, false composes accented characters using your keyboard layout, "left" / "right" makes only that one Option key act as Alt while the other composes

Arrow-key word navigation (Option+←/→) works regardless of this setting.

[agent]
status = true
telemetry = true
OptionTypeDefaultDescription
statusbooleantrueDetect AI coding agents (Claude Code, Codex, opencode, pi.dev) and show a colored status dot on the tab — green = idle, orange = working, purple = needs input. Set to false to disable detection entirely
telemetrybooleantrueTrack per-agent token, cost, and context-window usage, surfaced by list agents, watch agents, and the agent dashboard. Set to false to skip the usage injectors. Applied when the agent integrations are installed (attyx skill install), so re-run that after changing it

See Agent Workflows for how status detection works, and Integration → Tracking agents for the usage fields.

While the UI is open, Attyx serves an HTTP MCP endpoint so MCP clients (e.g. Claude) can drive the terminal — list and create panes and tabs, send keys, read pane output, manage sessions, and check agent status.

[mcp]
enabled = true
host = "127.0.0.1"
port = 7333
OptionTypeDefaultDescription
enabledbooleantrueServe the HTTP MCP endpoint at http://<host>:<port>/mcp while the UI is open
hoststring"127.0.0.1"Bind address. Keep this on loopback — the tools run arbitrary commands in your terminal, so never expose them to the network
portinteger7333HTTP listen port. Set to 0 to disable the HTTP listener while keeping the stdio bridge available

The attyx mcp stdio bridge works regardless of this setting. See MCP Server for transports, client setup, and the full tool list.

Xyron shell integration. When enabled and xyron is detected, Attyx replaces the default shell with xyron and renders a block-based UI with bordered command output.

[xyron]
enabled = false
path = "/usr/local/bin/xyron"
OptionTypeDefaultDescription
enabledbooleanfalseEnable xyron integration
pathstringExplicit path to the xyron binary. If unset, Attyx searches PATH
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
[keyboard]Keyboard
[agent]Agent status
[mcp]MCP server
[xyron]Xyron