-
Notifications
You must be signed in to change notification settings - Fork 408
Logo options
Option | Default | Description |
---|---|---|
--logo , -l
|
"" |
The logo source, interpreted depending on type |
--logo-type |
auto |
The logo type. See the following categories for possible values |
--<type> |
"" |
Short for --logo-type <type> --logo <value>
|
--logo-padding |
"" |
Sets the padding left and right of the logo |
--logo-padding-left |
0 |
Sets the padding left of the logo |
--logo-padding-right |
4 |
Sets the padding right of the logo |
--logo-padding-top |
0 |
Sets the padding top of the logo |
All filesytem paths can be:
- Absolute
- Relative to the current working directory
- Relative to any of the directories listed by
fastfetch --list-data-paths
+/logos
For example, the file~/.local/share/fastfetch/logos/shrek
can simply be referenced asshrek
.
Note: when using environment variables in config file:
- On Windows, only
%ENV_VAR%
syntax is supported, for example%USERPROFILE%/path/to/logo file.txt
. SeeExpandEnvironmentStringsA
for detail. - On *nix, all special charactors (
|&;<>(){}
) must be quoted with\
, for example~/path/to/logo\ file.txt
or$HOME/path/to/logo\ file.txt
. Seewordexp
for detail.- Command substitution is allowed. For example, it's possible to use
"source": "$(ls ~/path/to/images/*.png | shuf -n 1)"
to randomly choose an image to display
- Command substitution is allowed. For example, it's possible to use
Option | Default | Description |
---|---|---|
--logo-color-[1-9] |
"" |
Overrides a color for logos that support it |
--logo-print-remaining |
true |
Print the remaining logo, if it is higher than the keys |
- Color placeholders are in the form
$[1-9]
. To print a$
, use$$
. - If a color placeholder value is not set, the placeholder is simply discarded.
Option | Default | Description |
---|---|---|
--logo-width |
"" |
Sets the width of the logo for logos that support it |
--logo-height |
"" |
Sets the height of the logo for logos that support it |
- If one of the height / width options is set, but the other not, the aspect ratio is preserved.
- If neither height nor width is set, the original size is used.
Trys to detect the logo type depending on the value of --logo
, in the following order:
- If the value is empty / not set, an autodected builtin logo is displayed.
- If the value is the name of a builtin logo, it is displayed.
- If the value is the path to an image file, and the terminal emulator is known to support an image protocol, the image is displayed.
- If the value is the path to a text file, the content is displayed.
- The autodetected builtin logo is displayed.
The value of --logo
is interpreted as the name of a builtin logo.
- If the value is empty / not set, it is autodetected.
- Use
--list-logos
to get a list of all available logos. - Use
--print-logos
to see all available logos. - All builtin logos set default values for
--logo-color-[1-9]
. - Use
none
to disable the logo, but keep key colors from the detected logo.
Like builtin
, but search for small logos. Assume you are running macOS
- default -> macos
-
-l small
-> macos_small -
--logo-type small
-> macos_small -
-l macos
-> macos -
-l macos --logo-type small
-> macos_small -
-l macos_small
-> macos_small -
-l macos_small --logo-type small
-> error, because Logomacos_small_small
doesn't exist
The value of --logo
is interpreted as the path to a file. The content of the file is displayed.
- If the file can't be read, the autodetected builtin logo is displayed.
The value of --logo
is interpreted as the path to a file. The content of the file is displayed.
- No color placeholder replacement is done.
- If the file can't be read, the autodetected builtin logo is displayed.
The value of --logo
is interpreted as the logo and directly displayed.
- If the value is empty / not set, the autodetected builtin logo is displayed.
The value of --logo
is interpreted as the logo and directly displayed.
- No color placeholder replacement is done.
- If the value is empty / not set, the autodetected builtin logo is displayed.
The value of --logo
is interpreted as the path to an image file. It is displayed using the sixel graphics protocol.
-
fastfetch
must be compiled with theimagemagick6
orimagemagick7
feature. - Has widest terminal support.
See also this issue for rendering transparent backgrounds.
The value of --logo
is interpreted as the path to an image file. It is displayed using the kitty graphics protocol.
-
fastfetch
must be compiled with theimagemagick6
orimagemagick7
feature.
The value of --logo
is interpreted as the path to an image file. It is displayed using the kitty graphics protocol, and the image is directly send to the terminal emulator.
- Both
--logo-width
and--logo-height
must be specified. - This is by far the fastest image protocol because the image content is loaded dirently by terminal but not encoded and passed through tty. We suggest using it if supported by the terminal you use.
- Known to work with wezterm (
png
,jpg
,webp
and maybe more) and kitty (png
only). - Note konsole (up to 23.04) is said to support
kitty
image protocol, it doesn't supportkitty-direct
.
The value of --logo
is interpreted as the path to an image file. It is displayed using the iTerm graphics protocol.
- Both
--logo-width
and--logo-height
must be specified. - Known to work with wezterm (
kitty-direct
is preferred ), iterm2 and konsole.
The value of --logo
is interpreted as the path to an image file. It is converted to an ascii logo using libchafa
.
-
fastfetch
must be compiled with thechafa
feature. -
fastfetch
must be compiled with theimagemagick6
orimagemagick7
feature. - Use
--chafa-fg-only
to set weather to render foreground only. - Use
--chafa-symbols
to set the symbols. - Use
--chafa-canvas-mode
to set the canvas mode. - Use
--chafa-color-space
to set the color space. - Use
--chafa-dither-mode
to set the dither mode. - See the chafa documentation for more information.
The value of --logo
is interpreted as the path to a binary file. It is printed as-is.
- Both
--logo-width
and--logo-height
must be specified. - Use this to display a pre converted image file.
- If the file can't be read, the autodetected builtin logo is displayed.
This is preferred way to display sixel images. For example
$ # make sure libsixel is installed
$ img2sixel /path/to/image > image.sixel # convert an image to sixel format
$ cat image.sixel && echo END # check if it works fine, and get the number of rows and columns the image uses ( before `END` is printed )
$ fastfetch --raw image.sixel --logo-width $NUMBER_OF_COLUMNS_USES --logo-height $NUMBER_OF_ROWS_USES
Some terminal provided imgcat
. It can be used for --raw
too
$ imgcat /path/to/image > image.bin $ convert an image to whatever format that terminal supports
$ cat image.bin && echo END
$ fastfetch --raw image.bin --logo-width $NUMBER_OF_COLUMNS_USES --logo-height $NUMBER_OF_ROWS_USES
- My logo won't display: Try
--pipe false
. Fastfetch detects if its output is piped ( stdout is not a tty ), in this case, all colors and logo will be removed. Seefastfetch -h pipe
- Image collapses command line text: This is a known issue. Try specifying
--logo-width
and--logo-height
, or prefixfastfetch
withclear &&
to clear screen before printing logos ( this matches the behavior of neofetch )