Quick start

Run it#

animfetch --pin

The fetch appears at the top of the terminal and keeps animating while your shell runs below. Open a new terminal to see the default animation; undo with animfetch --unpin.

Choose an animation#

animfetch --list             # what is available (* marks the current one)
animfetch -a fox-run         # this run only
animfetch --set fox-run      # make it the default

--set writes animation = "fox-run" to your config.toml, creating it if needed. Preview every animation.

Choose a layout#

The information beside the art has eight styles:

animfetch --pin --info boxed

Try them all with --once, which prints a frame and exits:

for s in classic boxed tree sections chips iconic card minimal; do
  animfetch --once --info $s
done

See Info styles for what each looks like. Add --save to any run to keep the settings you gave it:

animfetch --pin --info card --style quad --save

Start it with your shell#

Put this in ~/.bashrc or ~/.zshrc:

[[ $- == *i* ]] && command -v animfetch >/dev/null && animfetch --pin

and for fish, in ~/.config/fish/config.fish:

status is-interactive; and type -q animfetch; and animfetch --pin

The guards keep it out of scripts and scp, which break on unexpected output.

Never put bare animfetch in a startup file. The default mode owns the prompt and waits for input, which is not what a new shell should do. Use --pin, --play or --once.

Configure it#

Everything above can live in ~/.config/animfetch/config.toml. Every key is optional:

animation  = "fox-run"
info_style = "boxed"
style      = "quad"
live       = true

Copy the fully commented config.example.toml as a starting point, or read the configuration reference.