2023-11-20 16:37:59 +08:00
{
"Informative" : [
{
"short" : "h" ,
"long" : "help" ,
"desc" : "Show this 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" : "Show the raw version string (major.minor.patch)"
},
{
"long" : "list-config-paths" ,
"desc" : "List search paths of config files"
},
{
"long" : "list-data-paths" ,
"desc" : "List search paths of presets and logos"
},
{
"long" : "list-logos" ,
"desc" : "List available logos"
},
{
"long" : "list-modules" ,
"desc" : "List available modules"
},
{
"long" : "list-presets" ,
"desc" : "List presets fastfetch knows about" ,
"remark" : "Presets can be loaded with \"--config <preset-name>\""
},
{
"long" : "list-features" ,
"desc" : "List the supported features fastfetch was compiled with" ,
"remark" : "Mainly for development"
},
{
"long" : "print-logos" ,
"desc" : "Print available logos"
},
{
"long" : "print-structure" ,
"desc" : "Print the default structure"
}
],
"Config" : [
{
"short" : "c" ,
"long" : "config" ,
"desc" : "Specify the config file or preset to be loaded" ,
2023-11-22 09:32:38 +08:00
"remark" : "The file will be searched in the order of \"fastfetch --list-config-paths\". If \"none\", disable further config loading. See also https://github.com/fastfetch-cli/fastfetch/wiki/Configuration for more info" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "config"
}
},
{
"long" : "gen-config" ,
"desc" : "Generate a config file to specified path with options specified in 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 to specified path. Overwrite the existing one" ,
"remark" : "Defaults to \"~/.config/fastfetch/config.jsonc\"" ,
"arg" : {
"type" : "path" ,
"optional" : true
}
}
],
2023-12-22 10:14:51 +08:00
"General" : [
2023-11-20 16:37:59 +08:00
{
"long" : "thread" ,
"desc" : "Use separate threads to send HTTP requests" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
"long" : "escape-bedrock" ,
"desc" : "On Bedrock Linux, whether to escape the bedrock jail" ,
"remark" : "Linux only" ,
"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" : 1000
}
},
{
"long" : "ds-force-drm" ,
"desc" : "Set if only DRM should be used to detect displays" ,
2024-02-14 22:07:08 +08:00
"remark" : [
"Use this option if you encountered problems with other detection method." ,
"Linux only"
],
2023-11-20 16:37:59 +08:00
"arg" : {
2023-12-11 13:25:58 +08:00
"type" : "enum" ,
2023-11-20 16:37:59 +08:00
"optional" : true ,
2023-12-11 13:25:58 +08:00
"default" : "false" ,
"enum" : {
"true" : "Try `libdrm` first, then `sysfs` if libdrm failed" ,
"sysfs-only" : "Use `/sys/class/drm` only" ,
2023-12-14 15:49:43 +08:00
"false" : "Try `wayland`, then `x11`, then `drm`"
2023-12-11 13:25:58 +08:00
}
2023-11-20 16:37:59 +08:00
}
}
],
"Logo" : [
{
"short" : "l" ,
"long" : "logo" ,
"desc" : "Set the logo source" ,
2023-11-22 09:32:38 +08:00
"remark" : "Should be the name of a builtin logo, or a path to an image file. See also https://github.com/fastfetch-cli/fastfetch/wiki/Logo-options" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "logo"
}
},
{
"long" : "logo-type" ,
"desc" : "Set the type of the logo given in \"--logo\"" ,
2023-11-22 09:32:38 +08:00
"remark" : "See also https://github.com/fastfetch-cli/fastfetch/wiki/Logo-options" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "enum" ,
"enum" : {
"auto" : "If something is given, first try builtin, then file. Otherwise detect logo" ,
"builtin" : "Builtin ascii art" ,
"small" : "Builtin 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 as kitty graphics protocol" ,
"kitty_direct" : "Image file, tell the terminal emulator to read image data from the specified file (Supported by kitty and wezterm)" ,
"iterm" : "Image file, printed as 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" : "Set if 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
}
},
{
2023-11-22 15:36:48 +08:00
"long" : "logo-color-[1-9]" ,
2023-11-20 16:37:59 +08:00
"desc" : "Overwrite a color in the logo" ,
2024-01-20 19:59:13 +08:00
"remark" : "See `-h color` for the list of available colors" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "color"
2023-11-22 15:36:48 +08:00
},
"pseudo" : true
2023-11-20 16:37:59 +08:00
},
{
"long" : "logo-padding" ,
"desc" : "Set the padding on the left and the right of the logo" ,
"arg" : {
"type" : "num"
}
},
{
"long" : "logo-padding-left" ,
"desc" : "Set the padding on the left of the logo" ,
"arg" : {
"type" : "num"
}
},
{
"long" : "logo-padding-right" ,
"desc" : "Set the padding on the right of the logo" ,
"arg" : {
"type" : "num"
}
},
{
"long" : "logo-padding-top" ,
"desc" : "Set the padding on the top of the logo" ,
"arg" : {
"type" : "num"
}
},
{
"long" : "logo-print-remaining" ,
"desc" : "Whether to print the remaining logo, if it has more lines than modules to display" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
"long" : "logo-separate" ,
"desc" : "If true, print modules at bottom of the logo" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "logo-recache" ,
"desc" : "If true, regenerate 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" : "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 the ones available" ,
"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 logo and all escape sequences" ,
2023-11-22 15:36:48 +08:00
"remark" : "Auto detection based on isatty(1)" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
2023-11-22 15:36:48 +08:00
"optional" : true
2023-11-20 16:37:59 +08:00
}
},
{
"long" : "color-keys" ,
"desc" : "Set the color of the keys" ,
2024-01-20 19:59:13 +08:00
"remark" : "See `-h color` for the list of available colors" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "color"
}
},
{
"long" : "color-title" ,
"desc" : "Set the color of the title" ,
2024-01-20 19:59:13 +08:00
"remark" : "See `-h color` for the list of available colors" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "color"
}
},
{
"long" : "color" ,
"desc" : "Set the color of both the keys and title" ,
"remark" : "Shortcut of \"--color-keys <color>\" and \"--color-title <color>\"" ,
"arg" : {
"type" : "color"
}
},
{
"long" : "key-width" ,
"desc" : "Align the width of keys to <num> characters" ,
"arg" : {
"type" : "num"
}
},
{
"long" : "bright-color" ,
"desc" : "Set if the 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" : "set" ,
"desc" : "Hard set the value of a key" ,
2023-11-21 21:39:10 +08:00
"remark" : "Deprecated. Use \"Custom\" module instead" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "key=value"
}
},
{
"long" : "set-keyless" ,
"desc" : "Hard set the value of a key, but don't print the key or the separator" ,
2023-11-21 21:39:10 +08:00
"remark" : "Deprecated. Use \"Custom\" module instead" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "key=value"
}
},
{
"long" : "show-errors" ,
"desc" : "Print occurring errors" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "disable-linewrap" ,
"desc" : "Whether to disable line wrap during the run" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
"long" : "hide-cursor" ,
"desc" : "Whether to hide the cursor during the run" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
"long" : "binary-prefix" ,
"desc" : "Set the binary prefix to used" ,
"arg" : {
"type" : "enum" ,
"enum" : {
"IEC" : "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ..." ,
"SI" : "1000 Bytes = 1 KB, 1000 KB = 1 MB, ..." ,
2023-11-21 21:39:10 +08:00
"JEDEC" : "1024 Bytes = 1 kB, 1024 kB = 1 MB, ..."
2023-11-20 16:37:59 +08:00
},
"default" : "IEC"
}
},
{
"long" : "percent-type" ,
"desc" : "Set the percentage output type" ,
2024-02-14 22:07:08 +08:00
"remark" : [
"1 for percentage number" ,
"2 for bar" ,
"3 for both" ,
"6 for bar only" ,
"9 for colored number"
],
2023-11-20 16:37:59 +08:00
"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
}
},
2024-01-20 19:59:13 +08:00
{
"long" : "percent-color-green" ,
"desc" : "Set color used in 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 in 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 in red state of percentage bars and numbers" ,
"remark" : "See `-h color` for the list of available colors" ,
"arg" : {
"type" : "color" ,
"default" : "light_red"
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "bar-char-elapsed" ,
2023-12-06 10:29:17 +08:00
"desc" : "Set the character to use in elapsed part of percentage bars" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "str" ,
2023-12-06 23:55:34 +08:00
"default" : "\u25a0"
2023-11-20 16:37:59 +08:00
}
},
{
"long" : "bar-char-total" ,
2023-12-06 10:29:17 +08:00
"desc" : "Set the character to use in total part of percentage bars" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "str" ,
"default" : "-"
}
},
{
"long" : "bar-width" ,
2023-12-06 10:29:17 +08:00
"desc" : "Set the width of percentage bars, in number of characters" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "num" ,
"default" : 10
}
},
{
"long" : "bar-border" ,
2023-12-06 10:29:17 +08:00
"desc" : "Whether to show a border around percentage bars" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
"long" : "no-buffer" ,
"desc" : "Set if 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-max-prefix" ,
"desc" : "Set the largest binary prefix to use when formatting sizes" ,
"arg" : {
2023-11-21 16:39:38 +08:00
"type" : "enum" ,
2023-11-20 16:37:59 +08:00
"enum" : {
"B" : "Bytes" ,
"kB" : "KiB" ,
"MB" : "MiB" ,
"GB" : "GiB" ,
"TB" : "TiB" ,
"PB" : "PiB" ,
"EB" : "EiB" ,
"ZB" : "ZiB" ,
"YB" : "YiB"
},
"default" : "YB"
}
},
{
2024-02-27 13:11:39 +08:00
"long" : "temp-unit" ,
2023-11-20 16:37:59 +08:00
"desc" : "Set the unit of the temperature" ,
"arg" : {
2023-11-21 16:39:38 +08:00
"type" : "enum" ,
2023-11-20 16:37:59 +08:00
"enum" : {
"C" : "Celsius" ,
"F" : "Fahrenheit" ,
"K" : "Kelvin"
},
"default" : "C"
}
2024-02-26 10:46:13 +08:00
},
{
2024-02-27 13:11:39 +08:00
"long" : "temp-ndigits" ,
2024-02-26 10:46:13 +08:00
"desc" : "Set the number of digits to keep after the decimal point when printing temperature" ,
"arg" : {
"type" : "num" ,
"default" : 2
}
},
{
2024-02-27 13:11:39 +08:00
"long" : "temp-color-green" ,
2024-02-26 10:46:13 +08:00
"desc" : "Set color used in green state of temperature values" ,
"remark" : "See `-h color` for the list of available colors" ,
"arg" : {
"type" : "color" ,
"default" : "green"
}
},
{
2024-02-27 13:11:39 +08:00
"long" : "temp-color-yellow" ,
2024-02-26 10:46:13 +08:00
"desc" : "Set color used in yellow state of temperature values" ,
"remark" : "See `-h color` for the list of available colors" ,
"arg" : {
"type" : "color" ,
"default" : "light_yellow"
}
},
{
2024-02-27 13:11:39 +08:00
"long" : "temp-color-red" ,
2024-02-26 10:46:13 +08:00
"desc" : "Set color used in red state of temperature values" ,
"remark" : "See `-h color` for the list of available colors" ,
"arg" : {
"type" : "color" ,
"default" : "light_red"
}
2024-04-18 22:53:31 +08:00
},
{
"long" : "ts-version" ,
"desc" : "Whether to detect and display the version of terminal and shell" ,
"remark" : "Mainly for benchmarking" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
2023-11-20 16:37:59 +08:00
}
],
"Library path" : [
{
"long" : "lib-pci" ,
"desc" : "Pciutils. Used for GPU output" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-vulkan" ,
"desc" : "Vulkan module & fallback for GPU output" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-wayland" ,
"desc" : "Better display performance and output in wayland sessions" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-xcb-randr" ,
"desc" : "X11 sessions for better display detection and faster WM detection" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-xcb" ,
"desc" : "X11 sessions for better display detection and faster WM detection" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-xrandr" ,
"desc" : "X11 sessions for better display detection and faster WM detection" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-x11" ,
"desc" : "X11 sessions for better display detection and faster WM detection" ,
"arg" : {
"type" : "path"
}
},
2023-11-29 14:55:40 +08:00
{
"long" : "lib-drm" ,
"desc" : "Used for fast resolution and refresh rate detection" ,
"remark" : "Linux only" ,
"arg" : {
"type" : "path"
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "lib-gio" ,
"desc" : "Needed for values that are only stored GSettings" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-dconf" ,
"desc" : "Needed for values that are only stored in DConf + Fallback for GSettings" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-dbus" ,
"desc" : "Bluetooth, Player & Media detection" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-xfconf" ,
"desc" : "Needed for XFWM theme and XFCE Terminal font" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-sqlite3" ,
"desc" : "Needed for pkg & rpm package count" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-rpm" ,
"desc" : "Slower fallback for rpm package count" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-imagemagick" ,
"desc" : "Images in terminal using sixel or kitty graphics protocol" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-z" ,
"desc" : "Libz. Faster image output when using kitty graphics protocol" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-chafa" ,
"desc" : "Image output as ascii art" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-egl" ,
"desc" : "Needed by the OpenGL module for gl context creation" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-glx" ,
"desc" : "Needed by the OpenGL module for gl context creation" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-osmesa" ,
"desc" : "Needed by the OpenGL module for gl context creation" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-opencl" ,
"desc" : "OpenCL module" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-pulse" ,
"desc" : "Pulseaudio. Used for Sound detection" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-nm" ,
"desc" : "NetworkManager. Used for Wifi detection" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-freetype" ,
"desc" : "Used for Termux font detection" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "lib-ddcutil" ,
"desc" : "Used for brightness detection of external displays" ,
"arg" : {
"type" : "path"
}
}
],
"Module specific" : [
{
"long" : "title-fqdn" ,
"desc" : "Set if the title should use fully qualified domain name" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "title-color-user" ,
"desc" : "Set color of the user name (left part)" ,
2024-01-20 19:59:13 +08:00
"remark" : "See `-h color` for the list of available colors" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "color" ,
"default" : "Use color of \"--color-title\""
}
},
{
"long" : "title-color-at" ,
"desc" : "Set color of the @ symbol (middle part)" ,
2024-01-20 19:59:13 +08:00
"remark" : "See `-h color` for the list of available colors" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "color" ,
"default" : "Use color of \"--color-title\""
}
},
{
"long" : "title-color-host" ,
"desc" : "Set color of the host name (right part)" ,
2024-01-20 19:59:13 +08:00
"remark" : "See `-h color` for the list of available colors" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "color" ,
"default" : "default"
}
},
{
"long" : "separator-string" ,
"desc" : "Set the string printed by the separator module" ,
"arg" : {
"type" : "str" ,
"default" : "-"
}
},
{
"long" : "os-file" ,
"desc" : "Set the additional file path which containing OS information" ,
"remark" : "Linux only" ,
"arg" : {
"type" : "path"
}
},
{
"long" : "disk-folders" ,
2024-05-01 15:52:38 +08:00
"desc" : "A colon (semicolon on Windows) separated list of folder paths to be detected" ,
"remark" : "On Windows, a drive latter must be upper cased and end with \"\\\". \"/\" is used as an alias of the system drive. eg. \"/\" is the alias of \"C:\\\"." ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "path" ,
"default" : "Auto detection using mount-points"
}
},
{
"long" : "disk-show-regular" ,
"desc" : "Set if regular volume should be printed" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
"long" : "disk-show-external" ,
"desc" : "Set if external volume should be printed" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
"long" : "disk-show-hidden" ,
"desc" : "Set if hidden volumes should be printed" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "disk-show-subvolumes" ,
"desc" : "Set if subvolumes should be printed" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "disk-show-readonly" ,
"desc" : "Set if read only volumes should be printed" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
"long" : "disk-show-unknown" ,
"desc" : "Set if unknown (unable to detect sizes) volumes should be printed" ,
"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" ,
2023-11-20 18:28:12 +08:00
"remark" : "Maybe required for macOS to print correct results" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
2024-02-20 11:11:21 +08:00
{
"long" : "diskio-detect-total" ,
"desc" : "Detect total bytes instead of current rate" ,
"arg" : {
"type" : "bool" ,
"default" : false
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "diskio-name-prefix" ,
"desc" : "Show disks with given name prefix only" ,
"arg" : {
2023-11-22 09:32:38 +08:00
"type" : "str"
2023-11-20 16:37:59 +08:00
}
},
2023-12-18 15:53:15 +08:00
{
"long" : "physicaldisk-name-prefix" ,
"desc" : "Show disks with given name prefix only" ,
"arg" : {
"type" : "str"
}
},
2023-12-27 10:16:33 +08:00
{
"long" : "physicaldisk-temp" ,
"desc" : "Detect and display SSD temperature if supported" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "bluetooth-show-disconnected" ,
"desc" : "Set if disconnected bluetooth devices should be printed" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
2024-02-21 15:56:52 +08:00
"long" : "packages-disabled" ,
"desc" : "A colon separated list of package managers to be disabled when detecting" ,
2024-02-14 22:07:08 +08:00
"remark" : [
2024-02-21 15:56:52 +08:00
"Some detection methods can be very slow." ,
2024-02-14 22:07:08 +08:00
"You may need to increase value of '--processing-timeout' to make it actually work." ,
2024-02-21 15:56:52 +08:00
"Use `--packages-disabled none` to enable all."
2024-02-14 22:07:08 +08:00
],
2023-11-20 16:37:59 +08:00
"arg" : {
2024-02-21 15:56:52 +08:00
"type" : "string" ,
"default" : "winget"
2023-11-20 16:37:59 +08:00
}
},
{
"long" : "display-compact-type" ,
"desc" : "Set if all displays should be printed in one line" ,
"arg" : {
"type" : "enum" ,
"enum" : {
"none" : "Disable this compact mode" ,
"original" : "Print original resolutions" ,
2024-02-22 16:42:23 +08:00
"scaled" : "Print scaled resolutions" ,
"original-with-refresh-rate" : "Print original resolutions with refresh rate" ,
"scaled-with-refresh-rate" : "Print scaled resolutions with refresh rate"
2023-11-20 16:37:59 +08:00
},
"default" : "none"
}
},
{
"long" : "display-precise-refresh-rate" ,
"desc" : "Set if decimal refresh rates should not be rounded into integers when printing" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
2024-02-22 10:47:13 +08:00
{
"long" : "display-order" ,
"desc" : "Set the order should be used when printing displays" ,
"arg" : {
"type" : "enum" ,
"enum" : {
"none" : "Use the detected order" ,
"asc" : "Sort by display name ascendingly" ,
"desc" : "Sort by display name descendingly"
},
"default" : "none"
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "brightness-ddcci-sleep" ,
"desc" : "Set the sleep times (in ms) when sending DDC/CI requests" ,
"remark" : "See <https://www.ddcutil.com/performance_options/#option-sleep-multiplier> for detail" ,
"arg" : {
"type" : "num" ,
"default" : 10
}
},
{
"long" : "sound-type" ,
"desc" : "Set what type of sound devices should be printed" ,
"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" : "Set if \"SetupAPI\" should be used on Windows to detect battery info" ,
2024-02-14 22:07:08 +08:00
"remark" : [
"SetupAPI supports multi batteries, but slower." ,
"Windows only"
],
2023-11-20 16:37:59 +08:00
"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-freq-ndigits" ,
"desc" : "Set the number of digits to keep after the decimal point when printing CPU frequency" ,
"arg" : {
"type" : "num" ,
"default" : 2
}
},
{
"long" : "cpuusage-separate" ,
"desc" : "Display CPU usage per CPU logical core, instead of an average result" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "de-slow-version-detection" ,
"desc" : "Set if DE version should be detected with slow operations" ,
2024-02-14 22:07:08 +08:00
"remark" : [
"It's only used as a fallback method. Please file a bug report if you encounter any issues." ,
"Linux only"
],
2023-11-20 16:37:59 +08:00
"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
}
},
{
2023-12-20 14:59:27 +08:00
"long" : "gpu-driver-specific" ,
"desc" : "Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)" ,
2024-02-14 22:07:08 +08:00
"remark" : [
"Correctly NVML (NVIDIA) and IGCL (Intel, Windows only) are supported." ,
"Both require the latest proprietary driver to be installed."
],
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "gpu-force-vulkan" ,
"desc" : "Force using vulkan to detect GPUs" ,
"remark" : "Vulkan supports video memory usage detection" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "gpu-hide-type" ,
"desc" : "Specify the type of GPUs should not be printed" ,
"arg" : {
"type" : "enum" ,
"enum" : {
"integrated" : "Hide integrated GPUs" ,
"discrete" : "Hide discrete 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" : "localip-show-ipv4" ,
"desc" : "Show IPv4 addresses in local ip module" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
"long" : "localip-show-ipv6" ,
"desc" : "Show IPv6 addresses in local ip module" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "localip-show-mac" ,
"desc" : "Show mac addresses in local ip module" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "localip-show-loop" ,
"desc" : "Show loop back addresses (127.0.0.1) in local ip module" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
2024-04-04 10:42:44 +08:00
{
"long" : "localip-show-prefix-len" ,
"desc" : "Show network prefix length (/N) in local ip module" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "localip-name-prefix" ,
"desc" : "Show interfaces with given interface name prefix only" ,
"arg" : {
"type" : "str"
}
},
{
"long" : "localip-default-route-only" ,
"desc" : "Show the interface that is used for default routing only" ,
"remark" : "Doesn't work on Android" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
"long" : "localip-compact" ,
"desc" : "Show all IPs in one line" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "netio-name-prefix" ,
"desc" : "Show interfaces with given name prefix only" ,
"arg" : {
"type" : "str"
}
},
{
"long" : "netio-default-route-only" ,
"desc" : "Show the interfac that is used for default routing only" ,
"remark" : "Doesn't work on Android" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
2024-02-20 14:44:55 +08:00
{
"long" : "netio-detect-total" ,
"desc" : "Detect total bytes instead of current rate" ,
"arg" : {
"type" : "bool" ,
"default" : false
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "publicip-timeout" ,
"desc" : "Time in milliseconds to wait for the public ip server to respond" ,
"remark" : "0 to disable timeout" ,
"arg" : {
"type" : "num" ,
2023-11-22 15:36:48 +08:00
"default" : 0
2023-11-20 16:37:59 +08:00
}
},
{
"long" : "publicip-url" ,
"desc" : "The URL of public IP detection server to be used" ,
"arg" : {
"type" : "str"
}
},
{
"long" : "weather-location" ,
"desc" : "Set the location to be used" ,
"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" ,
2023-11-22 15:36:48 +08:00
"default" : 0
2023-11-20 16:37:59 +08:00
}
},
{
"long" : "weather-output-format" ,
"desc" : "The output weather format to be used" ,
"remark" : "Must be URI encoded" ,
"arg" : {
"type" : "str"
}
},
{
"long" : "wm-detect-plugin" ,
"desc" : "Set if window manager plugin should be detected on supported platforms" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "player-name" ,
"desc" : "The name of the player to use for module Media and Player" ,
"remark" : "Linux only" ,
"arg" : {
"type" : "str"
}
},
{
"long" : "opengl-library" ,
"desc" : "Set the OpenGL context creation library to use" ,
"arg" : {
2023-11-21 16:39:38 +08:00
"type" : "enum" ,
2023-11-20 16:37:59 +08:00
"enum" : {
"auto" : "Auto detection" ,
"egl" : "EGL" ,
"glx" : "GLX" ,
"osmesa" : "OSMesa"
},
"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-key" ,
"desc" : "Set the module key to display" ,
"arg" : {
"type" : "str"
}
},
{
"long" : "command-text" ,
"desc" : "Set the command text to be executed" ,
"arg" : {
"type" : "str"
}
},
{
"long" : "colors-symbol" ,
"desc" : "Set the symbol to be printed by Colors module" ,
"arg" : {
2023-11-21 16:39:38 +08:00
"type" : "enum" ,
2023-11-20 16:37:59 +08:00
"enum" : {
2023-12-06 23:55:34 +08:00
"block" : "\u2588\u2588\u2588" ,
"circle" : "\u25cf" ,
"diamond" : "\u25c6" ,
"triangle" : "\u25b2" ,
"square" : "\u25a0" ,
"star" : "\u2605"
2023-11-20 16:37:59 +08:00
},
"default" : "block"
}
},
{
"long" : "colors-padding-left" ,
"desc" : "Set the number of white spaces to print before the symbol" ,
"arg" : {
"type" : "num" ,
"default" : 0
}
2024-02-14 22:07:08 +08:00
},
{
"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
}
2023-11-20 16:37:59 +08:00
}
],
"General module" : [
{
"long" : "<module>-format" ,
"desc" : [
"Set the format string to use for each specific module" ,
"To see how a format string works, use \"fastfetch -h format\"." ,
"To see 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 each specific module." ,
"For modules which print multiple lines, the string is parsed" ,
"as a format string with the index as first character"
],
"arg" : {
"type" : "key"
},
"pseudo" : true
},
{
"long" : "<module>-key-color" ,
"desc" : "Override the global \"--color-keys\" option for each specific module" ,
"arg" : {
"type" : "color"
},
"pseudo" : true
},
{
"long" : "<module>-key-width" ,
"desc" : "Override the global \"--key-width\" option for each specific module" ,
"arg" : {
"type" : "num"
},
"pseudo" : true
2024-01-20 18:40:12 +08:00
},
{
"long" : "<module>-percent-green" ,
"desc" : [
"Threshold of percentage colors" ,
"Value less then percent-green will be shown in green"
],
"arg" : {
"type" : "num"
},
"pseudo" : true
},
{
"long" : "<module>-percent-yellow" ,
"desc" : [
"Threshold of percentage colors" ,
"Value greater than percent-green and less then yellow will be shown in yellow" ,
"Value greater than percent-yellow will be shown in red"
],
"arg" : {
"type" : "num"
},
"pseudo" : true
2024-02-26 16:39:41 +08:00
},
{
"long" : "<module>-temp-green" ,
"desc" : [
"Threshold of temperature colors" ,
"Value less then temp-green will be shown in green"
],
"arg" : {
"type" : "num"
},
"pseudo" : true
},
{
"long" : "<module>-temp-yellow" ,
"desc" : [
"Threshold of temperature colors" ,
"Value greater than temp-green and less then yellow will be shown in yellow" ,
"Value greater than temp-yellow will be shown in red"
],
"arg" : {
"type" : "num"
},
"pseudo" : true
2023-11-20 16:37:59 +08:00
}
]
}
