2023-11-20 16:37:59 +08:00
{
"Informative" : [
{
"short" : "h" ,
"long" : "help" ,
2026-04-16 18:27:11 +08:00
"desc" : "Show 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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Show the full Fastfetch version"
2023-11-20 16:37:59 +08:00
},
{
"long" : "version-raw" ,
2026-04-16 18:27:11 +08:00
"desc" : "Show 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" ,
2026-04-16 18:27:11 +08:00
"desc" : "List available presets" ,
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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Show available logos"
2023-11-20 16:37:59 +08:00
},
{
"long" : "print-structure" ,
2026-04-16 18:27:11 +08:00
"desc" : "Show the default structure"
2024-06-03 14:49:31 +08:00
},
{
"long" : "format" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the output format" ,
2024-06-03 14:49:31 +08:00
"arg" : {
"type" : "enum" ,
"enum" : {
"default" : "Default format" ,
"json" : "JSON format"
},
"default" : "default"
}
2025-09-28 15:07:45 +08:00
},
{
"long" : "json" ,
"short" : "j" ,
"arg" : {
"type" : "bool" ,
"default" : false ,
"optional" : true
},
"desc" : "Enable or disable JSON output" ,
"remark" : "Shortcut for `--format json`"
2025-11-05 10:00:31 +08:00
},
{
"long" : "dynamic-interval" ,
2026-04-16 18:27:11 +08:00
"desc" : "Keep Fastfetch running and refresh the output every <num> milliseconds" ,
"remark" : "Set to 0 (default) to disable this behavior; does not work with --json" ,
2025-11-05 10:00:31 +08:00
"arg" : {
"type" : "num" ,
"default" : 0
}
2026-07-28 10:52:04 +08:00
},
{
"long" : "watch" ,
"short" : "w" ,
"desc" : "Alias of dynamic-interval, but the value is in seconds instead of milliseconds. If no value is provided, it defaults to 1 second" ,
"arg" : {
"type" : "num" ,
"optional" : true ,
"default" : 1
}
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" ,
2026-04-16 18:27:11 +08:00
"remark" : "The file is searched in the order shown by \"fastfetch --list-config-paths\". Use \"-\" to read config from stdin, or \"none\" to disable further config loading. See also https://github.com/fastfetch-cli/fastfetch/wiki/Configuration for details" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "config"
}
},
{
"long" : "gen-config" ,
2026-08-04 10:41:26 +08:00
"desc" : "Interactively generate a config file at the specified path" ,
"remark" : "Opens an interactive configuration UI when run in a terminal. Falls back to non-interactive generation when env-var `$NO_COLOR` is set or stdin/stdout is not a TTY. Defaults to \"~/.config/fastfetch/config.jsonc\". Prints the generated config if <path> is \"-\"" ,
2023-11-20 16:37:59 +08:00
"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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Specify whether display detection should use DRM only" ,
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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Specify whether to detect and display versions for 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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the logo source. Use \"none\" to disable logo output" ,
"remark" : "Use either a built-in logo name 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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the type of logo specified by \"--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" : {
2026-04-16 18:27:11 +08:00
"auto" : "If a value is provided, try built-in first, then file. Otherwise auto-detect the logo" ,
2025-04-04 18:15:54 +08:00
"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" ,
2026-04-16 18:27:11 +08:00
"sixel" : "Image file, rendered as sixel" ,
"kitty" : "Image file, rendered using the Kitty graphics protocol" ,
2025-04-04 18:15:54 +08:00
"kitty-direct" : "Image file, tells the terminal emulator to read image data from the specified file" ,
2026-04-16 18:27:11 +08:00
"kitty-icat" : "Image file, displayed using `kitten icat`. Requires the `kitten` binary" ,
"iterm" : "Image file, rendered using the iTerm graphics protocol" ,
2025-04-04 18:15:54 +08:00
"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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Specify whether to print remaining logo lines when the logo is taller than the module list" ,
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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the display position of the logo" ,
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" ,
2026-04-16 18:27:11 +08:00
"remark" : "See the Chafa documentation for details" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "chafa-symbols" ,
"desc" : "Specify character symbols to employ in final output" ,
2026-04-16 18:27:11 +08:00
"remark" : "See the Chafa documentation for details" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "str"
}
},
{
"long" : "chafa-canvas-mode" ,
"desc" : "Determine how colors are used in the output" ,
2026-04-16 18:27:11 +08:00
"remark" : "This value maps to the integer value of enum ChafaCanvasMode. See the Chafa documentation for details" ,
2023-11-20 16:37:59 +08:00
"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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the color space used for quantization" ,
"remark" : "This value maps to the integer value of enum ChafaColorSpace. See the Chafa documentation for details" ,
2023-11-20 16:37:59 +08:00
"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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the output dithering mode (no effect with 24-bit color)" ,
"remark" : "This value maps to the integer value of enum ChafaDitherMode. See the Chafa documentation for details" ,
2023-11-20 16:37:59 +08:00
"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" ,
2026-04-16 18:27:11 +08:00
"remark" : "Must be a colon-separated list of module keys. Use \"fastfetch --list-modules\" to see available options" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "structure" ,
"default" : "\"fastfetch --print-structure\""
}
},
2026-01-15 10:35:01 +08:00
{
"long" : "structure-disabled" ,
"desc" : "Disable specific modules in the structure" ,
"remark" : "Must be a colon-separated list of keys" ,
"arg" : {
"type" : "structure"
}
},
2023-11-20 16:37:59 +08:00
{
"long" : "stat" ,
2026-04-16 18:27:11 +08:00
"desc" : "Show execution time (ms) for individual modules" ,
2023-11-20 16:37:59 +08:00
"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" ,
2026-04-16 18:27:11 +08:00
"remark" : "If true, output is shown as \"1h 2m\" instead of \"1 hour, 2 mins\"" ,
2025-07-30 14:30:36 +08:00
"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" ,
2026-04-16 18:27:11 +08:00
"icon" : "Show icon (requires a recent Nerd Font)" ,
2025-10-13 09:54:34 +08:00
"both" : "Show both icon and string (alias of `both-1`)" ,
"both-0" : "Show both icon and string with no spaces between them" ,
"both-1" : "Show both icon and string with a space between them" ,
"both-2" : "Show both icon and string with 2 spaces between them" ,
"both-3" : "Show both icon and string with 3 spaces between them" ,
"both-4" : "Show both icon and string with 4 spaces between them"
2024-07-24 11:13:37 +08:00
},
"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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the percentage output style" ,
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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the number of decimal places to use when formatting percentages" ,
2023-11-20 16:37:59 +08:00
"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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Specify the width of the percentage number, in characters" ,
2025-07-30 15:06:16 +08:00
"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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the character used for 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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the character used for 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" ,
2026-04-16 18:27:11 +08:00
"desc" : "If both bar-border-left-elapsed and bar-border-right-elapsed are set, the border is used as part of the bar content" ,
2025-08-01 10:51:26 +08:00
"arg" : {
"type" : "string" ,
"default" : ""
}
},
{
"long" : "bar-border-right-elapsed" ,
2026-04-16 18:27:11 +08:00
"desc" : "If both bar-border-left-elapsed and bar-border-right-elapsed are set, the border is used as part of the bar content" ,
2025-08-01 10:51:26 +08:00
"arg" : {
"type" : "string" ,
"default" : ""
}
},
2025-08-01 13:50:02 +08:00
{
"long" : "bar-color-elapsed" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the color used for the elapsed part of percentage bars" ,
"remark" : "By default, this is auto-selected by percent-color-{green,yellow,red}" ,
2025-08-01 13:50:02 +08:00
"arg" : {
"type" : "color" ,
"default" : "<auto>"
}
},
{
"long" : "bar-color-total" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the color used for the total part of percentage bars" ,
2025-08-01 13:50:02 +08:00
"arg" : {
"type" : "color" ,
"default" : "light_white"
}
},
{
"long" : "bar-color-border" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the color used for percentage bar borders" ,
2025-08-01 13:50:02 +08:00
"arg" : {
"type" : "color" ,
"default" : "light_white"
}
},
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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Specify whether stdout buffering should be disabled" ,
2023-11-20 16:37:59 +08:00
"arg" : {
"type" : "bool" ,
"optional" : true ,
"default" : false
}
},
{
"long" : "size-ndigits" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the number of decimal places to use when formatting sizes" ,
2023-11-20 16:37:59 +08:00
"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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the number of decimal places to use 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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the number of decimal places to use when printing fractional values" ,
2025-07-16 10:30:45 +08:00
"remark" : "If negative, the number of digits will be automatically determined based on the value" ,
"arg" : {
"type" : "num" ,
"default" : -1
}
},
2025-09-03 14:20:23 +08:00
{
"long" : "fraction-trailing-zeros" ,
"desc" : "Set when to keep trailing zeros" ,
"arg" : {
"type" : "enum" ,
"enum" : {
2026-04-16 18:27:11 +08:00
"default" : "Use the built-in behavior" ,
2025-09-03 14:20:23 +08:00
"always" : "Always keep trailing zeros" ,
"never" : "Never keep trailing zeros"
}
}
},
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" ,
2026-04-16 18:27:11 +08:00
"desc" : "Set the number of decimal places to use when printing temperatures" ,
2024-02-26 10:46:13 +08:00
"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
}
]
}
