{
"Informative": [
{
"short": "h",
"long": "help",
"desc": "Display this help message or help for a specific command",
"arg": {
"type": "command",
"optional": true
}
},
{
"short": "v",
"long": "version",
"desc": "Show the full version of fastfetch"
},
{
"long": "version-raw",
"desc": "Display the raw version string (major.minor.patch)"
},
{
"long": "list-config-paths",
"desc": "List search paths for config files"
},
{
"long": "list-data-paths",
"desc": "List search paths for presets and logos"
},
{
"long": "list-logos",
"desc": "List available logos"
},
{
"long": "list-modules",
"desc": "List available modules"
},
{
"long": "list-presets",
"desc": "List presets that fastfetch knows about",
"remark": "Presets can be loaded with \"--config <preset-name>\""
},
{
"long": "list-features",
"desc": "List the supported features that fastfetch was compiled with",
"remark": "Mainly for development"
},
{
"long": "print-logos",
"desc": "Display available logos"
},
{
"long": "print-structure",
"desc": "Display the default structure"
},
{
"long": "format",
"desc": "Set output format",
"arg": {
"type": "enum",
"enum": {
"default": "Default format",
"json": "JSON format"
},
"default": "default"
}
}
],
"Config": [
{
"short": "c",
"long": "config",
"desc": "Specify the config file or preset to load",
"remark": "The file will be searched according to the order shown by \"fastfetch --list-config-paths\". Use \"none\" to disable further config loading. See also https://github.com/fastfetch-cli/fastfetch/wiki/Configuration for more info",
"arg": {
"type": "config"
}
},
{
"long": "gen-config",
"desc": "Generate a config file at the specified path with options from the command line (if any)",
"remark": "Defaults to \"~/.config/fastfetch/config.jsonc\". Will print the generated config if <path> is \"-\"",
"arg": {
"type": "path",
"optional": true
}
},
{
"long": "gen-config-force",
"desc": "Generate a config file at the specified path, overwriting any existing file",
"remark": "Defaults to \"~/.config/fastfetch/config.jsonc\"",
"arg": {
"type": "path",
"optional": true
}
}
],
"General": [
{
"long": "thread",
"desc": "Use separate threads for HTTP requests",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "wmi-timeout",
"desc": "Set the timeout (ms) for WMI queries",
"remark": "Windows only",
"arg": {
"type": "num",
"default": 5000
}
},
{
"long": "processing-timeout",
"desc": "Set the timeout (ms) when waiting for child processes",
"arg": {
"type": "num",
"default": 5000
}
},
{
"long": "ds-force-drm",
"desc": "Specify whether only DRM should be used to detect displays",
"remark": [
"Use this option if you encounter problems with other detection methods.",
"Linux only"
],
"arg": {
"type": "enum",
"optional": true,
"default": "false",
"enum": {
"true": "Try `libdrm` first, then `sysfs` if libdrm fails",
"sysfs-only": "Use `/sys/class/drm` only",
"false": "Try `wayland`, then `x11`, then `drm`"
}
}
},
{
"long": "detect-version",
"desc": "Specify whether to detect and display versions of terminal, shell, editor, and others",
"remark": "Mainly for benchmarking",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
}
],
"Logo": [
{
"short": "l",
"long": "logo",
"desc": "Set the logo source. Use \"none\" to disable the logo",
"remark": "Should be the name of a built-in logo or a path to an image file. See also https://github.com/fastfetch-cli/fastfetch/wiki/Logo-options",
"arg": {
"type": "logo"
}
},
{
"long": "logo-type",
"desc": "Set the type of the logo specified in \"--logo\"",
"remark": "See also https://github.com/fastfetch-cli/fastfetch/wiki/Logo-options",
"arg": {
"type": "enum",
"enum": {
"auto": "If something is given, first try built-in, then file. Otherwise detect logo",
"builtin": "Built-in ASCII art",
"small": "Built-in ASCII art, small version",
"file": "Text file, printed with color code replacement",
"file-raw": "Text file, printed as is",
"data": "Text data, printed with color code replacement",
"data-raw": "Text data, printed as is",
"sixel": "Image file, printed as sixel codes",
"kitty": "Image file, printed using kitty graphics protocol",
"kitty-direct": "Image file, tells the terminal emulator to read image data from the specified file",
"kitty-icat": "Image file, uses `kitten icat` to display the image. Requires binary `kitten` to be installed",
"iterm": "Image file, printed using iterm graphics protocol",
"chafa": "Image file, printed as ASCII art using libchafa",
"raw": "Image file, printed as raw binary string",
"none": "Disable logo printing"
}
}
},
{
"long": "logo-width",
"desc": "Set the width of the logo (in characters) if it is an image",
"remark": "Required for iTerm image protocol",
"arg": {
"type": "num"
}
},
{
"long": "logo-height",
"desc": "Set the height of the logo (in characters) if it is an image",
"remark": "Required for iTerm image protocol",
"arg": {
"type": "num"
}
},
{
"long": "logo-preserve-aspect-ratio",
"desc": "Specify whether the logo should fill the specified width and height as much as possible without stretching",
"remark": "Supported by iTerm image protocol only",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "logo-color-[1-9]",
"desc": "Override a color in the logo",
"remark": "See `-h color` for the list of available colors",
"arg": {
"type": "color"
},
"pseudo": true
},
{
"long": "logo-padding",
"desc": "Set the padding on the left and right sides of the logo",
"arg": {
"type": "num"
}
},
{
"long": "logo-padding-left",
"desc": "Set the padding on the left side of the logo",
"arg": {
"type": "num"
}
},
{
"long": "logo-padding-right",
"desc": "Set the padding on the right side of the logo",
"arg": {
"type": "num"
}
},
{
"long": "logo-padding-top",
"desc": "Set the padding at the top of the logo",
"arg": {
"type": "num"
}
},
{
"long": "logo-print-remaining",
"desc": "Specify whether to print the remaining logo if it has more lines than modules to display",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "logo-position",
"desc": "Set the position where the logo should be displayed",
"arg": {
"type": "enum",
"enum": {
"left": "Left",
"top": "Top",
"right": "Right"
}
}
},
{
"long": "logo-recache",
"desc": "If true, regenerate the image logo cache",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "file",
"desc": "Short for --logo-type file --logo <path>",
"remark": "See \"--help logo-type\" for more info",
"arg": {
"type": "path"
}
},
{
"long": "file-raw",
"desc": "Short for --logo-type file-raw --logo <path>",
"remark": "See \"--help logo-type\" for more info",
"arg": {
"type": "path"
}
},
{
"long": "data",
"desc": "Short for --logo-type data --logo <data>",
"remark": "See \"--help logo-type\" for more info",
"arg": {
"type": "data"
}
},
{
"long": "data-raw",
"desc": "Short for --logo-type data-raw --logo <data>",
"remark": "See \"--help logo-type\" for more info",
"arg": {
"type": "data"
}
},
{
"long": "raw",
"desc": "Short for --logo-type raw --logo <path>",
"remark": "See \"--help logo-type\" for more info",
"arg": {
"type": "path"
}
},
{
"long": "sixel",
"desc": "Short for --logo-type sixel --logo <path>",
"remark": "See \"--help logo-type\" for more info",
"arg": {
"type": "path"
}
},
{
"long": "kitty",
"desc": "Short for --logo-type kitty --logo <path>",
"remark": "See \"--help logo-type\" for more info",
"arg": {
"type": "path"
}
},
{
"long": "kitty-direct",
"desc": "Short for --logo-type kitty-direct --logo <path>",
"remark": "See \"--help logo-type\" for more info",
"arg": {
"type": "path"
}
},
{
"long": "kitty-icat",
"desc": "Short for --logo-type kitty-icat --logo <path>",
"remark": "See \"--help logo-type\" for more info",
"arg": {
"type": "path"
}
},
{
"long": "iterm",
"desc": "Short for --logo-type iterm --logo <path>",
"remark": "See \"--help logo-type\" for more info",
"arg": {
"type": "path"
}
},
{
"long": "chafa",
"desc": "Short for --logo-type chafa --logo <path>",
"remark": "See \"--help logo-type\" for more info",
"arg": {
"type": "path"
}
},
{
"long": "chafa-fg-only",
"desc": "Produce character-cell output using foreground colors only",
"remark": "See chafa document for detail",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "chafa-symbols",
"desc": "Specify character symbols to employ in final output",
"remark": "See chafa document for detail",
"arg": {
"type": "str"
}
},
{
"long": "chafa-canvas-mode",
"desc": "Determine how colors are used in the output",
"remark": "This value maps the int value of enum ChafaCanvasMode. See chafa document for detail",
"arg": {
"type": "enum",
"enum": {
"TRUECOLOR": "Truecolor",
"INDEXED_256": "256 colors",
"INDEXED_240": "256 colors, but avoid using the lower 16 whose values vary between terminal environments",
"INDEXED_16": "16 colors using the aixterm ANSI extension",
"FGBG_BGFG": "Default foreground and background colors, plus inversion",
"FGBG": "Default foreground and background colors. No ANSI codes will be used",
"INDEXED_8": "8 colors, compatible with original ANSI X3.64",
"INDEXED_16_8": "16 FG colors (8 of which enabled with bold/bright) and 8 BG colors"
}
}
},
{
"long": "chafa-color-space",
"desc": "Set color space used for quantization",
"remark": "This value maps the int value of enum ChafaColorSpace. See chafa document for detail",
"arg": {
"type": "enum",
"enum": {
"RGB": "RGB color space. Fast but imprecise",
"DIN99D": "DIN99d color space. Slower, but good perceptual color precision"
}
}
},
{
"long": "chafa-dither-mode",
"desc": "Set output dither mode (No effect with 24-bit color)",
"remark": "This value maps the int value of enum ChafaDitherMode. See chafa document for detail",
"arg": {
"type": "enum",
"enum": {
"NONE": "No dithering",
"ORDERED": "Ordered dithering (Bayer or similar)",
"DIFFUSION": "Error diffusion dithering (Floyd-Steinberg or similar)"
}
}
}
],
"Display": [
{
"short": "s",
"long": "structure",
"desc": "Set the structure of the fetch",
"remark": "Must be a colon-separated list of keys. Use \"fastfetch --list-modules\" to see available options",
"arg": {
"type": "structure",
"default": "\"fastfetch --print-structure\""
}
},
{
"long": "stat",
"desc": "Show time usage (in ms) for individual modules",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "pipe",
"desc": "Disable colors",
"remark": "Auto-detected based on isatty(1) by default",
"arg": {
"type": "bool",
"optional": true
}
},
{
"long": "color",
"desc": "Set the color of both keys and title",
"remark": [
"Shortcut for \"--color-keys <color>\" and \"--color-title <color>\"",
"For color syntax, see <https://github.com/fastfetch-cli/fastfetch/wiki/Color-Format-Specification>"
],
"arg": {
"type": "color"
}
},
{
"long": "color-keys",
"desc": "Set the color of the keys",
"remark": "Doesn't affect Title, Separator, and Colors modules. See `-h color` for the list of available colors",
"arg": {
"type": "color"
}
},
{
"long": "color-title",
"desc": "Set the color of the title",
"remark": "See `-h color` for the list of available colors",
"arg": {
"type": "color"
}
},
{
"long": "color-output",
"desc": "Set the color of module output",
"remark": "See `-h color` for the list of available colors",
"arg": {
"type": "color"
}
},
{
"long": "color-separator",
"desc": "Set the color of the key-value separator",
"remark": "See `-h color` for the list of available colors",
"arg": {
"type": "color"
}
},
{
"long": "key-width",
"desc": "Align the width of keys to <num> characters",
"arg": {
"type": "num"
}
},
{
"long": "key-padding-left",
"desc": "Set the left padding of keys to <num> characters",
"arg": {
"type": "num"
}
},
{
"long": "key-type",
"desc": "Specify whether to show an icon before string keys",
"arg": {
"type": "enum",
"enum": {
"none": "Disable keys",
"string": "Show string",
"icon": "Show icon (requires newest nerd font)",
"both": "Show both icon and string"
},
"default": "string"
}
},
{
"long": "bright-color",
"desc": "Specify whether keys, title, and ASCII logo should be printed in bright color",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "separator",
"desc": "Set the separator between key and value",
"arg": {
"type": "str",
"default": ": "
}
},
{
"long": "show-errors",
"desc": "Print errors when they occur",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "disable-linewrap",
"desc": "Specify whether to disable line wrap during execution",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "hide-cursor",
"desc": "Specify whether to hide the cursor during execution",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "percent-type",
"desc": "Set the percentage output type",
"remark": [
"1 for percentage number",
"2 for multi-color bar",
"3 for both",
"6 for bar only",
"9 for colored number",
"10 for monochrome bar"
],
"arg": {
"type": "num",
"default": 9
}
},
{
"long": "percent-ndigits",
"desc": "Set the number of digits to keep after the decimal point when formatting percentage numbers",
"arg": {
"type": "num",
"default": 0
}
},
{
"long": "percent-color-green",
"desc": "Set color used for the green state of percentage bars and numbers",
"remark": "See `-h color` for the list of available colors",
"arg": {
"type": "color",
"default": "green"
}
},
{
"long": "percent-color-yellow",
"desc": "Set color used for the yellow state of percentage bars and numbers",
"remark": "See `-h color` for the list of available colors",
"arg": {
"type": "color",
"default": "light_yellow"
}
},
{
"long": "percent-color-red",
"desc": "Set color used for the red state of percentage bars and numbers",
"remark": "See `-h color` for the list of available colors",
"arg": {
"type": "color",
"default": "light_red"
}
},
{
"long": "bar-char-elapsed",
"desc": "Set the character to use in the elapsed part of percentage bars",
"arg": {
"type": "str",
"default": "\u25a0"
}
},
{
"long": "bar-char-total",
"desc": "Set the character to use in the total part of percentage bars",
"arg": {
"type": "str",
"default": "-"
}
},
{
"long": "bar-border-left",
"desc": "Set the string to use at the left border of percentage bars",
"arg": {
"type": "string",
"default": "[ "
}
},
{
"long": "bar-border-right",
"desc": "Set the string to use at the right border of percentage bars",
"arg": {
"type": "string",
"default": " ]"
}
},
{
"long": "bar-width",
"desc": "Set the width of percentage bars in characters",
"arg": {
"type": "num",
"default": 10
}
},
{
"long": "no-buffer",
"desc": "Specify whether the stdout application buffer should be disabled",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "size-ndigits",
"desc": "Set the number of digits to keep after the decimal point when formatting sizes",
"arg": {
"type": "num"
}
},
{
"long": "size-binary-prefix",
"desc": "Set the binary prefix to use when formatting sizes",
"arg": {
"type": "enum",
"enum": {
"IEC": "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ...",
"SI": "1000 Bytes = 1 kB, 1000 kB = 1 MB, ...",
"JEDEC": "1024 Bytes = 1 KB, 1024 KB = 1 MB, ..."
},
"default": "IEC"
}
},
{
"long": "size-max-prefix",
"desc": "Set the largest binary prefix to use when formatting sizes",
"arg": {
"type": "enum",
"enum": {
"B": "Bytes",
"kB": "KiB",
"MB": "MiB",
"GB": "GiB",
"TB": "TiB",
"PB": "PiB",
"EB": "EiB",
"ZB": "ZiB",
"YB": "YiB"
},
"default": "YB"
}
},
{
"long": "freq-ndigits",
"desc": "Set the number of digits to keep after the decimal point when printing CPU/GPU frequency in GHz",
"arg": {
"type": "num",
"default": 2
}
},
{
"long": "temp-unit",
"desc": "Set the temperature unit",
"arg": {
"type": "enum",
"enum": {
"D": "Default",
"C": "Celsius",
"F": "Fahrenheit",
"K": "Kelvin"
},
"default": "D"
}
},
{
"long": "temp-ndigits",
"desc": "Set the number of digits to keep after the decimal point when printing temperature",
"arg": {
"type": "num",
"default": 2
}
},
{
"long": "temp-color-green",
"desc": "Set color used for the green state of temperature values",
"remark": "See `-h color` for the list of available colors",
"arg": {
"type": "color",
"default": "green"
}
},
{
"long": "temp-color-yellow",
"desc": "Set color used for the yellow state of temperature values",
"remark": "See `-h color` for the list of available colors",
"arg": {
"type": "color",
"default": "light_yellow"
}
},
{
"long": "temp-color-red",
"desc": "Set color used for the red state of temperature values",
"remark": "See `-h color` for the list of available colors",
"arg": {
"type": "color",
"default": "light_red"
}
}
],
"Module specific": [
{
"long": "title-fqdn",
"desc": "Specify whether the title should use fully qualified domain name",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "title-color-user",
"desc": "Set the color of the user name (left part)",
"remark": "See `-h color` for the list of available colors",
"arg": {
"type": "color",
"default": "Use color of \"--color-title\""
}
},
{
"long": "title-color-at",
"desc": "Set the color of the @ symbol (middle part)",
"remark": "See `-h color` for the list of available colors",
"arg": {
"type": "color",
"default": "Use color of \"--color-title\""
}
},
{
"long": "title-color-host",
"desc": "Set the color of the host name (right part)",
"remark": "See `-h color` for the list of available colors",
"arg": {
"type": "color",
"default": "default"
}
},
{
"long": "separator-string",
"desc": "Set the string to be printed by the separator line",
"arg": {
"type": "str",
"default": "-"
}
},
{
"long": "separator-output-color",
"desc": "Set the color of the separator line",
"arg": {
"type": "color",
"default": "default"
}
},
{
"long": "separator-length",
"desc": "Set the length of the separator line",
"remark": "Set to 0 to automatically calculate it based on the title length",
"arg": {
"type": "num",
"default": "0"
}
},
{
"long": "disk-folders",
"desc": "A colon (semicolon on Windows) separated list of folder paths to detect",
"remark": "On Windows, a drive letter must be upper-cased and end with \"\\\". \"/\" is used as an alias of the system drive. This option overrides other disk-show-* options",
"arg": {
"type": "path",
"default": "Auto detection using mount-points"
}
},
{
"long": "disk-show-regular",
"desc": "Specify whether regular volumes should be displayed",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "disk-show-external",
"desc": "Specify whether external volumes should be displayed",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "disk-show-hidden",
"desc": "Specify whether hidden volumes should be displayed",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "disk-show-subvolumes",
"desc": "Specify whether subvolumes should be displayed",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "disk-show-readonly",
"desc": "Specify whether read-only volumes should be displayed",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "disk-show-unknown",
"desc": "Specify whether unknown volumes (unable to detect sizes) should be displayed",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "disk-use-available",
"desc": "Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes",
"remark": "May be required for macOS to display correct results",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "diskio-detect-total",
"desc": "Detect total bytes instead of current rate",
"arg": {
"type": "bool",
"default": false
}
},
{
"long": "diskio-name-prefix",
"desc": "Show only disks with the given name prefix",
"arg": {
"type": "str"
}
},
{
"long": "diskio-wait-time",
"desc": "Set the wait time (in ms) when detecting disk usage",
"arg": {
"type": "num",
"default": 1000
}
},
{
"long": "physicaldisk-name-prefix",
"desc": "Show only disks with the given name prefix",
"arg": {
"type": "str"
}
},
{
"long": "physicaldisk-temp",
"desc": "Detect and display SSD temperature if supported",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "bluetooth-show-disconnected",
"desc": "Specify whether disconnected Bluetooth devices should be displayed",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "packages-disabled",
"desc": "A colon-separated list of package managers to disable when detecting",
"remark": [
"Some detection methods can be very slow.",
"You may need to increase the value of '--processing-timeout' to make it work properly.",
"Use `--packages-disabled none` to enable all."
],
"arg": {
"type": "string",
"default": "winget"
}
},
{
"long": "display-compact-type",
"desc": "Specify whether all displays should be printed in one line",
"arg": {
"type": "enum",
"enum": {
"none": "Disable this compact mode",
"original": "Print original resolutions",
"scaled": "Print scaled resolutions",
"original-with-refresh-rate": "Print original resolutions with refresh rate",
"scaled-with-refresh-rate": "Print scaled resolutions with refresh rate"
},
"default": "none"
}
},
{
"long": "display-precise-refresh-rate",
"desc": "Specify whether decimal refresh rates should not be rounded to integers when printing",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "display-order",
"desc": "Set the order to use when printing displays",
"arg": {
"type": "enum",
"enum": {
"none": "Use the detected order",
"asc": "Sort by display name in ascending order",
"desc": "Sort by display name in descending order"
},
"default": "none"
}
},
{
"long": "brightness-ddcci-sleep",
"desc": "Set the sleep time (in ms) when sending DDC/CI requests",
"remark": "See <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for details",
"arg": {
"type": "num",
"default": 10
}
},
{
"long": "brightness-compact",
"desc": "Specify whether multiple results should be printed in one line",
"arg": {
"type": "bool",
"default": false
}
},
{
"long": "sound-type",
"desc": "Set which types of sound devices should be displayed",
"arg": {
"type": "enum",
"enum": {
"main": "Print only main sound devices",
"active": "Print only active sound devices",
"all": "Print all sound devices"
},
"default": "main"
}
},
{
"long": "battery-use-setup-api",
"desc": "Specify whether \"SetupAPI\" should be used on Windows to detect battery info",
"remark": [
"SetupAPI supports multiple batteries, but is slower.",
"Windows only"
],
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "cpu-temp",
"desc": "Detect and display CPU temperature if supported",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "cpu-show-pe-core-count",
"desc": "Detect and display CPU frequency of different core types (e.g., P-cores and E-cores) if supported",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "cpucache-compact",
"desc": "Show all CPU caches in one line",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "cpuusage-separate",
"desc": "Display CPU usage per logical core, instead of an average result",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "cpuusage-wait-time",
"desc": "Set the wait time (in ms) when detecting CPU usage",
"arg": {
"type": "num",
"default": 200
}
},
{
"long": "de-slow-version-detection",
"desc": "Specify whether DE version should be detected with slower operations",
"remark": [
"This is only used as a fallback method. Please file a bug report if you encounter any issues.",
"Linux only"
],
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "gpu-temp",
"desc": "Detect and display GPU temperature if supported",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "gpu-driver-specific",
"desc": "Use driver-specific methods to detect more detailed GPU information (memory usage, core count, etc.)",
"remark": "Requires the latest GPU drivers to be installed.",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "gpu-detection-method",
"desc": "Force using a specified method to detect GPUs",
"remark": "Will fall back to other methods if the specified method fails",
"arg": {
"type": "enum",
"enum": {
"auto": "Query platform-specific graphics APIs. Requires proper GPU drivers to be installed. Not supported on BSDs",
"pci": "Search PCI devices, which does not require GPU drivers to be installed. Not supported on Windows and macOS",
"vulkan": "Use Vulkan API. Slow and requires proper Vulkan drivers to be installed. Used for Android",
"opencl": "Use OpenCL API. Slow and requires proper OpenCL drivers to be installed",
"opengl": "Use OpenGL API. Slow and only detects one GPU"
},
"default": "auto"
}
},
{
"long": "gpu-hide-type",
"desc": "Specify which types of GPUs should not be displayed (default: all GPUs are shown, regardless of recognition)",
"arg": {
"type": "enum",
"enum": {
"integrated": "Hide integrated GPUs",
"discrete": "Hide discrete GPUs",
"unknown": "Hide unknown (unrecognized) GPUs",
"none": "Do not hide any GPUs"
},
"default": "none"
}
},
{
"long": "battery-temp",
"desc": "Detect and display battery temperature if supported",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "loadavg-ndigits",
"desc": "Set the number of digits to keep after the decimal point when printing load average",
"arg": {
"type": "num",
"default": 2
}
},
{
"long": "loadavg-compact",
"desc": "Show load average values in one line",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "localip-show-ipv4",
"desc": "Show IPv4 addresses in the local IP module",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "localip-show-ipv6",
"desc": "Show IPv6 addresses in the local IP module",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "localip-show-mac",
"desc": "Show MAC addresses in the local IP module",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "localip-show-loop",
"desc": "Show loopback addresses (127.0.0.1) in the local IP module",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "localip-show-mtu",
"desc": "Show network interface MTU (Maximum Transmission Unit) size in bytes",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "localip-show-speed",
"desc": "Show network interface link speed in human-readable format (or as a 1Mb units integer in JSON format)",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "localip-show-prefix-len",
"desc": "Show network prefix length (/N) in the local IP module",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "localip-name-prefix",
"desc": "Show only interfaces with the given interface name prefix",
"arg": {
"type": "str"
}
},
{
"long": "localip-default-route-only",
"desc": "Show only the interface that is used for default routing",
"remark": "Doesn't work on Android",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "localip-show-all-ips",
"desc": "Show all IPs bound to the same interface. By default, only the first IP is shown",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "localip-show-flags",
"desc": "Show network interface flags in the local IP module",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "localip-compact",
"desc": "Show all IPs in one line",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "dns-show-type",
"desc": "Specify which types of DNS servers should be detected",
"arg": {
"type": "enum",
"enum": {
"ipv4": "Show IPv4 addresses only",
"ipv6": "Show IPv6 addresses only",
"both": "Show both IPv4 and IPv6 addresses"
},
"default": "both"
}
},
{
"long": "netio-name-prefix",
"desc": "Show only interfaces with the given name prefix",
"arg": {
"type": "str"
}
},
{
"long": "netio-default-route-only",
"desc": "Show only the interface that is used for default routing",
"remark": "Doesn't work on Android",
"arg": {
"type": "bool",
"optional": true,
"default": true
}
},
{
"long": "netio-detect-total",
"desc": "Detect total bytes instead of current rate",
"arg": {
"type": "bool",
"default": false
}
},
{
"long": "netio-wait-time",
"desc": "Set the wait time (in ms) when detecting network usage",
"arg": {
"type": "num",
"default": 1000
}
},
{
"long": "publicip-timeout",
"desc": "Time in milliseconds to wait for the public IP server to respond",
"remark": "0 to disable timeout",
"arg": {
"type": "num",
"default": 0
}
},
{
"long": "publicip-url",
"desc": "The URL of the public IP detection server to use",
"arg": {
"type": "str"
}
},
{
"long": "publicip-ipv6",
"desc": "Specify whether to use IPv6 for the public IP detection server",
"arg": {
"type": "bool",
"default": false
}
},
{
"long": "weather-location",
"desc": "Set the location to use",
"remark": "Must be URI encoded (e.g., a whitespace must be encoded as \"+\")",
"arg": {
"type": "str"
}
},
{
"long": "weather-timeout",
"desc": "Time in milliseconds to wait for the weather server to respond",
"remark": "0 to disable timeout",
"arg": {
"type": "num",
"default": 0
}
},
{
"long": "weather-output-format",
"desc": "The output weather format to use",
"remark": "Must be URI encoded",
"arg": {
"type": "str"
}
},
{
"long": "wm-detect-plugin",
"desc": "Specify whether window manager plugins should be detected on supported platforms",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "users-compact",
"desc": "Show all active users in one line",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "users-myself-only",
"desc": "Show only the current user",
"arg": {
"type": "bool",
"optional": true,
"default": false
}
},
{
"long": "player-name",
"desc": "The name of the player to use for the Media and Player modules",
"remark": "Linux only",
"arg": {
"type": "str"
}
},
{
"long": "opengl-library",
"desc": "Set the OpenGL context creation library to use",
"arg": {
"type": "enum",
"enum": {
"auto": "Prefer EGL on *nix; prefer platform-specific implementation on others",
"egl": "EGL",
"glx": "GLX (*nix only)"
},
"default": "auto"
}
},
{
"long": "command-shell",
"desc": "Set the shell program to execute the command text",
"arg": {
"type": "str",
"default": "\"cmd\" for Windows; \"/bin/sh\" for *nix"
}
},
{
"long": "command-param",
"desc": "Set the parameter to use when starting the shell",
"remark": "If set to an empty string, it will be ignored",
"arg": {
"type": "str",
"default": "\"/c\" for Windows; \"-c\" for *nix"
}
},
{
"long": "command-key",
"desc": "Set the module key to display",
"arg": {
"type": "str"
}
},
{
"long": "command-text",
"desc": "Set the command text to execute",
"arg": {
"type": "str"
}
},
{
"long": "colors-symbol",
"desc": "Set the symbol to be printed by the Colors module",
"arg": {
"type": "enum",
"enum": {
"block": "\u2588\u2588\u2588",
"background": "(whitespaces with background)",
"circle": "\u25cf",
"diamond": "\u25c6",
"triangle": "\u25b2",
"square": "\u25a0",
"star": "\u2605"
},
"default": "background"
}
},
{
"long": "colors-padding-left",
"desc": "Set the number of white spaces to print before the symbol",
"arg": {
"type": "num",
"default": 0
}
},
{
"long": "colors-block-width",
"desc": "Set the block width in spaces",
"arg": {
"type": "num",
"default": 3
}
},
{
"long": "colors-block-range-start",
"desc": "Set the start range of colors in the blocks to print",
"remark": [
"Display colors 0-15 in the blocks. (16 colors)",
"Display colors 0-7 in the blocks. (8 colors)",
"Only works for `--colors-symbol block`.",
"Must be in range 0-15",
"See also `--colors-range-end`"
],
"arg": {
"type": "num",
"default": 0
}
},
{
"long": "colors-block-range-end",
"desc": "Set the end range of colors in the blocks to print",
"remark": [
"Display colors 0-15 in the blocks. (16 colors)",
"Display colors 0-7 in the blocks. (8 colors)",
"Only works for `--colors-symbol block`.",
"Must be in range 0-15",
"See also `--colors-range-start`"
],
"arg": {
"type": "num",
"default": 15
}
}
],
"General module": [
{
"long": "<module>-format",
"desc": [
"Set the format string to use for a specific module",
"See <https://github.com/fastfetch-cli/fastfetch/wiki/Format-String-Guide>",
"For help about a specific format string, use \"fastfetch -h <module>-format\""
],
"arg": {
"type": "format"
},
"pseudo": true
},
{
"long": "<module>-key",
"desc": [
"Set the key to use for a specific module.",
"For modules that print multiple lines, the string is parsed",
"as a format string with the index as the first character"
],
"arg": {
"type": "key"
},
"pseudo": true
},
{
"long": "<module>-key-color",
"desc": "Override the global \"--color-keys\" option for a specific module",
"arg": {
"type": "color"
},
"pseudo": true
},
{
"long": "<module>-key-icon",
"desc": "Set the icon to be displayed by \"--key-type icon\"",
"arg": {
"type": "string"
},
"pseudo": true
},
{
"long": "<module>-output-color",
"desc": "Override the global \"--color-output\" option for a specific module",
"arg": {
"type": "color"
},
"pseudo": true
},
{
"long": "<module>-key-width",
"desc": "Override the global \"--key-width\" option for a specific module",
"arg": {
"type": "num"
},
"pseudo": true
},
{
"long": "<module>-percent-green",
"desc": [
"Threshold for percentage color ranges",
"Values less than percent-green will be shown in green"
],
"arg": {
"type": "num"
},
"pseudo": true
},
{
"long": "<module>-percent-yellow",
"desc": [
"Threshold for percentage color ranges",
"Values greater than percent-green and less than percent-yellow will be shown in yellow",
"Values greater than percent-yellow will be shown in red"
],
"arg": {
"type": "num"
},
"pseudo": true
},
{
"long": "<module>-percent-type",
"desc": "Set the percentage output type",
"remark": [
"0 to use global `--percent-type` value",
"1 for percentage number",
"2 for multi-color bar",
"3 for both",
"6 for bar only",
"9 for colored number",
"10 for monochrome bar"
],
"arg": {
"type": "num",
"default": 0
},
"pseudo": true
},
{
"long": "<module>-temp-green",
"desc": [
"Threshold for temperature color ranges",
"Values less than temp-green will be shown in green"
],
"arg": {
"type": "num"
},
"pseudo": true
},
{
"long": "<module>-temp-yellow",
"desc": [
"Threshold for temperature color ranges",
"Values greater than temp-green and less than temp-yellow will be shown in yellow",
"Values greater than temp-yellow will be shown in red"
],
"arg": {
"type": "num"
},
"pseudo": true
}
]
}