CLI reference

Every animfetch flag, grouped by what it does, with the config key each one overrides.

animfetch [OPTIONS]

Flags last for one run unless you add --save. The matching config key, where there is one, is in the last column.

Modes#

Flag	Meaning
`--pin`	Pin the fetch above your own shell and keep animating in the background. Undo with `--unpin`.
`--unpin`	Undo `--pin`.
`-p`, `--play`	Animate in place for a few seconds, then exit.
`-1`, `--once`	Print one static frame and exit.
(none)	Interactive: the fetch pinned above, animfetch's own prompt below.

Animations#

Flag	Meaning
`-a`, `--animation <NAME>`	Use `NAME` for this run only.
`-l`, `--list`	List available animations (`*` marks the current one).
`--set <NAME>`	Make `NAME` the default, saved to `config.toml`.

Options#

Flag	Meaning	Config key
`-f`, `--fps <N>`	Frames per second.	`fps`
`--style <STYLE>`	How the art is drawn: `half` (default), `quad`, `ramp` or `raw`.	`style`
`--art-color <SRC>`	Where raw art's colour comes from: `own` (default) or `theme`.	`art_color`
`--info <STYLE>`	The info pane: `classic`, `boxed`, `tree`, `sections`, `chips`, `iconic`, `card` or `minimal`.	`info_style`
`-W`, `--width <COLS>`	Cap the art width (0 fills the screen).	`width`
`-H`, `--height <ROWS>`	Cap the art height (0 fills the screen).	`height`
`-s`, `--seconds <N>`	How long `--play` animates.	`play_seconds`
`--palette`	Take colours from your desktop's generated palette.	`color_source`
`--live`	Keep uptime, memory, swap and disk current.	`live`
`--no-art`	Draw no animation: the info is the whole pane.	`art`
`--no-color`	Draw everything in shades of grey, no colour at all.	`gray`
`--def-color`	The default colours, from your theme: undoes `--no-color`.	`color`, `gray`

Borders#

Flag	Meaning	Config key
`--border-left <B>`, `--lb <B>`	An ornament down the left of the data: a built-in name, one of your own, or a PNG path.	`border_left`
`--border-bottom <B>`, `--db <B>`	An ornament along the bottom (down); the image is upright and turned a quarter clockwise.	`border_bottom`
`--border-render <M>`	`auto` (pictures where the terminal can show them), `image` (force pictures) or `cells` (braille text).	`border_render`
`--border-bottom-lift <N>`	Raise the bottom ornament by `N` rows (may be a fraction).	`border_bottom_lift`
`--border-bottom-shift <N>`	Move the bottom ornament `N` columns right (may be a fraction).	`border_bottom_shift`
`--no-border`	Draw no border, whatever the config says. With `--save` the config is left with none: both border names are written empty.	`border_left`, `border_bottom`
`--list-borders`	List the available border images, and say whether this terminal shows pictures.

See Borders for what these do.

`--save`#

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

--save keeps the settings given on that run, writing them to config.toml for every run after. The file is edited as text, so your comments and every key you left at its default survive.

It says what it saved and leaves a terminal that is already pinned as it is, so the change shows in terminals you open next, not in this one.

On its own, --save only saves: animfetch --no-color --save prints what it wrote and returns to your prompt, without starting a session. Name a mode (--pin, --play or --once) and it saves and then runs it.

Other#

Flag	Meaning
`-h`, `--help`	Show the help.
`-V`, `--version`	Show the version.

Files#

Path	What it is
`~/.config/animfetch/config.toml`	Your settings.
`~/.config/animfetch/anim/<name>/*.txt`	Your own animations.
`~/.config/animfetch/border/`	Your own border images, for either edge.

Environment#

Variable	Effect
`NO_COLOR`	Turns colour off: no colour codes are sent.
`XDG_CONFIG_HOME`	Moves the config directory from `~/.config`.