2021-10-22 21:53:29 +02:00
Usage: fastfetch <options>
Informative options:
2022-12-21 04:23:57 -05:00
-h,--help: Show this message
-h,--help <command>: Show help for a specific command
-v,--version: Show the version of fastfetch
2023-01-02 16:51:11 +08:00
--list-config-paths: List search paths of config files
2023-01-08 01:41:09 +01:00
--list-data-paths: List search paths of presets and logos
2022-12-21 04:23:57 -05:00
--list-logos: List available logos
--list-modules: List available modules
--list-presets: List presets fastfetch knows about; they can be loaded with --load-config (+)
--list-features: List the supported features fastfetch was compiled with (mainly for development)
--print-logos: Print available logos
--print-config-system: Print the default system config
--print-config-user: Print the default user config
--print-structure: Print the default structure
2023-01-02 12:43:11 +08:00
--gen-config: Generate a sample config file in the default path
--gen-config-force: Generate a sample config file in the default path. Overwrite the existing one
2021-10-22 21:53:29 +02:00
General options:
2022-12-21 04:10:33 -05:00
--load-config <file>: Load a config file or preset (+)
2022-12-21 04:02:02 -05:00
--multithreading <?value>: Use multiple threads to detect values
2022-12-21 04:23:57 -05:00
--stat <?value>: Show time usage (in ms) for individual modules
2022-12-21 04:02:02 -05:00
--allow-slow-operations <?value>: Allow operations that are usually very slow for more detailed output
--escape-bedrock <?value>: On Bedrock Linux, whether to escape the bedrock jail
--pipe <?value>: Disable logo and all escape sequences
2023-07-10 22:12:07 +08:00
--wmi-timeout <num>: Set the timeout (ms) for WMI queries. Windows only. Default is 5000
--processing-timeout <num>: Set the timeout (ms) when waiting for child processes. Default is 1000
2023-07-31 23:11:39 +08:00
--ds-force-drm <?value>: Set if only DRM should be used to detect displays. Default is false
2021-10-22 21:53:29 +02:00
Logo options:
2022-12-22 21:37:16 +08:00
-l,--logo <logo>: Set the logo; if default, the name of a builtin logo or a path to a file
--logo-type <type>: Set the type of the logo given; must be auto, builtin, file, file-raw, data, data-raw, sixel, kitty, iterm or chafa
--logo-width <width>: Set the width of the logo (in characters), if it is an image. Required for iTerm image protocol
--logo-height <height>: Set the height of the logo (in characters), if it is an image. Required for iTerm image protocol
--logo-preserve-aspect-radio <?value>: Set if the logo should fill the specified width and height as much as possible without stretching. Supported by iTerm image protocol
--logo-color-[1-9] <color>: Overwrite a color in the logo
--logo-padding <padding>: Set the padding on the left and the right of the logo
--logo-padding-left <padding>: Set the padding on the left of the logo
--logo-padding-right <padding>: Set the padding on the right of the logo
2023-01-01 17:24:37 +08:00
--logo-padding-top <padding>: Set the padding on the top of the logo
2022-12-22 21:37:16 +08:00
--logo-print-remaining <?value>: Whether to print the remaining logo, if it has more lines than modules to display
--file <file>: Short for --logo-type file --logo <file>
--file-raw <file>: Short for --logo-type file-raw --logo <file>
--data <data>: Short for --logo-type data --logo <data>
--data-raw <data>: Short for --logo-type data-raw --logo <data>
--sixel <file>: Short for --logo-type sixel --logo <file>
--kitty <file>: Short for --logo-type kitty --logo <file>
--iterm <file>: Short for --logo-type iterm --logo <file>
--chafa <file>: Short for --logo-type chafa --logo <file>
--chafa-fg-only <?value>: Produce character-cell output using foreground colors only. See chafa document for detail
--chafa-symbols <str>: Specify character symbols to employ in final output. See chafa document for detail
--chafa-canvas-mode <value>: Determine how colors are used in the output. This value maps the int value of enum ChafaCanvasMode. See chafa document for detail
--chafa-color-space <value>: Set color space used for quantization. 0 for RGB; 1 for DIN99d. See chafa document for detail
--chafa-dither-mode <value>: Set output dither mode (No effect with 24-bit color). This value maps the int value of enum ChafaDitherMode. See chafa document for detail
2022-04-02 14:35:43 +02:00
Display options:
2022-12-21 04:02:02 -05:00
-s,--structure <structure>: Set the structure of the fetch. Must be a colon separated list of keys. Use "fastfetch --list-modules" to see the ones available.
--color-keys <color>: Set the color of the keys
--color-title <color>: Set the color of the title
2023-08-04 16:05:25 +08:00
--bright-color <?value>: Set if the keys, title and ASCII logo should be printed in bright color. Default is true
2022-12-21 04:02:02 -05:00
-c,--color <color>: Set the color of both the keys and title
--separator <str>: Set the separator between key and value. Default is a colon with a space
--set <key=value>: Hard set the value of a key
--set-keyless <key=value>: Hard set the value of a key, but don't print the key or the separator
--show-errors <?value>: Print occurring errors
--disable-linewrap <?value>: Whether to disable line wrap during the run
--hide-cursor <?value>: Whether to hide the cursor during the run
2023-06-13 11:08:49 +08:00
--binary-prefix <value>: Set the binary prefix to used. Must be IEC, SI or JEDEC. Default is IEC
2023-06-14 16:18:24 +08:00
--percent-type <value>: Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number. Default is 1
2023-06-13 11:08:49 +08:00
--no-buffer <?value>: Set if the stdout application buffer should be disabled. Default is false
2023-07-10 15:25:45 +08:00
--size-ndigits <value>: Set the number of digits to keep after the decimal point when formatting sizes
2023-07-10 17:30:08 +08:00
--size-max-prefix <value>: Set the largest binary prefix to use when formatting sizes. Default is YB
2023-07-27 15:58:49 +08:00
--temperature-unit <value>: Set the unit of the temperature. Must be one of C, F and K. Default is C
2021-10-22 21:53:29 +02:00
2022-06-17 18:15:36 +02:00
General module options:
2023-06-18 12:58:27 +08:00
--<module>-format <format>: Set the format string to use for each specific module.
To see how a format string works, use fastfetch --help format.
To see help about a specific format string, use fastfetch --help <module>-format.
2021-10-22 21:53:29 +02:00
2023-06-18 12:58:27 +08:00
--<module>-key <key>: Set the key to use for each specific module.
For modules which print multiple lines, the string is parsed as a format string with the index as first character.
2022-06-17 18:15:36 +02:00
2023-06-18 12:58:27 +08:00
--<module>-key-color <format>: Override the global `--color-keys` option for each specific module.
2021-10-22 21:53:29 +02:00
2021-10-31 12:12:51 +01:00
Library options: Set the path of a library to load
2021-11-18 18:25:24 +01:00
--lib-PCI <path>
--lib-vulkan <path>
2022-01-05 14:40:57 +01:00
--lib-wayland <path>
--lib-xcb-randr <path>
--lib-xcb <path>
2021-11-18 18:25:24 +01:00
--lib-Xrandr <path>
2022-01-05 14:40:57 +01:00
--lib-X11 <path>
2021-11-18 18:25:24 +01:00
--lib-gio <path>
--lib-DConf <path>
2022-02-13 23:51:13 +01:00
--lib-DBus <path>
2021-11-18 18:25:24 +01:00
--lib-XFConf <path>
2022-05-23 19:30:02 +02:00
--lib-sqlite3 <path>
2022-05-24 13:36:33 +02:00
--lib-rpm <path>
2022-04-14 15:11:14 +02:00
--lib-imagemagick <path>
--lib-z <path>
2022-04-28 19:15:46 +02:00
--lib-chafa <path>
2022-06-04 15:21:34 +02:00
--lib-egl <path>
--lib-glx <path>
2022-06-04 19:30:26 +02:00
--lib-osmesa <path>
2022-06-05 00:18:40 +02:00
--lib-opencl <path>
2023-01-26 15:48:28 +01:00
--lib-pulse <path>
2023-01-26 00:49:43 +08:00
--lib-freetype <path>
2023-07-09 17:22:04 +08:00
--lib-ddcutil <path>
2021-10-22 21:53:29 +02:00
Module specific options:
2023-01-24 12:02:20 +01:00
--title-fqdn <?value>: Set if the title should use fully qualified domain name. Default is false
2023-07-20 11:21:12 +08:00
--title-color-user <color>: Set color of the user name (left part). Default is empty (use color of `--color-title`).
--title-color-at <color>: Set color of the @ symbol (middle part). Default is empty (use color of `--color-title`)
--title-color-host <color>: Set color of the host name (right part). Default is empty (use color of `--color-title`)
2023-01-24 12:02:20 +01:00
--separator-string <str>: Set the string printed by the separator module
--os-file <path>: Set the path to the file containing OS information
--disk-folders <folders>: A colon (semicolon on Windows) separated list of folder paths for the disk output. Default is "/:/home" ("C:\\;D:\\ ..." on Windows)
2023-06-08 21:34:56 +08:00
--disk-show-regular <?value>: Set if regular volume should be printed. Default is true
2023-06-15 00:30:27 +08:00
--disk-show-external <?value>: Set if external volume should be printed. Default is true
2023-01-24 12:02:20 +01:00
--disk-show-hidden <?value>: Set if hidden volumes should be printed. Default is false
--disk-show-subvolumes <?value>: Set if subvolumes should be printed. Default is false
--disk-show-unknown <?value>: Set if unknown (unable to detect sizes) volumes should be printed. Default is false
--bluetooth-show-disconnected: <?value>: Set if disconnected bluetooth devices should be printed. Default is false
2023-03-22 16:19:39 +08:00
--display-compact-type: <?string>: Set if all displays should be printed in one line. Default is none
2023-03-22 16:49:53 +08:00
--display-detect-name: <?value>: Set if display name should be detected and printed (if supported). Default is false
2023-06-17 22:33:41 +08:00
--display-precise-refresh-rate: <?value>:Set if decimal refresh rates should not be rounded into integers when printing. Default is true
2023-01-31 21:12:47 +08:00
--sound-type: <value>: Set what type of sound devices should be printed. Should be either main, active or all. Default is main
2023-01-24 12:02:20 +01:00
--battery-dir <folder>: The directory where the battery folders are. Standard: /sys/class/power_supply/
--cpu-temp <?value>: Detect and display CPU temperature if supported. Default is false
--gpu-temp <?value>: Detect and display GPU temperature if supported. Default is false
2023-03-25 13:24:28 +08:00
--gpu-force-vulkan <?value>: Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations`. Default is false
2023-06-17 22:33:41 +08:00
--gpu-hide-type <?value>: Specify the type of GPUs should not be printed. Must be `integrated`, `discrete` or `none`. Default is none
2023-01-24 12:02:20 +01:00
--battery-temp <?value>: Detect and display Battery temperature if supported. Default is false
--localip-show-ipv4 <?value>: Show IPv4 addresses in local ip module. Default is true
--localip-show-ipv6 <?value>: Show IPv6 addresses in local ip module. Default is false
2023-06-08 21:04:56 +08:00
--localip-show-mac <?value>: Show mac addresses in local ip module. Default is false
2023-01-24 12:02:20 +01:00
--localip-show-loop <?value>: Show loop back addresses (127.0.0.1) in local ip module. Default is false
--localip-name-prefix <str>: Show IPs with given name prefix only. Default is empty
2023-07-17 18:32:13 +08:00
--localip-default-route-only <?value>: Show ips that are used for default routing only. Default is false
2023-06-08 21:04:56 +08:00
--localip-compact <?value>: Show all IPs in one line. Default is false
--publicip-timeout: Time in milliseconds to wait for the public ip server to respond. Default is disabled (0)
--publicip-url: The URL of public IP detection server to be used.
2023-01-24 12:02:20 +01:00
--weather-timeout: Time in milliseconds to wait for the weather server to respond. Default is disabled (0)
--weather-output-format: The output weather format to be used. It must be URI encoded.
--player-name: The name of the player to use
2023-06-17 22:33:41 +08:00
--opengl-library <value>: Set the OpenGL context creation library to use. Must be auto, egl, glx or osmesa. Default is auto
2023-08-01 10:23:36 +08:00
--command-shell <str>: Set the shell program to execute the command text. Default is cmd for Windows, /bin/sh for *nix
2023-06-17 22:33:41 +08:00
--command-key <str>: Set the module key to display
--command-text <str>: Set the command text to be executed
2023-06-18 14:00:24 +08:00
--colors-symbol <str>: Set the symbol to be printed by Colors module. Default is block
2023-06-20 15:13:43 +08:00
--colors-padding-left <value>: Set the number of white spaces to print before the symbol. Default is 0
2021-10-22 21:53:29 +02:00
Parsing is not case sensitive. E.g. "--lib-PCI" is equal to "--Lib-Pci"
If a value starts with a ?, it is optional. "true" will be used if not set.
A (+) at the end indicates that more help can be printed with --help <option>
All options can be made permanent in $XDG_CONFIG_HOME/fastfetch/config.conf