Documentation

animfetch docs

Everything about installing, running and shaping animfetch. New here? Start with installation, then the quick start.

Getting started

IntroductionWhat animfetch is, how pinning works, and what it needs to run.
InstallationInstall animfetch on Arch, Nix, any Linux or macOS with the install script, or from source.
Quick startRun animfetch, choose an animation and a layout, and start it with your shell.

ModesThe four ways to run animfetch - pinned, played, once, or interactive - and when to use each.
Interactive modeRunning animfetch with no flag - the pinned fetch with its own prompt, and its keys.
CLI referenceEvery animfetch flag, grouped by what it does, with the config key each one overrides.

ConfigurationThe config file, how mistakes are handled, and every key with its default.
Info stylesThe eight layouts for the system information, what each shows, and what each costs.
ModulesEvery row animfetch can show, what it reads, and the default rows of each info style.
Overrides and custom rowsRename a built-in row, replace its value with text or a command, and add rows of your own.
Live modeKeep uptime, memory, swap and disk current while the fetch is on screen.
Colours and art stylesHow the art is drawn, the gradient and accent colours, and following your desktop theme.

AnimationsChoose a built-in animation, and make your own from a folder of text frames.
BordersDraw PNG ornaments beside and below your system info in kitty, WezTerm and Ghostty.

TroubleshootingFixes for empty icon boxes, missing borders, a config that is ignored, and a terminal left in a strange state.
ContributingBuild animfetch from source, run the tests, and add an animation or a border.