2023-11-20 16:37:59 +08:00
{
"Informative" : [
{
"short" : "h" ,
"long" : "help" ,
2025-04-04 18:15:54 +08:00
"desc" : "Display this help message or help for a specific command" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "command" ,
"optional" : true
}
},
{
"short" : "v" ,
"long" : "version" ,
"desc" : "Show the full version of fastfetch"
},
{
"long" : "version-raw" ,
2025-04-04 18:15:54 +08:00
"desc" : "Display the raw version string (major.minor.patch)"
2023-11-20 16:37:59 +08:00
},
{
"long" : "list-config-paths" ,
2025-04-04 18:15:54 +08:00
"desc" : "List search paths for config files"
2023-11-20 16:37:59 +08:00
},
{
"long" : "list-data-paths" ,
2025-04-04 18:15:54 +08:00
"desc" : "List search paths for presets and logos"
2023-11-20 16:37:59 +08:00
},
{
"long" : "list-logos" ,
"desc" : "List available logos"
},
{
"long" : "list-modules" ,
"desc" : "List available modules"
},
{
"long" : "list-presets" ,
2025-04-04 18:15:54 +08:00
"desc" : "List presets that fastfetch knows about" ,
2023-11-20 16:37:59 +08:00
"remark" : "Presets can be loaded with \"--config <preset-name>\""
},
{
"long" : "list-features" ,
2025-04-04 18:15:54 +08:00
"desc" : "List the supported features that fastfetch was compiled with" ,
2023-11-20 16:37:59 +08:00
"remark" : "Mainly for development"
},
{
"long" : "print-logos" ,
2025-04-04 18:15:54 +08:00
"desc" : "Display available logos"
2023-11-20 16:37:59 +08:00
},
{
"long" : "print-structure" ,
2025-04-04 18:15:54 +08:00
"desc" : "Display the default structure"
2024-06-03 14:49:31 +08:00
},
{
"long" : "format" ,
"desc" : "Set output format" ,
"arg" : {
"type" : "enum" ,
"enum" : {
"default" : "Default format" ,
"json" : "JSON format"
},
"default" : "default"
}
2023-11-20 16:37:59 +08:00
}
],
"Config" : [
{
"short" : "c" ,
"long" : "config" ,
2025-04-04 18:15:54 +08:00
"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" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "config"
}
},
{
"long" : "gen-config" ,
2025-04-04 18:15:54 +08:00
"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 \"-\"" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "path" ,
"optional" : true
}
},
{
"long" : "gen-config-force" ,
2025-04-04 18:15:54 +08:00
"desc" : "Generate a config file at the specified path, overwriting any existing file" ,
2023-11-20 16:37:59 +08:00
"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" ,
2025-04-04 18:15:54 +08:00
"desc" : "Use separate threads for HTTP requests" ,
2023-11-20 16:37:59 +08:00
"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" ,
2024-09-18 16:09:38 +08:00
"default" : 5000
2023-11-20 16:37:59 +08:00
}
},
{
"long" : "ds-force-drm" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether only DRM should be used to detect displays" ,
2024-02-14 22:07:08 +08:00
"remark" : [
2025-04-04 18:15:54 +08:00
"Use this option if you encounter problems with other detection methods." ,
2024-02-14 22:07:08 +08:00
"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" : {
2025-04-04 18:15:54 +08:00
"true" : "Try `libdrm` first, then `sysfs` if libdrm fails" ,
2023-12-11 13:25:58 +08:00
"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
}
2024-07-10 21:55:37 +08:00
},
{
"long" : "detect-version" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether to detect and display versions of terminal, shell, editor, and others" ,
2024-07-10 21:55:37 +08:00
"remark" : "Mainly for benchmarking" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
2023-11-20 16:37:59 +08:00
}
],
"Logo" : [
{
"short" : "l" ,
"long" : "logo" ,
2024-06-29 20:32:36 +09:00
"desc" : "Set the logo source. Use \"none\" to disable the logo" ,
2025-04-04 18:15:54 +08:00
"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" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "logo"
}
},
{
"long" : "logo-type" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the type of the logo specified 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" : {
2025-04-04 18:15:54 +08:00
"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" ,
2023-11-20 16:37:59 +08:00
"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" ,
2025-04-04 18:15:54 +08:00
"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" ,
2023-11-20 16:37:59 +08:00
"raw" : "Image file, printed as raw binary string" ,
"none" : "Disable logo printing"
}
}
},
{
"long" : "logo-width" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the width of the logo (in characters) if it is an image" ,
2023-11-20 16:37:59 +08:00
"remark" : "Required for iTerm image protocol" ,
"arg" : {
"type" : "num"
}
},
{
"long" : "logo-height" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the height of the logo (in characters) if it is an image" ,
2023-11-20 16:37:59 +08:00
"remark" : "Required for iTerm image protocol" ,
"arg" : {
"type" : "num"
}
},
{
"long" : "logo-preserve-aspect-ratio" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether the logo should fill the specified width and height as much as possible without stretching" ,
2023-11-20 16:37:59 +08:00
"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]" ,
2025-04-04 18:15:54 +08:00
"desc" : "Override 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" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the padding on the left and right sides of the logo" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "num"
}
},
{
"long" : "logo-padding-left" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the padding on the left side of the logo" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "num"
}
},
{
"long" : "logo-padding-right" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the padding on the right side of the logo" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "num"
}
},
{
"long" : "logo-padding-top" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the padding at the top of the logo" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "num"
}
},
{
"long" : "logo-print-remaining" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether to print the remaining logo if it has more lines than modules to display" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
2024-06-27 10:27:17 +08:00
"long" : "logo-position" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the position where the logo should be displayed" ,
2023-11-20 16:37:59 +08:00
"arg" : {
2024-06-27 10:27:17 +08:00
"type" : "enum" ,
"enum" : {
"left" : "Left" ,
"top" : "Top" ,
"right" : "Right"
}
2023-11-20 16:37:59 +08:00
}
},
{
"long" : "logo-recache" ,
2025-04-04 18:15:54 +08:00
"desc" : "If true, regenerate the image logo cache" ,
2023-11-20 16:37:59 +08:00
"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"
}
},
2024-12-31 15:43:01 +08:00
{
"long" : "kitty-icat" ,
"desc" : "Short for --logo-type kitty-icat --logo <path>" ,
"remark" : "See \"--help logo-type\" for more info" ,
"arg" : {
"type" : "path"
}
},
2023-11-20 16:37:59 +08:00
{
"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" ,
2025-04-04 18:15:54 +08:00
"remark" : "Must be a colon-separated list of keys. Use \"fastfetch --list-modules\" to see available options" ,
2023-11-20 16:37:59 +08:00
"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" ,
2024-06-29 18:53:08 +08:00
"desc" : "Disable colors" ,
2025-04-04 18:15:54 +08:00
"remark" : "Auto-detected based on isatty(1) by default" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
2025-07-30 14:30:36 +08:00
"optional" : true ,
"default" : false
2023-11-20 16:37:59 +08:00
}
},
2025-04-04 18:59:15 +08:00
{
"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"
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "color-keys" ,
"desc" : "Set the color of the keys" ,
2025-04-04 18:15:54 +08:00
"remark" : "Doesn't affect Title, Separator, and Colors modules. 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"
}
},
2024-05-08 16:17:05 +08:00
{
"long" : "color-output" ,
"desc" : "Set the color of module output" ,
"remark" : "See `-h color` for the list of available colors" ,
2024-05-28 19:12:43 +08:00
"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" ,
2024-05-08 16:17:05 +08:00
"arg" : {
"type" : "color"
}
},
2025-07-30 14:30:36 +08:00
{
"long" : "duration-abbreviation" ,
"desc" : "Specify whether to abbreviate duration values" ,
"remark" : "If true, the output will be in the form of \"1h 2m\" instead of \"1 hour, 2 mins\"" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "duration-space-before-unit" ,
"desc" : "Specify whether to put a space before the unit in duration values" ,
"arg" : {
"type" : "enum" ,
"enum" : {
"default" : "Use the default behavior of the module" ,
"always" : "Always put a space before the unit" ,
"never" : "Never put a space before the unit"
}
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "key-width" ,
"desc" : "Align the width of keys to <num> characters" ,
"arg" : {
"type" : "num"
}
},
2024-07-24 15:12:25 +08:00
{
"long" : "key-padding-left" ,
"desc" : "Set the left padding of keys to <num> characters" ,
"arg" : {
"type" : "num"
}
},
2024-07-24 11:13:37 +08:00
{
"long" : "key-type" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether to show an icon before string keys" ,
2024-07-24 11:13:37 +08:00
"arg" : {
"type" : "enum" ,
"enum" : {
"none" : "Disable keys" ,
"string" : "Show string" ,
2024-07-26 09:51:51 +08:00
"icon" : "Show icon (requires newest nerd font)" ,
2024-07-24 11:13:37 +08:00
"both" : "Show both icon and string"
},
"default" : "string"
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "bright-color" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether keys, title, and ASCII logo should be printed in bright color" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
"long" : "separator" ,
"desc" : "Set the separator between key and value" ,
"arg" : {
"type" : "str" ,
"default" : ": "
}
},
{
"long" : "show-errors" ,
2025-04-04 18:15:54 +08:00
"desc" : "Print errors when they occur" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "disable-linewrap" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether to disable line wrap during execution" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
"long" : "hide-cursor" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether to hide the cursor during execution" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
2024-05-08 11:06:38 +08:00
"default" : false
2023-11-20 16:37:59 +08:00
}
},
{
"long" : "percent-type" ,
"desc" : "Set the percentage output type" ,
2024-02-14 22:07:08 +08:00
"remark" : [
"1 for percentage number" ,
2024-05-24 10:19:58 +08:00
"2 for multi-color bar" ,
2024-02-14 22:07:08 +08:00
"3 for both" ,
"6 for bar only" ,
2024-05-24 10:19:58 +08:00
"9 for colored number" ,
"10 for monochrome bar"
2024-02-14 22:07:08 +08:00
],
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" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set color used for the green state of percentage bars and numbers" ,
2024-01-20 19:59:13 +08:00
"remark" : "See `-h color` for the list of available colors" ,
"arg" : {
"type" : "color" ,
"default" : "green"
}
},
{
"long" : "percent-color-yellow" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set color used for the yellow state of percentage bars and numbers" ,
2024-01-20 19:59:13 +08:00
"remark" : "See `-h color` for the list of available colors" ,
"arg" : {
"type" : "color" ,
"default" : "light_yellow"
}
},
{
"long" : "percent-color-red" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set color used for the red state of percentage bars and numbers" ,
2024-01-20 19:59:13 +08:00
"remark" : "See `-h color` for the list of available colors" ,
"arg" : {
"type" : "color" ,
"default" : "light_red"
}
},
2025-07-30 14:30:36 +08:00
{
"long" : "percent-space-before-unit" ,
"desc" : "Specify whether to put a space before the percentage symbol" ,
"arg" : {
"type" : "enum" ,
"enum" : {
"default" : "Use the default behavior of the module" ,
"always" : "Always put a space before the unit" ,
"never" : "Never put a space before the unit"
}
}
},
2025-07-30 15:06:16 +08:00
{
"long" : "percent-width" ,
"desc" : "Specify the width of the percentage number, in number of characters" ,
"remark" : "This option affects only percentage numbers, not bars" ,
"arg" : {
"type" : "num" ,
"default" : 0
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "bar-char-elapsed" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the character to use in the 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" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the character to use in the total part of percentage bars" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "str" ,
"default" : "-"
}
},
{
2024-06-06 16:36:57 +08:00
"long" : "bar-border-left" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the string to use at the left border of percentage bars" ,
2023-11-20 16:37:59 +08:00
"arg" : {
2024-06-06 16:36:57 +08:00
"type" : "string" ,
"default" : "[ "
2023-11-20 16:37:59 +08:00
}
},
{
2024-06-06 16:36:57 +08:00
"long" : "bar-border-right" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the string to use at the right border of percentage bars" ,
2023-11-20 16:37:59 +08:00
"arg" : {
2024-06-06 16:36:57 +08:00
"type" : "string" ,
"default" : " ]"
}
},
2025-08-01 10:51:26 +08:00
{
"long" : "bar-border-left-elapsed" ,
"desc" : "If both bar-border-left-elapsed and bar-border-right-elapsed are set, the border will be used as parts of bar content" ,
"arg" : {
"type" : "string" ,
"default" : ""
}
},
{
"long" : "bar-border-right-elapsed" ,
"desc" : "If both bar-border-left-elapsed and bar-border-right-elapsed are set, the border will be used as parts of bar content" ,
"arg" : {
"type" : "string" ,
"default" : ""
}
},
2024-06-06 16:36:57 +08:00
{
"long" : "bar-width" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the width of percentage bars in characters" ,
2024-06-06 16:36:57 +08:00
"arg" : {
"type" : "num" ,
"default" : 10
2023-11-20 16:37:59 +08:00
}
},
{
"long" : "no-buffer" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether the stdout application buffer should be disabled" ,
2023-11-20 16:37:59 +08:00
"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"
}
},
2024-07-22 10:51:27 +08:00
{
"long" : "size-binary-prefix" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the binary prefix to use when formatting sizes" ,
2024-07-22 10:51:27 +08:00
"arg" : {
"type" : "enum" ,
"enum" : {
"IEC" : "1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ..." ,
2025-02-27 21:10:57 +08:00
"SI" : "1000 Bytes = 1 kB, 1000 kB = 1 MB, ..." ,
"JEDEC" : "1024 Bytes = 1 KB, 1024 KB = 1 MB, ..."
2024-07-22 10:51:27 +08:00
},
"default" : "IEC"
}
},
2023-11-20 16:37:59 +08:00
{
"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"
}
},
2025-07-30 14:30:36 +08:00
{
"long" : "size-space-before-unit" ,
"desc" : "Specify whether to put a space before the unit" ,
"arg" : {
"type" : "enum" ,
"enum" : {
"default" : "Use the default behavior of the module" ,
"always" : "Always put a space before the unit" ,
"never" : "Never put a space before the unit"
}
}
},
2024-07-17 14:42:09 +08:00
{
"long" : "freq-ndigits" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the number of digits to keep after the decimal point when printing CPU/GPU frequency in GHz" ,
2024-07-17 14:42:09 +08:00
"arg" : {
"type" : "num" ,
"default" : 2
}
},
2025-07-30 14:30:36 +08:00
{
"long" : "freq-space-before-unit" ,
"desc" : "Specify whether to put a space before the unit" ,
"arg" : {
"type" : "enum" ,
"enum" : {
"default" : "Use the default behavior of the module" ,
"always" : "Always put a space before the unit" ,
"never" : "Never put a space before the unit"
}
}
},
2025-07-16 10:30:45 +08:00
{
"long" : "fraction-ndigits" ,
"desc" : "Set the number of digits to keep after the decimal point when printing ordinary fraction numbers" ,
"remark" : "If negative, the number of digits will be automatically determined based on the value" ,
"arg" : {
"type" : "num" ,
"default" : -1
}
},
2023-11-20 16:37:59 +08:00
{
2024-02-27 13:11:39 +08:00
"long" : "temp-unit" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the temperature unit" ,
2023-11-20 16:37:59 +08:00
"arg" : {
2023-11-21 16:39:38 +08:00
"type" : "enum" ,
2023-11-20 16:37:59 +08:00
"enum" : {
2025-02-14 10:31:13 +08:00
"D" : "Default" ,
2023-11-20 16:37:59 +08:00
"C" : "Celsius" ,
"F" : "Fahrenheit" ,
"K" : "Kelvin"
},
2025-02-14 10:31:13 +08:00
"default" : "D"
2023-11-20 16:37:59 +08:00
}
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" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set color used for the green state of temperature values" ,
2024-02-26 10:46:13 +08:00
"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" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set color used for the yellow state of temperature values" ,
2024-02-26 10:46:13 +08:00
"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" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set color used for the red state of temperature values" ,
2024-02-26 10:46:13 +08:00
"remark" : "See `-h color` for the list of available colors" ,
"arg" : {
"type" : "color" ,
"default" : "light_red"
}
2025-07-30 14:30:36 +08:00
},
{
"long" : "temp-space-before-unit" ,
"desc" : "Specify whether to put a space before the unit" ,
"arg" : {
"type" : "enum" ,
"enum" : {
"default" : "Use the default behavior of the module" ,
"always" : "Always put a space before the unit" ,
"never" : "Never put a space before the unit"
}
}
2023-11-20 16:37:59 +08:00
}
],
"Module specific" : [
{
"long" : "title-fqdn" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether the title should use fully qualified domain name" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "title-color-user" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the 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" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the 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" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the 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" ,
2024-07-17 09:16:25 +08:00
"desc" : "Set the string to be printed by the separator line" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "str" ,
"default" : "-"
}
},
2024-05-08 16:11:16 +08:00
{
"long" : "separator-output-color" ,
2024-07-17 09:16:25 +08:00
"desc" : "Set the color of the separator line" ,
2024-05-08 16:11:16 +08:00
"arg" : {
"type" : "color" ,
"default" : "default"
}
},
2024-07-17 09:16:25 +08:00
{
"long" : "separator-length" ,
"desc" : "Set the length of the separator line" ,
2025-04-04 18:15:54 +08:00
"remark" : "Set to 0 to automatically calculate it based on the title length" ,
2024-07-17 09:16:25 +08:00
"arg" : {
"type" : "num" ,
"default" : "0"
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "disk-folders" ,
2025-04-04 18:15:54 +08:00
"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" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "path" ,
2025-05-21 15:09:19 +08:00
"default" : "Auto detection using mount-points"
}
},
{
"long" : "disk-hide-folders" ,
"desc" : "A colon (semicolon on Windows) separated list of folder paths to hide from the disk output" ,
"arg" : {
"type" : "path" ,
2025-07-28 23:49:27 +08:00
"default" : "/efi:/boot:/boot/efi:/boot/firmware"
2025-05-21 16:40:42 +08:00
}
},
{
"long" : "disk-hide-fs" ,
"desc" : "A colon separated list of file systems to hide from the disk output" ,
"arg" : {
"type" : "string" ,
"default" : ""
2023-11-20 16:37:59 +08:00
}
},
{
"long" : "disk-show-regular" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether regular volumes should be displayed" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
"long" : "disk-show-external" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether external volumes should be displayed" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
"long" : "disk-show-hidden" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether hidden volumes should be displayed" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "disk-show-subvolumes" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether subvolumes should be displayed" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "disk-show-readonly" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether read-only volumes should be displayed" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
"long" : "disk-show-unknown" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether unknown volumes (unable to detect sizes) should be displayed" ,
2023-11-20 16:37:59 +08:00
"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" ,
2025-04-04 18:15:54 +08:00
"remark" : "May be required for macOS to display 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" ,
2025-04-04 18:15:54 +08:00
"desc" : "Show only disks with the given name prefix" ,
2023-11-20 16:37:59 +08:00
"arg" : {
2023-11-22 09:32:38 +08:00
"type" : "str"
2023-11-20 16:37:59 +08:00
}
},
2024-10-22 11:08:44 +08:00
{
"long" : "diskio-wait-time" ,
"desc" : "Set the wait time (in ms) when detecting disk usage" ,
"arg" : {
"type" : "num" ,
"default" : 1000
}
},
2023-12-18 15:53:15 +08:00
{
"long" : "physicaldisk-name-prefix" ,
2025-04-04 18:15:54 +08:00
"desc" : "Show only disks with the given name prefix" ,
2023-12-18 15:53:15 +08:00
"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" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether disconnected Bluetooth devices should be displayed" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
2024-02-21 15:56:52 +08:00
"long" : "packages-disabled" ,
2025-04-04 18:15:54 +08:00
"desc" : "A colon-separated list of package managers to disable 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." ,
2025-04-04 18:15:54 +08:00
"You may need to increase the value of '--processing-timeout' to make it work properly." ,
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
}
},
2025-07-18 15:55:33 +08:00
{
"long" : "packages-combined" ,
"desc" : "Whether to combine related package managers into single counts" ,
"remark" : "e.g., nix-system + nix-user = nix" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "display-compact-type" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether all displays should be printed in one line" ,
2023-11-20 16:37:59 +08:00
"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" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether decimal refresh rates should not be rounded to integers when printing" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
2024-02-22 10:47:13 +08:00
{
"long" : "display-order" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the order to use when printing displays" ,
2024-02-22 10:47:13 +08:00
"arg" : {
"type" : "enum" ,
"enum" : {
"none" : "Use the detected order" ,
2025-04-04 18:15:54 +08:00
"asc" : "Sort by display name in ascending order" ,
"desc" : "Sort by display name in descending order"
2024-02-22 10:47:13 +08:00
},
"default" : "none"
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "brightness-ddcci-sleep" ,
2025-04-04 18:15:54 +08:00
"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" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "num" ,
"default" : 10
}
},
2024-09-30 15:45:06 +08:00
{
"long" : "brightness-compact" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether multiple results should be printed in one line" ,
2024-09-30 15:45:06 +08:00
"arg" : {
"type" : "bool" ,
"default" : false
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "sound-type" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set which types of sound devices should be displayed" ,
2023-11-20 16:37:59 +08:00
"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" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether \"SetupAPI\" should be used on Windows to detect battery info" ,
2024-02-14 22:07:08 +08:00
"remark" : [
2025-04-04 18:15:54 +08:00
"SetupAPI supports multiple batteries, but is slower." ,
2024-02-14 22:07:08 +08:00
"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
}
},
2024-05-21 09:09:08 +08:00
{
"long" : "cpu-show-pe-core-count" ,
2025-04-04 18:15:54 +08:00
"desc" : "Detect and display CPU frequency of different core types (e.g., P-cores and E-cores) if supported" ,
2024-05-21 09:09:08 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
2024-06-05 19:15:25 +08:00
{
"long" : "cpucache-compact" ,
"desc" : "Show all CPU caches in one line" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "cpuusage-separate" ,
2025-04-04 18:15:54 +08:00
"desc" : "Display CPU usage per logical core, instead of an average result" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
2024-10-22 11:08:44 +08:00
{
"long" : "cpuusage-wait-time" ,
"desc" : "Set the wait time (in ms) when detecting CPU usage" ,
"arg" : {
"type" : "num" ,
"default" : 200
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "de-slow-version-detection" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether DE version should be detected with slower operations" ,
2024-02-14 22:07:08 +08:00
"remark" : [
2025-04-04 18:15:54 +08:00
"This is only used as a fallback method. Please file a bug report if you encounter any issues." ,
2024-02-14 22:07:08 +08:00
"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" ,
2025-04-04 18:15:54 +08:00
"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." ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
2024-05-20 16:45:23 +08:00
"long" : "gpu-detection-method" ,
"desc" : "Force using a specified method to detect GPUs" ,
2025-04-04 18:15:54 +08:00
"remark" : "Will fall back to other methods if the specified method fails" ,
2023-11-20 16:37:59 +08:00
"arg" : {
2024-05-20 16:45:23 +08:00
"type" : "enum" ,
"enum" : {
2025-06-20 09:51:40 +08:00
"auto" : "Query platform-specific graphics APIs. Requires proper GPU drivers to be installed. Supported on Linux, FreeBSD, Windows and macOS" ,
2025-04-04 18:15:54 +08:00
"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" ,
2025-06-20 09:51:40 +08:00
"opengl" : "Use OpenGL API. Slow and only detects one GPU. Used for OpenBSD"
2024-05-20 16:45:23 +08:00
},
"default" : "auto"
2023-11-20 16:37:59 +08:00
}
},
{
"long" : "gpu-hide-type" ,
2025-05-07 16:06:47 +02:00
"desc" : "Specify which types of GPUs should not be displayed (default: all GPUs are shown, regardless of recognition)" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "enum" ,
"enum" : {
"integrated" : "Hide integrated GPUs" ,
"discrete" : "Hide discrete GPUs" ,
2025-05-07 16:06:47 +02:00
"unknown" : "Hide unknown (unrecognized) GPUs" ,
2023-11-20 16:37:59 +08:00
"none" : "Do not hide any GPUs"
},
"default" : "none"
}
},
{
"long" : "battery-temp" ,
2025-04-04 18:15:54 +08:00
"desc" : "Detect and display battery temperature if supported" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
2024-05-09 09:40:53 +08:00
{
"long" : "loadavg-ndigits" ,
"desc" : "Set the number of digits to keep after the decimal point when printing load average" ,
"arg" : {
"type" : "num" ,
"default" : 2
}
},
2024-06-12 20:48:05 +08:00
{
"long" : "loadavg-compact" ,
"desc" : "Show load average values in one line" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "localip-show-ipv4" ,
2025-04-04 18:15:54 +08:00
"desc" : "Show IPv4 addresses in the local IP module" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
{
"long" : "localip-show-ipv6" ,
2025-04-04 18:15:54 +08:00
"desc" : "Show IPv6 addresses in the local IP module" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "localip-show-mac" ,
2025-04-04 18:15:54 +08:00
"desc" : "Show MAC addresses in the local IP module" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "localip-show-loop" ,
2025-04-04 18:15:54 +08:00
"desc" : "Show loopback addresses (127.0.0.1) in the local IP module" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
2024-10-05 21:49:29 +08:00
"default" : false
}
},
{
"long" : "localip-show-mtu" ,
2025-04-04 18:15:54 +08:00
"desc" : "Show network interface MTU (Maximum Transmission Unit) size in bytes" ,
2024-10-05 21:49:29 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "localip-show-speed" ,
2025-04-04 18:15:54 +08:00
"desc" : "Show network interface link speed in human-readable format (or as a 1Mb units integer in JSON format)" ,
2024-10-05 21:49:29 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
2023-11-20 16:37:59 +08:00
"default" : false
}
},
2024-04-04 10:42:44 +08:00
{
"long" : "localip-show-prefix-len" ,
2025-04-04 18:15:54 +08:00
"desc" : "Show network prefix length (/N) in the local IP module" ,
2024-04-04 10:42:44 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "localip-name-prefix" ,
2025-04-04 18:15:54 +08:00
"desc" : "Show only interfaces with the given interface name prefix" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "str"
}
},
{
"long" : "localip-default-route-only" ,
2025-04-04 18:15:54 +08:00
"desc" : "Show only the interface that is used for default routing" ,
2023-11-20 16:37:59 +08:00
"remark" : "Doesn't work on Android" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : true
}
},
2024-05-13 22:59:39 +08:00
{
"long" : "localip-show-all-ips" ,
2025-04-04 18:15:54 +08:00
"desc" : "Show all IPs bound to the same interface. By default, only the first IP is shown" ,
2024-05-13 22:59:39 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
2024-10-05 09:49:27 +08:00
{
"long" : "localip-show-flags" ,
2025-04-04 18:15:54 +08:00
"desc" : "Show network interface flags in the local IP module" ,
2024-10-05 09:49:27 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "localip-compact" ,
"desc" : "Show all IPs in one line" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
2024-06-12 19:52:25 +08:00
{
"long" : "dns-show-type" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify which types of DNS servers should be detected" ,
2024-06-12 19:52:25 +08:00
"arg" : {
"type" : "enum" ,
"enum" : {
"ipv4" : "Show IPv4 addresses only" ,
"ipv6" : "Show IPv6 addresses only" ,
"both" : "Show both IPv4 and IPv6 addresses"
},
"default" : "both"
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "netio-name-prefix" ,
2025-04-04 18:15:54 +08:00
"desc" : "Show only interfaces with the given name prefix" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "str"
}
},
{
"long" : "netio-default-route-only" ,
2025-04-04 18:15:54 +08:00
"desc" : "Show only the interface that is used for default routing" ,
2023-11-20 16:37:59 +08:00
"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
}
},
2024-10-22 11:08:44 +08:00
{
"long" : "netio-wait-time" ,
"desc" : "Set the wait time (in ms) when detecting network usage" ,
"arg" : {
"type" : "num" ,
"default" : 1000
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "publicip-timeout" ,
2025-04-04 18:15:54 +08:00
"desc" : "Time in milliseconds to wait for the public IP server to respond" ,
2023-11-20 16:37:59 +08:00
"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" ,
2025-04-04 18:15:54 +08:00
"desc" : "The URL of the public IP detection server to use" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "str"
}
},
2024-05-09 10:13:04 +08:00
{
"long" : "publicip-ipv6" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether to use IPv6 for the public IP detection server" ,
2024-05-09 10:13:04 +08:00
"arg" : {
"type" : "bool" ,
"default" : false
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "weather-location" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the location to use" ,
"remark" : "Must be URI encoded (e.g., a whitespace must be encoded as \"+\")" ,
2023-11-20 16:37:59 +08:00
"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" ,
2025-04-04 18:15:54 +08:00
"desc" : "The output weather format to use" ,
2023-11-20 16:37:59 +08:00
"remark" : "Must be URI encoded" ,
"arg" : {
"type" : "str"
}
},
{
"long" : "wm-detect-plugin" ,
2025-04-04 18:15:54 +08:00
"desc" : "Specify whether window manager plugins should be detected on supported platforms" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
2024-06-12 14:02:35 +08:00
{
"long" : "users-compact" ,
"desc" : "Show all active users in one line" ,
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "users-myself-only" ,
2025-04-04 18:15:54 +08:00
"desc" : "Show only the current user" ,
2024-06-12 14:02:35 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "player-name" ,
2025-04-04 18:15:54 +08:00
"desc" : "The name of the player to use for the Media and Player modules" ,
2023-11-20 16:37:59 +08:00
"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" : {
2025-04-04 18:15:54 +08:00
"auto" : "Prefer EGL on *nix; prefer platform-specific implementation on others" ,
2023-11-20 16:37:59 +08:00
"egl" : "EGL" ,
2025-03-14 15:30:52 +08:00
"glx" : "GLX (*nix only)"
2023-11-20 16:37:59 +08:00
},
"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"
}
},
2024-09-10 21:59:30 +08:00
{
"long" : "command-param" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the parameter to use when starting the shell" ,
"remark" : "If set to an empty string, it will be ignored" ,
2024-09-10 21:59:30 +08:00
"arg" : {
"type" : "str" ,
"default" : "\"/c\" for Windows; \"-c\" for *nix"
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "command-key" ,
"desc" : "Set the module key to display" ,
"arg" : {
"type" : "str"
}
},
{
"long" : "command-text" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the command text to execute" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "str"
}
},
{
"long" : "colors-symbol" ,
2025-04-04 18:15:54 +08:00
"desc" : "Set the symbol to be printed by the Colors module" ,
2023-11-20 16:37:59 +08:00
"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" ,
2024-07-16 11:07:26 +08:00
"background" : "(whitespaces with background)" ,
2023-12-06 23:55:34 +08:00
"circle" : "\u25cf" ,
"diamond" : "\u25c6" ,
"triangle" : "\u25b2" ,
"square" : "\u25a0" ,
"star" : "\u2605"
2023-11-20 16:37:59 +08:00
},
2024-07-16 11:07:26 +08:00
"default" : "background"
2023-11-20 16:37:59 +08:00
}
},
{
"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" : [
2025-04-04 18:15:54 +08:00
"Set the format string to use for a specific module" ,
2025-04-04 18:59:15 +08:00
"See <https://github.com/fastfetch-cli/fastfetch/wiki/Format-String-Guide>" ,
2025-04-04 18:15:54 +08:00
"For help about a specific format string, use \"fastfetch -h <module>-format\""
2023-11-20 16:37:59 +08:00
],
"arg" : {
"type" : "format"
},
"pseudo" : true
},
{
"long" : "<module>-key" ,
"desc" : [
2025-04-04 18:15:54 +08:00
"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"
2023-11-20 16:37:59 +08:00
],
"arg" : {
"type" : "key"
},
"pseudo" : true
},
{
"long" : "<module>-key-color" ,
2025-04-04 18:15:54 +08:00
"desc" : "Override the global \"--color-keys\" option for a specific module" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "color"
},
"pseudo" : true
},
2024-07-24 14:05:46 +08:00
{
"long" : "<module>-key-icon" ,
"desc" : "Set the icon to be displayed by \"--key-type icon\"" ,
"arg" : {
"type" : "string"
},
"pseudo" : true
},
2024-05-08 16:17:05 +08:00
{
"long" : "<module>-output-color" ,
2025-04-04 18:15:54 +08:00
"desc" : "Override the global \"--color-output\" option for a specific module" ,
2024-05-08 16:17:05 +08:00
"arg" : {
"type" : "color"
},
"pseudo" : true
},
2023-11-20 16:37:59 +08:00
{
"long" : "<module>-key-width" ,
2025-04-04 18:15:54 +08:00
"desc" : "Override the global \"--key-width\" option for a specific module" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "num"
},
"pseudo" : true
2024-01-20 18:40:12 +08:00
},
{
"long" : "<module>-percent-green" ,
"desc" : [
2025-04-04 18:15:54 +08:00
"Threshold for percentage color ranges" ,
"Values less than percent-green will be shown in green"
2024-01-20 18:40:12 +08:00
],
"arg" : {
"type" : "num"
},
"pseudo" : true
},
{
"long" : "<module>-percent-yellow" ,
"desc" : [
2025-04-04 18:15:54 +08:00
"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"
2024-01-20 18:40:12 +08:00
],
"arg" : {
"type" : "num"
},
"pseudo" : true
2024-02-26 16:39:41 +08:00
},
2024-11-14 14:22:24 +08:00
{
"long" : "<module>-percent-type" ,
"desc" : "Set the percentage output type" ,
"remark" : [
2025-04-04 18:15:54 +08:00
"0 to use global `--percent-type` value" ,
2024-11-14 14:22:24 +08:00
"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
},
2024-02-26 16:39:41 +08:00
{
"long" : "<module>-temp-green" ,
"desc" : [
2025-04-04 18:15:54 +08:00
"Threshold for temperature color ranges" ,
"Values less than temp-green will be shown in green"
2024-02-26 16:39:41 +08:00
],
"arg" : {
"type" : "num"
},
"pseudo" : true
},
{
"long" : "<module>-temp-yellow" ,
"desc" : [
2025-04-04 18:15:54 +08:00
"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"
2024-02-26 16:39:41 +08:00
],
"arg" : {
"type" : "num"
},
"pseudo" : true
2023-11-20 16:37:59 +08:00
}
]
}
