Configuration

animfetch needs no configuration. When you want some, it is one TOML file:

~/.config/animfetch/config.toml

Every key is optional: anything you leave out keeps its default. Copy config.example.toml, which documents each key in comments, or write just the lines you want:

toml

animation  = "cat-tail"
info_style = "boxed"
live       = true

animfetch --set <name> and --save edit this file for you as text, so your comments survive.

When the file is wrong#

A file that cannot be read, or contains a mistake, is not used at all: the fetch runs on the defaults and prints a warning that names the file and the line. That is deliberate. A stray comma should not stop your shell drawing, but it is never silent either, or your settings would vanish without a word.

animfetch: ~/.config/animfetch/config.toml:3: give either `value` or `command`, not both

Unknown keys are mistakes too, so a typo is caught rather than ignored.

Reference#

Animation#

Key	Default	Meaning
`animation`	`"cat-run"`	The animation to play. A name from `animfetch --list`, or a folder of your own.
`fps`	`12.0`	Frames per second, clamped to 1-120.
`width`	`56`	Largest width, in cells, the art may occupy. `0` fills the screen.
`height`	`20`	Largest height, in cells. `0` fills the screen.
`art`	`true`	Draw the animation. `false` leaves the info (and any border) alone.
`play_seconds`	`3.0`	How long `--play` animates.
`style`	`"half"`	`half`, `quad`, `ramp` or `raw`. See Theming.
`art_color`	`"own"`	For `raw` art with its own colours: `own` or `theme`.
`ramp`	`" ░▒▓█"`	Characters for `style = "ramp"`, lowest coverage first.

Colour#

Key	Default	Meaning
`color`	`true`	Emit colour. Forced off when piped or when `NO_COLOR` is set. Off, no colour codes are sent, so the terminal's own colours show.
`gray`	`false`	Draw in shades of grey: colour is sent with no hue in it. The same as `--no-color`.
`gradient`	five stops, gold to blue	Vertical colour ramp down the art. An empty list leaves it uncoloured.
`gradient_scroll`	`false`	Animate the gradient so it crawls through the art.
`accent`	`"#74a4ff"`	`user@host`, rules and labels.
`value`	`"#c8ccd4"`	Values.
`color_source`	`"config"`	`config`, or `palette` to follow your desktop theme.
`palette_files`	matugen, pywal, wallust	Candidate palette files, most preferred first.
`palette_accent`	`"primary"`	The palette name to use for `accent`.
`palette_value`	`"on_surface"`	The palette name to use for `value`.
`palette_gradient`	`["primary", "secondary", "tertiary"]`	The palette names to use for `gradient`.

Info pane#

Key	Default	Meaning
`info_style`	`"classic"`	The layout. See Info styles.
`modules`	the style's own	Rows to show, in order. See Modules.
`icons`	`true`	Draw Nerd Font icons beside labels in the styles that have them.
`gap`	`4`	Blank columns between the art and the info.
`footer`	`""`	A line of your own text, in the styles that have room (`card`).
`custom`	`[]`	Rows of your own, from text or a command. See Overrides.
`overrides`	none	Changes to built-in rows, keyed by module. See Overrides.
`command_timeout`	`1.0`	Seconds a `command` may take, clamped to 0.1-10.

Live rows#

Key	Default	Meaning
`live`	`false`	Keep uptime, memory, swap and disk current. See Live mode.
`live_interval`	`2.0`	Seconds between refreshes, clamped to 0.5-60.

Borders#

Key	Default	Meaning
`border_left`	`""`	Left ornament: a built-in name, your own, or a PNG path. Empty is none.
`border_bottom`	`""`	Bottom ornament, the same.
`border_render`	`"auto"`	`auto`, `image` or `cells`.
`border_bottom_lift`	`2.15`	Rows to raise the bottom ornament, capped at 3.
`border_bottom_shift`	`12.0`	Columns to move the bottom ornament right, capped at 24.

See Borders.

A fuller example#

toml

animation = "fox-run"
style     = "quad"
width     = 48

info_style = "card"
footer     = "we are free!"
modules    = ["os", "kernel", "uptime", "memory", "cpu", "custom"]

live          = true
live_interval = 2.0

[overrides.os]
label = "Distro"

[[custom]]
label = "Editor"
value = "helix"