Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Json Schema

李通洲 edited this pageDec 18, 2025 ·38 revisions

JSON config

Title: JSON config

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: JSON config file for fastfetch. Usually located at~/.config/fastfetch/config.jsonc

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-$schemaNostringNo-JSON schema URL, for JSON validation and IDE intelligence
-logoNoCombinationNo-Fastfetch logo configurations
See alsohttps://github.com/fastfetch-cli/fastfetch/wiki/Logo-options
-generalNoobjectNo-Fastfetch general configurations
-displayNoobjectNo-Configure how things should be displayed
-modulesNoarrayNo-Fastfetch modules to run

1. PropertyJSON config > $schema

Typestring
RequiredNo
Formaturi
Default"https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json"

Description: JSON schema URL, for JSON validation and IDE intelligence

2. PropertyJSON config > logo

Typecombining
RequiredNo
Additional propertiesAny type allowed

Description: Fastfetch logo configurationsSee alsohttps://github.com/fastfetch-cli/fastfetch/wiki/Logo-options

One of(Option)
item 0
item 1
item 2

2.1. PropertyJSON config > logo > oneOf > item 0

Typeconst
RequiredNo

Description: Disable logo

Specific value:null

2.2. PropertyJSON config > logo > oneOf > item 1

Typestring
RequiredNo

Description: Set the source file of the logo or built-in ASCII art name

2.3. PropertyJSON config > logo > oneOf > item 2

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Fastfetch logo configurations

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoCombinationNo-Set the type of the logo
-sourceNostringNo-Set the source file of the logo
-colorNoobjectNo-Override colors in the logo
-widthNoCombinationNo--
-heightNoCombinationNo--
-paddingNoobjectNo-Set the padding of the logo
-printRemainingNobooleanNo-Whether to print the remaining logo if it has more lines than modules to display
-preserveAspectRatioNobooleanNo-Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol only
-recacheNobooleanNo-If true, regenerate image logo cache
-positionNoenum (of string)No-Set the position where the logo should be displayed
-chafaNoobjectNo-Chafa configuration. See chafa documentation for details

2.3.1. PropertyJSON config > logo > oneOf > item 2 > type

Typecombining
RequiredNo
Additional propertiesAny type allowed
Default"auto"

Description: Set the type of the logo

One of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
item 6
item 7
item 8
item 9
item 10
item 11
item 12
item 13
item 14
2.3.1.1. PropertyJSON config > logo > oneOf > item 2 > type > oneOf > item 0
Typeconst
RequiredNo

Description: If something is given, first try built-in, then file. Otherwise detect logo

Specific value:"auto"

2.3.1.2. PropertyJSON config > logo > oneOf > item 2 > type > oneOf > item 1
Typeconst
RequiredNo

Description: Built-in ASCII art

Specific value:"builtin"

2.3.1.3. PropertyJSON config > logo > oneOf > item 2 > type > oneOf > item 2
Typeconst
RequiredNo

Description: Built-in ASCII art, small version (not all logos support this option)

Specific value:"small"

2.3.1.4. PropertyJSON config > logo > oneOf > item 2 > type > oneOf > item 3
Typeconst
RequiredNo

Description: Text file, printed with color code replacement

Specific value:"file"

2.3.1.5. PropertyJSON config > logo > oneOf > item 2 > type > oneOf > item 4
Typeconst
RequiredNo

Description: Text file, printed as is

Specific value:"file-raw"

2.3.1.6. PropertyJSON config > logo > oneOf > item 2 > type > oneOf > item 5
Typeconst
RequiredNo

Description: Text data, printed with color code replacement

Specific value:"data"

2.3.1.7. PropertyJSON config > logo > oneOf > item 2 > type > oneOf > item 6
Typeconst
RequiredNo

Description: Text data, printed as is

Specific value:"data-raw"

2.3.1.8. PropertyJSON config > logo > oneOf > item 2 > type > oneOf > item 7
Typeconst
RequiredNo

Description: Image file, printed as sixel codes

Specific value:"sixel"

2.3.1.9. PropertyJSON config > logo > oneOf > item 2 > type > oneOf > item 8
Typeconst
RequiredNo

Description: Image file, printed using kitty graphics protocol

Specific value:"kitty"

2.3.1.10. PropertyJSON config > logo > oneOf > item 2 > type > oneOf > item 9
Typeconst
RequiredNo

Description: Image file, tells the terminal emulator to read image data from the specified file

Specific value:"kitty-direct"

2.3.1.11. PropertyJSON config > logo > oneOf > item 2 > type > oneOf > item 10
Typeconst
RequiredNo

Description: Image file, useskitten icat to display the image. Requires binarykitten to be installed

Specific value:"kitty-icat"

2.3.1.12. PropertyJSON config > logo > oneOf > item 2 > type > oneOf > item 11
Typeconst
RequiredNo

Description: Image file, usesiTerm image protocol

Specific value:"iterm"

2.3.1.13. PropertyJSON config > logo > oneOf > item 2 > type > oneOf > item 12
Typeconst
RequiredNo

Description: Image file, printsASCII art image generated bylibchafa

Specific value:"chafa"

2.3.1.14. PropertyJSON config > logo > oneOf > item 2 > type > oneOf > item 13
Typeconst
RequiredNo

Description: Image file, printed asraw binary string image

Specific value:"raw"

2.3.1.15. PropertyJSON config > logo > oneOf > item 2 > type > oneOf > item 14
Typeconst
RequiredNo

Description: Disable logo printing

Specific value:"none"

2.3.2. PropertyJSON config > logo > oneOf > item 2 > source

Typestring
RequiredNo

Description: Set the source file of the logo

2.3.3. PropertyJSON config > logo > oneOf > item 2 > color

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Override colors in the logo

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-1NoobjectNoIn #/$defs/colorsColor 1
-2NoobjectNoSame as1Color 2
-3NoobjectNoSame as1Color 3
-4NoobjectNoSame as1Color 4
-5NoobjectNoSame as1Color 5
-6NoobjectNoSame as1Color 6
-7NoobjectNoSame as1Color 7
-8NoobjectNoSame as1Color 8
-9NoobjectNoSame as1Color 9
2.3.3.1. PropertyJSON config > logo > oneOf > item 2 > color > 1
Typecombining
RequiredNo
Additional propertiesAny type allowed
Defined in#/$defs/colors

Description: Color 1

One of(Option)
item 0
item 1
2.3.3.1.1. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Typestring
RequiredNo

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
2.3.3.1.2. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Typenull
RequiredNo
2.3.3.2. PropertyJSON config > logo > oneOf > item 2 > color > 2
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition as1

Description: Color 2

2.3.3.3. PropertyJSON config > logo > oneOf > item 2 > color > 3
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition as1

Description: Color 3

2.3.3.4. PropertyJSON config > logo > oneOf > item 2 > color > 4
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition as1

Description: Color 4

2.3.3.5. PropertyJSON config > logo > oneOf > item 2 > color > 5
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition as1

Description: Color 5

2.3.3.6. PropertyJSON config > logo > oneOf > item 2 > color > 6
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition as1

Description: Color 6

2.3.3.7. PropertyJSON config > logo > oneOf > item 2 > color > 7
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition as1

Description: Color 7

2.3.3.8. PropertyJSON config > logo > oneOf > item 2 > color > 8
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition as1

Description: Color 8

2.3.3.9. PropertyJSON config > logo > oneOf > item 2 > color > 9
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition as1

Description: Color 9

2.3.4. PropertyJSON config > logo > oneOf > item 2 > width

Typecombining
RequiredNo
Additional propertiesAny type allowed
One of(Option)
item 0
item 1
2.3.4.1. PropertyJSON config > logo > oneOf > item 2 > width > oneOf > item 0
Typenull
RequiredNo

Description: Auto detect width (default)

2.3.4.2. PropertyJSON config > logo > oneOf > item 2 > width > oneOf > item 1
Typeinteger
RequiredNo

Description: Set the width of the logo (in characters). Required for some image protocols

Restrictions
Minimum≥ 1

2.3.5. PropertyJSON config > logo > oneOf > item 2 > height

Typecombining
RequiredNo
Additional propertiesAny type allowed
One of(Option)
item 0
item 1
2.3.5.1. PropertyJSON config > logo > oneOf > item 2 > height > oneOf > item 0
Typenull
RequiredNo

Description: Auto detect width (default)

2.3.5.2. PropertyJSON config > logo > oneOf > item 2 > height > oneOf > item 1
Typeinteger
RequiredNo

Description: Set the height of the logo (in characters). Required for some image protocols

Restrictions
Minimum≥ 1

2.3.6. PropertyJSON config > logo > oneOf > item 2 > padding

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Set the padding of the logo

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-topNointegerNo-Set the top padding of the logo
-leftNointegerNo-Set the left padding of the logo
-rightNointegerNo-Set the right padding of the logo
2.3.6.1. PropertyJSON config > logo > oneOf > item 2 > padding > top
Typeinteger
RequiredNo

Description: Set the top padding of the logo

Restrictions
Minimum≥ 0
2.3.6.2. PropertyJSON config > logo > oneOf > item 2 > padding > left
Typeinteger
RequiredNo

Description: Set the left padding of the logo

Restrictions
Minimum≥ 0
2.3.6.3. PropertyJSON config > logo > oneOf > item 2 > padding > right
Typeinteger
RequiredNo

Description: Set the right padding of the logo

Restrictions
Minimum≥ 0

2.3.7. PropertyJSON config > logo > oneOf > item 2 > printRemaining

Typeboolean
RequiredNo
Defaulttrue

Description: Whether to print the remaining logo if it has more lines than modules to display

2.3.8. PropertyJSON config > logo > oneOf > item 2 > preserveAspectRatio

Typeboolean
RequiredNo
Defaultfalse

Description: Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol only

2.3.9. PropertyJSON config > logo > oneOf > item 2 > recache

Typeboolean
RequiredNo
Defaultfalse

Description: If true, regenerate image logo cache

2.3.10. PropertyJSON config > logo > oneOf > item 2 > position

Typeenum (of string)
RequiredNo
Default"left"

Description: Set the position where the logo should be displayed

Must be one of:

  • "left"
  • "top"
  • "right"

2.3.11. PropertyJSON config > logo > oneOf > item 2 > chafa

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Chafa configuration. See chafa documentation for details

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-fgOnlyNobooleanNo-Produce character-cell output using foreground colors only
-symbolsNostringNo-Specify character symbols to employ in final output
-canvasModeNoCombinationNo-Determine how colors are used in the output. This value maps to enum ChafaCanvasMode.
-colorSpaceNoCombinationNo-Set color space used for quantization. This value maps to enum ChafaColorSpace.
-ditherModeNoCombinationNo-Set output dither mode (No effect with 24-bit color). This value maps to enum ChafaDitherMode.
2.3.11.1. PropertyJSON config > logo > oneOf > item 2 > chafa > fgOnly
Typeboolean
RequiredNo
Defaultfalse

Description: Produce character-cell output using foreground colors only

2.3.11.2. PropertyJSON config > logo > oneOf > item 2 > chafa > symbols
Typestring
RequiredNo

Description: Specify character symbols to employ in final output

2.3.11.3. PropertyJSON config > logo > oneOf > item 2 > chafa > canvasMode
Typecombining
RequiredNo

Description: Determine how colors are used in the output. This value maps to enum ChafaCanvasMode.

One of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
item 6
item 7
2.3.11.3.1. PropertyJSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 0
Typeconst
RequiredNo

Description: Use 24-bit true colors

Specific value:"TRUECOLOR"

2.3.11.3.2. PropertyJSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 1
Typeconst
RequiredNo

Description: Use 256 colors

Specific value:"INDEXED_256"

2.3.11.3.3. PropertyJSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 2
Typeconst
RequiredNo

Description: Use 240 colors, but avoid using the lower 16 whose values vary between terminal environments

Specific value:"INDEXED_240"

2.3.11.3.4. PropertyJSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 3
Typeconst
RequiredNo

Description: Use 16 colors using the aixterm ANSI extension

Specific value:"INDEXED_16"

2.3.11.3.5. PropertyJSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 4
Typeconst
RequiredNo

Description: Use default foreground and background colors, plus inversion

Specific value:"FGBG_BGFG"

2.3.11.3.6. PropertyJSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 5
Typeconst
RequiredNo

Description: Use default foreground and background colors. No ANSI codes will be used

Specific value:"FGBG"

2.3.11.3.7. PropertyJSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 6
Typeconst
RequiredNo

Description: Use 8 colors, compatible with original ANSI X3.64

Specific value:"INDEXED_8"

2.3.11.3.8. PropertyJSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 7
Typeconst
RequiredNo

Description: Use 16 FG colors (8 of which enabled with bold/bright) and 8 BG colors

Specific value:"INDEXED_16_8"

2.3.11.4. PropertyJSON config > logo > oneOf > item 2 > chafa > colorSpace
Typecombining
RequiredNo

Description: Set color space used for quantization. This value maps to enum ChafaColorSpace.

One of(Option)
item 0
item 1
2.3.11.4.1. PropertyJSON config > logo > oneOf > item 2 > chafa > colorSpace > oneOf > item 0
Typeconst
RequiredNo

Description: RGB color space. Fast but imprecise

Specific value:"RGB"

2.3.11.4.2. PropertyJSON config > logo > oneOf > item 2 > chafa > colorSpace > oneOf > item 1
Typeconst
RequiredNo

Description: DIN99d color space. Slower, but good perceptual color precision

Specific value:"DIN99D"

2.3.11.5. PropertyJSON config > logo > oneOf > item 2 > chafa > ditherMode
Typecombining
RequiredNo

Description: Set output dither mode (No effect with 24-bit color). This value maps to enum ChafaDitherMode.

One of(Option)
item 0
item 1
item 2
2.3.11.5.1. PropertyJSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 0
Typeconst
RequiredNo

Description: No dithering

Specific value:"NONE"

2.3.11.5.2. PropertyJSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 1
Typeconst
RequiredNo

Description: Ordered dithering (Bayer or similar)

Specific value:"ORDERED"

2.3.11.5.3. PropertyJSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 2
Typeconst
RequiredNo

Description: Error diffusion dithering (Floyd-Steinberg or similar)

Specific value:"DIFFUSION"

3. PropertyJSON config > general

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Fastfetch general configurations

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-threadNobooleanNo-Use separate threads for HTTP requests
-escapeBedrockNobooleanNo-On Bedrock Linux, whether to escape the bedrock jail
-playerNameNostringNo-The name of the player to use for Media and Player modules. Linux only
-dsForceDrmNoCombinationNo-Force display detection to use DRM. Linux only
-wmiTimeoutNointegerNo-Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only
-processingTimeoutNointegerNo-Set the timeout (ms) when waiting for child processes, `-1` for no timeout
-preRunNostringNo-Set the command to be executed before printing logos
-detectVersionNobooleanNo-Whether to detect and display component versions. Mainly for benchmarking

3.1. PropertyJSON config > general > thread

Typeboolean
RequiredNo
Defaulttrue

Description: Use separate threads for HTTP requests

3.2. PropertyJSON config > general > escapeBedrock

Typeboolean
RequiredNo
Defaulttrue

Description: On Bedrock Linux, whether to escape the bedrock jail

3.3. PropertyJSON config > general > playerName

Typestring
RequiredNo

Description: The name of the player to use for Media and Player modules. Linux only

3.4. PropertyJSON config > general > dsForceDrm

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultfalse

Description: Force display detection to use DRM. Linux only

One of(Option)
item 0
item 1
item 2

3.4.1. PropertyJSON config > general > dsForceDrm > oneOf > item 0

Typeconst
RequiredNo

Description: Trywayland, thenx11, thendrm

Specific value:false

3.4.2. PropertyJSON config > general > dsForceDrm > oneOf > item 1

Typeconst
RequiredNo

Description: Use/sys/class/drm only

Specific value:"sysfs-only"

3.4.3. PropertyJSON config > general > dsForceDrm > oneOf > item 2

Typeconst
RequiredNo

Description: Trylibdrm first, thensysfs if libdrm fails

Specific value:true

3.5. PropertyJSON config > general > wmiTimeout

Typeinteger
RequiredNo
Default5000

Description: Set the timeout (ms) for WMI queries,-1 for no timeout. Windows only

3.6. PropertyJSON config > general > processingTimeout

Typeinteger
RequiredNo
Default5000

Description: Set the timeout (ms) when waiting for child processes,-1 for no timeout

3.7. PropertyJSON config > general > preRun

Typestring
RequiredNo
Default""

Description: Set the command to be executed before printing logos

3.8. PropertyJSON config > general > detectVersion

Typeboolean
RequiredNo
Defaulttrue

Description: Whether to detect and display component versions. Mainly for benchmarking

4. PropertyJSON config > display

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Configure how things should be displayed

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-statNoCombinationNo-Show time usage (in ms) for individual modules with optional threshold
-pipeNobooleanNo-Whether to disable colors (auto-detected based on isatty(1) by default)
-showErrorsNobooleanNo-Print occurring errors to the console. False to ignore errored modules
-disableLinewrapNobooleanNo-Whether to disable line wrap during execution
-hideCursorNobooleanNo-Whether to hide the cursor during execution
-separatorNostringNo-Set the separator between key and value
-colorNoCombinationNo-Set the color of the keys and title
-brightColorNobooleanNo-Set if the keys, title and ASCII logo should be printed in bright color
-keyNoobjectNo-Set how module keys should be displayed
-sizeNoobjectNo-Set how size values should be displayed
-tempNoobjectNo-Set how temperature values should be displayed
-barNoobjectNo-Set the bar configuration
-percentNoobjectNo-Set how percentage values should be displayed
-freqNoobjectNo-Set how frequency values should be displayed
-durationNoobjectNo-Set how duration values should be displayed
-fractionNoobjectNo-Set how ordinary fraction numbers should be displayed
-noBufferNobooleanNo-Whether to disable the stdout application buffer
-constantsNoarray of stringNo-List of strings to be used in custom format of modules

4.1. PropertyJSON config > display > stat

Typecombining
RequiredNo
Additional propertiesAny type allowed

Description: Show time usage (in ms) for individual modules with optional threshold

One of(Option)
item 0
item 1

4.1.1. PropertyJSON config > display > stat > oneOf > item 0

Typeboolean
RequiredNo
Defaultfalse

4.1.2. PropertyJSON config > display > stat > oneOf > item 1

Typeinteger
RequiredNo
Restrictions
Minimum≥ 1

4.2. PropertyJSON config > display > pipe

Typeboolean
RequiredNo
Defaultfalse

Description: Whether to disable colors (auto-detected based on isatty(1) by default)

4.3. PropertyJSON config > display > showErrors

Typeboolean
RequiredNo
Defaultfalse

Description: Print occurring errors to the console. False to ignore errored modules

4.4. PropertyJSON config > display > disableLinewrap

Typeboolean
RequiredNo
Defaulttrue

Description: Whether to disable line wrap during execution

4.5. PropertyJSON config > display > hideCursor

Typeboolean
RequiredNo
Defaulttrue

Description: Whether to hide the cursor during execution

4.6. PropertyJSON config > display > separator

Typestring
RequiredNo
Default": "

Description: Set the separator between key and value

4.7. PropertyJSON config > display > color

Typecombining
RequiredNo
Additional propertiesAny type allowed

Description: Set the color of the keys and title

One of(Option)
colors
item 1

4.7.1. PropertyJSON config > display > color > oneOf > colors

Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition as1

Description: Set both the colors of keys and title

4.7.2. PropertyJSON config > display > color > oneOf > item 1

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-keysNoobjectNoSame as1Set the color of the keys
-titleNoobjectNoSame as1Set the color of the title
-outputNoobjectNoSame as1Set the color of the module output
-separatorNoobjectNoSame as1Set the color of the key-value separator
4.7.2.1. PropertyJSON config > display > color > oneOf > item 1 > keys
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition as1

Description: Set the color of the keys

4.7.2.2. PropertyJSON config > display > color > oneOf > item 1 > title
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition as1

Description: Set the color of the title

4.7.2.3. PropertyJSON config > display > color > oneOf > item 1 > output
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition as1

Description: Set the color of the module output

4.7.2.4. PropertyJSON config > display > color > oneOf > item 1 > separator
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition as1

Description: Set the color of the key-value separator

4.8. PropertyJSON config > display > brightColor

Typeboolean
RequiredNo
Defaulttrue

Description: Set if the keys, title and ASCII logo should be printed in bright color

4.9. PropertyJSON config > display > key

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Set how module keys should be displayed

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-widthNointegerNo-Align the width of keys to number of characters, 0 to disable
-typeNoCombinationNo-Set whether to show builtin icon before string keys
-paddingLeftNointegerNo-Set the left padding of keys

4.9.1. PropertyJSON config > display > key > width

Typeinteger
RequiredNo
Default0

Description: Align the width of keys to number of characters, 0 to disable

Restrictions
Minimum≥ 0

4.9.2. PropertyJSON config > display > key > type

Typecombining
RequiredNo
Default"string"

Description: Set whether to show builtin icon before string keys

One of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
item 6
item 7
item 8
4.9.2.1. PropertyJSON config > display > key > type > oneOf > item 0
Typeconst
RequiredNo

Description: Disable keys

Specific value:"none"

4.9.2.2. PropertyJSON config > display > key > type > oneOf > item 1
Typeconst
RequiredNo

Description: Show string keys

Specific value:"string"

4.9.2.3. PropertyJSON config > display > key > type > oneOf > item 2
Typeconst
RequiredNo

Description: Show builtin icon (requires newest nerd font)

Specific value:"icon"

4.9.2.4. PropertyJSON config > display > key > type > oneOf > item 3
Typeconst
RequiredNo

Description: Show both icon and string keys (alias ofboth-1)

Specific value:"both"

4.9.2.5. PropertyJSON config > display > key > type > oneOf > item 4
Typeconst
RequiredNo

Description: Show both icon and string with no spaces between them

Specific value:"both-0"

4.9.2.6. PropertyJSON config > display > key > type > oneOf > item 5
Typeconst
RequiredNo

Description: Show both icon and string with a space between them

Specific value:"both-1"

4.9.2.7. PropertyJSON config > display > key > type > oneOf > item 6
Typeconst
RequiredNo

Description: Show both icon and string with 2 spaces between them

Specific value:"both-2"

4.9.2.8. PropertyJSON config > display > key > type > oneOf > item 7
Typeconst
RequiredNo

Description: Show both icon and string with 3 spaces between them

Specific value:"both-3"

4.9.2.9. PropertyJSON config > display > key > type > oneOf > item 8
Typeconst
RequiredNo

Description: Show both icon and string with 4 spaces between them

Specific value:"both-4"

4.9.3. PropertyJSON config > display > key > paddingLeft

Typeinteger
RequiredNo
Default0

Description: Set the left padding of keys

Restrictions
Minimum≥ 0

4.10. PropertyJSON config > display > size

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Set how size values should be displayed

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-binaryPrefixNoCombinationNo-Set the binary prefix to use when formatting sizes
-maxPrefixNoenum (of string)No-Set the largest binary prefix to use when formatting sizes
-ndigitsNointegerNo-Set the number of digits to keep after the decimal point when formatting sizes
-spaceBeforeUnitNostringNoIn #/$defs/spaceBeforeUnitWhether to put a space before the unit

4.10.1. PropertyJSON config > display > size > binaryPrefix

Typecombining
RequiredNo
Default"iec"

Description: Set the binary prefix to use when formatting sizes

One of(Option)
item 0
item 1
item 2
4.10.1.1. PropertyJSON config > display > size > binaryPrefix > oneOf > item 0
Typeconst
RequiredNo

Description: 1024 Bytes = 1 KiB, 1024 KiB = 1 MiB, ... (standard)

Specific value:"iec"

4.10.1.2. PropertyJSON config > display > size > binaryPrefix > oneOf > item 1
Typeconst
RequiredNo

Description: 1000 Bytes = 1 kB, 1000 kB = 1 MB, ...

Specific value:"si"

4.10.1.3. PropertyJSON config > display > size > binaryPrefix > oneOf > item 2
Typeconst
RequiredNo

Description: 1024 Bytes = 1 KB, 1024 KB = 1 MB, ...

Specific value:"jedec"

4.10.2. PropertyJSON config > display > size > maxPrefix

Typeenum (of string)
RequiredNo
Default"YB"

Description: Set the largest binary prefix to use when formatting sizes

Must be one of:

  • "B"
  • "kB"
  • "MB"
  • "GB"
  • "TB"
  • "PB"
  • "EB"
  • "ZB"
  • "YB"

4.10.3. PropertyJSON config > display > size > ndigits

Typeinteger
RequiredNo
Default2

Description: Set the number of digits to keep after the decimal point when formatting sizes

Restrictions
Minimum≥ 0
Maximum≤ 9

4.10.4. PropertyJSON config > display > size > spaceBeforeUnit

Typecombining
RequiredNo
Defined in#/$defs/spaceBeforeUnit

Description: Whether to put a space before the unit

One of(Option)
item 0
item 1
item 2
4.10.4.1. PropertyJSON config > display > size > spaceBeforeUnit > oneOf > item 0
Typeconst
RequiredNo

Description: Use the default behavior of the module

Specific value:"default"

4.10.4.2. PropertyJSON config > display > size > spaceBeforeUnit > oneOf > item 1
Typeconst
RequiredNo

Description: Always add a space before the unit

Specific value:"always"

4.10.4.3. PropertyJSON config > display > size > spaceBeforeUnit > oneOf > item 2
Typeconst
RequiredNo

Description: Never add a space before the unit

Specific value:"never"

4.11. PropertyJSON config > display > temp

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Set how temperature values should be displayed

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-unitNoCombinationNo-Set the unit of temperature
-ndigitsNointegerNo-Set the number of digits to keep after the decimal point when formatting temperature values
-colorNoobjectNo-Set colors used in different states of temperature values
-spaceBeforeUnitNostringNoSame asspaceBeforeUnitWhether to put a space before the unit

4.11.1. PropertyJSON config > display > temp > unit

Typecombining
RequiredNo
Default"D"

Description: Set the unit of temperature

One of(Option)
item 0
item 1
item 2
item 3
4.11.1.1. PropertyJSON config > display > temp > unit > oneOf > item 0
Typeconst
RequiredNo

Description: Celsius

Specific value:"C"

4.11.1.2. PropertyJSON config > display > temp > unit > oneOf > item 1
Typeconst
RequiredNo

Description: Fahrenheit

Specific value:"F"

4.11.1.3. PropertyJSON config > display > temp > unit > oneOf > item 2
Typeconst
RequiredNo

Description: Kelvin

Specific value:"K"

4.11.1.4. PropertyJSON config > display > temp > unit > oneOf > item 3
Typeconst
RequiredNo

Description: Default (alias for Celsius)

Specific value:"D"

4.11.2. PropertyJSON config > display > temp > ndigits

Typeinteger
RequiredNo
Default1

Description: Set the number of digits to keep after the decimal point when formatting temperature values

Restrictions
Minimum≥ 0
Maximum≤ 9

4.11.3. PropertyJSON config > display > temp > color

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Set colors used in different states of temperature values

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-greenNoobjectNoIn #/$defs/colorsColor used in green state
-yellowNoobjectNoIn #/$defs/colorsColor used in yellow state
-redNoobjectNoIn #/$defs/colorsColor used in red state
4.11.3.1. PropertyJSON config > display > temp > color > green
Typecombining
RequiredNo
Additional propertiesAny type allowed
Default"green"
Defined in#/$defs/colors

Description: Color used in green state

One of(Option)
item 0
item 1
4.11.3.1.1. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Typestring
RequiredNo

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.11.3.1.2. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Typenull
RequiredNo
4.11.3.2. PropertyJSON config > display > temp > color > yellow
Typecombining
RequiredNo
Additional propertiesAny type allowed
Default"light_yellow"
Defined in#/$defs/colors

Description: Color used in yellow state

One of(Option)
item 0
item 1
4.11.3.2.1. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Typestring
RequiredNo

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.11.3.2.2. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Typenull
RequiredNo
4.11.3.3. PropertyJSON config > display > temp > color > red
Typecombining
RequiredNo
Additional propertiesAny type allowed
Default"light_red"
Defined in#/$defs/colors

Description: Color used in red state

One of(Option)
item 0
item 1
4.11.3.3.1. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Typestring
RequiredNo

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.11.3.3.2. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Typenull
RequiredNo

4.11.4. PropertyJSON config > display > temp > spaceBeforeUnit

Typecombining
RequiredNo
Same definition asspaceBeforeUnit

Description: Whether to put a space before the unit

4.12. PropertyJSON config > display > bar

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Set the bar configuration

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-charNoobjectNo-Set the characters used in the bar
-borderNoCombinationNo--
-colorNoCombinationNo--
-widthNointegerNo-Set the width of the bar, in number of characters

4.12.1. PropertyJSON config > display > bar > char

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Set the characters used in the bar

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-elapsedNostringNo-Set the character to use in elapsed part
-totalNostringNo-Set the character to use in total part
4.12.1.1. PropertyJSON config > display > bar > char > elapsed
Typestring
RequiredNo
Default"■"

Description: Set the character to use in elapsed part

4.12.1.2. PropertyJSON config > display > bar > char > total
Typestring
RequiredNo
Default"-"

Description: Set the character to use in total part

4.12.2. PropertyJSON config > display > bar > border

Typecombining
RequiredNo
Additional propertiesAny type allowed
One of(Option)
item 0
item 1
4.12.2.1. PropertyJSON config > display > bar > border > oneOf > item 0
Typenull
RequiredNo

Description: Disable bar borders

4.12.2.2. PropertyJSON config > display > bar > border > oneOf > item 1
Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Set the string to use of borders of percentage bars

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-leftNostringNo-Set the string to use at left border
-rightNostringNo-Set the string to use at right border
-leftElapsedNostringNo-If both leftElapsed and rightElapsed are set, the border will be used as parts of bar content
-rightElapsedNostringNo-If both leftElapsed and rightElapsed are set, the border will be used as parts of bar content
4.12.2.2.1. PropertyJSON config > display > bar > border > oneOf > item 1 > left
Typestring
RequiredNo
Default"[ "

Description: Set the string to use at left border

4.12.2.2.2. PropertyJSON config > display > bar > border > oneOf > item 1 > right
Typestring
RequiredNo
Default" ]"

Description: Set the string to use at right border

4.12.2.2.3. PropertyJSON config > display > bar > border > oneOf > item 1 > leftElapsed
Typestring
RequiredNo
Default""

Description: If both leftElapsed and rightElapsed are set, the border will be used as parts of bar content

4.12.2.2.4. PropertyJSON config > display > bar > border > oneOf > item 1 > rightElapsed
Typestring
RequiredNo
Default""

Description: If both leftElapsed and rightElapsed are set, the border will be used as parts of bar content

4.12.3. PropertyJSON config > display > bar > color

Typecombining
RequiredNo
Additional propertiesAny type allowed
One of(Option)
item 0
item 1
4.12.3.1. PropertyJSON config > display > bar > color > oneOf > item 0
Typenull
RequiredNo

Description: Disable color in percentage bars

4.12.3.2. PropertyJSON config > display > bar > color > oneOf > item 1
Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Set the color to use of percentage bars

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-elapsedNoobjectNoIn #/$defs/colorsColor to use in the elapsed part of percentage bars
By default, auto selected by percent.color.{green,yellow,red}
-totalNoobjectNoIn #/$defs/colorsColor to use in the total part of percentage bars
-borderNoobjectNoIn #/$defs/colorsColor to use in the borders of percentage bars
4.12.3.2.1. PropertyJSON config > display > bar > color > oneOf > item 1 > elapsed
Typecombining
RequiredNo
Additional propertiesAny type allowed
Default"auto"
Defined in#/$defs/colors

Description: Color to use in the elapsed part of percentage barsBy default, auto selected by percent.color.{green,yellow,red}

One of(Option)
item 0
item 1
4.12.3.2.1.1. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Typestring
RequiredNo

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.12.3.2.1.2. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Typenull
RequiredNo
4.12.3.2.2. PropertyJSON config > display > bar > color > oneOf > item 1 > total
Typecombining
RequiredNo
Additional propertiesAny type allowed
Default"light_white"
Defined in#/$defs/colors

Description: Color to use in the total part of percentage bars

One of(Option)
item 0
item 1
4.12.3.2.2.1. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Typestring
RequiredNo

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.12.3.2.2.2. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Typenull
RequiredNo
4.12.3.2.3. PropertyJSON config > display > bar > color > oneOf > item 1 > border
Typecombining
RequiredNo
Additional propertiesAny type allowed
Default"light_white"
Defined in#/$defs/colors

Description: Color to use in the borders of percentage bars

One of(Option)
item 0
item 1
4.12.3.2.3.1. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Typestring
RequiredNo

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.12.3.2.3.2. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Typenull
RequiredNo

4.12.4. PropertyJSON config > display > bar > width

Typeinteger
RequiredNo
Default10

Description: Set the width of the bar, in number of characters

Restrictions
Minimum≥ 1

4.13. PropertyJSON config > display > percent

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Set how percentage values should be displayed

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoobjectNoIn #/$defs/percentTypeSet the percentage output type
-ndigitsNonumberNo-Set the number of digits to keep after the decimal point when formatting percentage numbers
-colorNoobjectNo-Set colors used in different states of percentage bars and numbers
-spaceBeforeUnitNostringNoSame asspaceBeforeUnitWhether to put a space before the unit
-widthNointegerNo-Set the width of the percentage number, in number of characters

4.13.1. PropertyJSON config > display > percent > type

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defined in#/$defs/percentType

Description: Set the percentage output type

One of(Option)
item 0
item 1
4.13.1.1. PropertyJSON config > display > percent > type > oneOf > item 0
Typenumber
RequiredNo
Default9

Description: 0 to use global setting, 1 for percentage number, 2 for multi-color bar, 3 for both, 6 for bar only, 9 for colored number, 10 for monochrome bar

Restrictions
Minimum≥ 0
Maximum≤ 255
4.13.1.2. PropertyJSON config > display > percent > type > oneOf > item 1
Typearray of enum (of string)
RequiredNo
Default["num", "num-color"]

Description: Array of string flags

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityTrue
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
item 1 items-
4.13.1.2.1. JSON config > display > percent > type > oneOf > item 1 > item 1 items
Typeenum (of string)
RequiredNo

Must be one of:

  • "num"
  • "bar"
  • "hide-others"
  • "num-color"
  • "bar-monochrome"

4.13.2. PropertyJSON config > display > percent > ndigits

Typenumber
RequiredNo
Default0

Description: Set the number of digits to keep after the decimal point when formatting percentage numbers

Restrictions
Minimum≥ 0
Maximum≤ 9

4.13.3. PropertyJSON config > display > percent > color

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Set colors used in different states of percentage bars and numbers

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-greenNoobjectNoIn #/$defs/colorsColor used in green state
-yellowNoobjectNoIn #/$defs/colorsColor used in yellow state
-redNoobjectNoIn #/$defs/colorsColor used in red state
4.13.3.1. PropertyJSON config > display > percent > color > green
Typecombining
RequiredNo
Additional propertiesAny type allowed
Default"green"
Defined in#/$defs/colors

Description: Color used in green state

One of(Option)
item 0
item 1
4.13.3.1.1. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Typestring
RequiredNo

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.13.3.1.2. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Typenull
RequiredNo
4.13.3.2. PropertyJSON config > display > percent > color > yellow
Typecombining
RequiredNo
Additional propertiesAny type allowed
Default"light_yellow"
Defined in#/$defs/colors

Description: Color used in yellow state

One of(Option)
item 0
item 1
4.13.3.2.1. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Typestring
RequiredNo

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.13.3.2.2. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Typenull
RequiredNo
4.13.3.3. PropertyJSON config > display > percent > color > red
Typecombining
RequiredNo
Additional propertiesAny type allowed
Default"light_red"
Defined in#/$defs/colors

Description: Color used in red state

One of(Option)
item 0
item 1
4.13.3.3.1. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Typestring
RequiredNo

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.13.3.3.2. PropertyJSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Typenull
RequiredNo

4.13.4. PropertyJSON config > display > percent > spaceBeforeUnit

Typecombining
RequiredNo
Same definition asspaceBeforeUnit

Description: Whether to put a space before the unit

4.13.5. PropertyJSON config > display > percent > width

Typeinteger
RequiredNo
Default0

Description: Set the width of the percentage number, in number of characters

Restrictions
Minimum≥ 0

4.14. PropertyJSON config > display > freq

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Set how frequency values should be displayed

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-ndigitsNoCombinationNo-Set the number of decimal places to display when formatting frequency values
-spaceBeforeUnitNostringNoSame asspaceBeforeUnitWhether to put a space before the unit

4.14.1. PropertyJSON config > display > freq > ndigits

Typecombining
RequiredNo
Additional propertiesAny type allowed
Default2

Description: Set the number of decimal places to display when formatting frequency values

One of(Option)
item 0
item 1
4.14.1.1. PropertyJSON config > display > freq > ndigits > oneOf > item 0
Typeinteger
RequiredNo

Description: Integer value displays the frequency in GHz with specified decimal places

Restrictions
Minimum≥ 0
Maximum≤ 9
4.14.1.2. PropertyJSON config > display > freq > ndigits > oneOf > item 1
Typenull
RequiredNo

Description: Null value display the frequency as integer MHz

4.14.2. PropertyJSON config > display > freq > spaceBeforeUnit

Typecombining
RequiredNo
Same definition asspaceBeforeUnit

Description: Whether to put a space before the unit

4.15. PropertyJSON config > display > duration

Typeobject
RequiredNo
Additional propertiesAny type allowed

Description: Set how duration values should be displayed

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-abbreviationNobooleanNo-Set whether to abbreviate duration values
If true, the output will be in the form of "1h 2m" instead of "1 hour, 2 mins"
-spaceBeforeUnitNostringNoSame asspaceBeforeUnitWhether to put a space before the unit

4.15.1. PropertyJSON config > display > duration > abbreviation

Typeboolean
RequiredNo
Defaultfalse

Description: Set whether to abbreviate duration valuesIf true, the output will be in the form of "1h 2m" instead of "1 hour, 2 mins"

4.15.2. PropertyJSON config > display > duration > spaceBeforeUnit

Typecombining
RequiredNo
Same definition asspaceBeforeUnit

Description: Whether to put a space before the unit

4.16. PropertyJSON config > display > fraction

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Set how ordinary fraction numbers should be displayed

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-ndigitsNoCombinationNo--
-trailingZerosNoCombinationNo-Set when to keep trailing zeros

4.16.1. PropertyJSON config > display > fraction > ndigits

Typecombining
RequiredNo
Additional propertiesAny type allowed
Default2
One of(Option)
item 0
item 1
4.16.1.1. PropertyJSON config > display > fraction > ndigits > oneOf > item 0
Typenumber
RequiredNo

Description: Set the number of digits to keep after the decimal point when formatting ordinary fraction numbers

Restrictions
Minimum≥ 0
Maximum≤ 9
4.16.1.2. PropertyJSON config > display > fraction > ndigits > oneOf > item 1
Typenull
RequiredNo

Description: The number of digits will be automatically determined based on the value

4.16.2. PropertyJSON config > display > fraction > trailingZeros

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Set when to keep trailing zeros

One of(Option)
item 0
item 1
item 2
item 3
4.16.2.1. PropertyJSON config > display > fraction > trailingZeros > oneOf > item 0
Typenull
RequiredNo

Description: Same asdefault

4.16.2.2. PropertyJSON config > display > fraction > trailingZeros > oneOf > item 1
Typeconst
RequiredNo

Description: Use the behavior defined internally

Specific value:"default"

4.16.2.3. PropertyJSON config > display > fraction > trailingZeros > oneOf > item 2
Typeconst
RequiredNo

Description: Always keep trailing zeros

Specific value:"always"

4.16.2.4. PropertyJSON config > display > fraction > trailingZeros > oneOf > item 3
Typeconst
RequiredNo

Description: Never keep trailing zeros

Specific value:"never"

4.17. PropertyJSON config > display > noBuffer

Typeboolean
RequiredNo
Defaultfalse

Description: Whether to disable the stdout application buffer

4.18. PropertyJSON config > display > constants

Typearray of string
RequiredNo

Description: List of strings to be used in custom format of modules

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
constants items-

4.18.1. JSON config > display > constants > constants items

Typestring
RequiredNo

5. PropertyJSON config > modules

Typearray
RequiredNo

Description: Fastfetch modules to run

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
modules items-

5.1. JSON config > modules > modules items

Typecombining
RequiredNo
Additional propertiesAny type allowed
Any of(Option)
item 0
item 1

5.1.1. PropertyJSON config > modules > modules items > anyOf > item 0

Typeenum (of string)
RequiredNo

Description: Run module with default configurations

Must be one of:

  • "battery"
  • "bios"
  • "bluetooth"
  • "bluetoothradio"
  • "board"
  • "bootmgr"
  • "break"
  • "brightness"
  • "btrfs"
  • "camera"
  • "chassis"
  • "cpu"
  • "cpucache"
  • "cpuusage"
  • "command"
  • "colors"
  • "cursor"
  • "datetime"
  • "display"
  • "disk"
  • "diskio"
  • "de"
  • "dns"
  • "editor"
  • "font"
  • "gamepad"
  • "gpu"
  • "host"
  • "icons"
  • "initsystem"
  • "keyboard"
  • "kernel"
  • "lm"
  • "loadavg"
  • "locale"
  • "localip"
  • "media"
  • "memory"
  • "monitor"
  • "mouse"
  • "netio"
  • "opencl"
  • "opengl"
  • "os"
  • "packages"
  • "physicaldisk"
  • "physicalmemory"
  • "player"
  • "poweradapter"
  • "processes"
  • "publicip"
  • "separator"
  • "shell"
  • "sound"
  • "swap"
  • "terminal"
  • "terminalfont"
  • "terminalsize"
  • "terminaltheme"
  • "title"
  • "theme"
  • "tpm"
  • "uptime"
  • "users"
  • "version"
  • "vulkan"
  • "wallpaper"
  • "weather"
  • "wm"
  • "wifi"
  • "wmtheme"
  • "zpool"

5.1.2. PropertyJSON config > modules > modules items > anyOf > item 1

Typecombining
RequiredNo
Additional propertiesAny type allowed

Description: Run module with custom configurations

PropertyPatternTypeDeprecatedDefinitionTitle/Description
+typeNostringNo--
One of(Option)
Break
Battery
BIOS
Bluetooth
Bluetooth Radio
Board
Boot Manager
Brightness
BTRFS
Camera
Chassis
CPU
CPU Cache
CPU Usage
Colors
Command
Cursor
Custom
Date Time
Display
Disk
DiskIO
Desktop Environment
DNS
Editor
Font
Gamepad
GPU
Host
Icons
Init System
Kernel
Keyboard
Login Manager
Local IP
Loadavg
Locale
Media
Memory
Mouse
Monitor
NetIO
OpenCL
OpenGL
Operating System
Packages
Physical Disk
Physical Memory
Player
Power Adapter
Processes
Public IP
Separator
Shell
Sound
Swap
Terminal
Terminal Font
Terminal Size
Terminal Theme
Theme
Title
TPM
Users
Uptime
Version
Vulkan
Wallpaper
Weather
Wi-Fi
Window Manager
WM Theme
Zpool
5.1.2.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break

Title: Break

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print a empty line
-conditionNoobjectNoIn #/$defs/conditionsOnly show the module if conditions are met
5.1.2.1.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > type
Typeconst
RequiredNo

Description: Print a empty line

Specific value:"break"

5.1.2.1.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Defined in#/$defs/conditions

Description: Only show the module if conditions are met

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-systemNoCombinationNo-System name to match
-!systemNoCombinationNo-System name to not match
-archNoCombinationNo-Architecture to match
-!archNoCombinationNo-Architecture to not match
-succeededNoCombinationNo-Whether the module succeeded in the last run
5.1.2.1.2.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system
Typecombining
RequiredNo
Additional propertiesAny type allowed

Description: System name to match

One of(Option)
systems
item 1
item 2
5.1.2.1.2.1.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system > oneOf > systems
Typeenum (of string)
RequiredNo
Defined in#/$defs/systems

Must be one of:

  • "Android"
  • "Linux"
  • "DragonFly"
  • "MidnightBSD"
  • "FreeBSD"
  • "macOS"
  • "Windows"
  • "SunOS"
  • "OpenBSD"
  • "NetBSD"
  • "Haiku"
5.1.2.1.2.1.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system > oneOf > item 1
Typearray
RequiredNo

Description: Array of system names to match

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityTrue
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
systems-
5.1.2.1.2.1.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system > oneOf > item 1 > systems
Typeenum (of string)
RequiredNo
Same definition asmodules_items_anyOf_i1_oneOf_i0_condition_system_oneOf_i0
5.1.2.1.2.1.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system > oneOf > item 2
Typenull
RequiredNo

Description: Null to disable this condition

5.1.2.1.2.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system
Typecombining
RequiredNo
Additional propertiesAny type allowed

Description: System name to not match

One of(Option)
systems
item 1
item 2
5.1.2.1.2.2.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system > oneOf > systems
Typeenum (of string)
RequiredNo
Same definition asmodules_items_anyOf_i1_oneOf_i0_condition_system_oneOf_i0
5.1.2.1.2.2.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system > oneOf > item 1
Typearray
RequiredNo

Description: Array of system names to not match

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityTrue
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
systems-
5.1.2.1.2.2.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system > oneOf > item 1 > systems
Typeenum (of string)
RequiredNo
Same definition asmodules_items_anyOf_i1_oneOf_i0_condition_system_oneOf_i0
5.1.2.1.2.2.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system > oneOf > item 2
Typenull
RequiredNo

Description: Null to disable this condition

5.1.2.1.2.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch
Typecombining
RequiredNo
Additional propertiesAny type allowed

Description: Architecture to match

One of(Option)
architectures
item 1
item 2
5.1.2.1.2.3.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch > oneOf > architectures
Typeenum (of string)
RequiredNo
Defined in#/$defs/architectures

Must be one of:

  • "x86_64"
  • "i386"
  • "ia64"
  • "aarch64"
  • "arm"
  • "mips"
  • "powerpc"
  • "riscv"
  • "s390x"
  • "loongarch"
  • "sparc"
  • "alpha"
  • "hppa"
  • "m68k"
5.1.2.1.2.3.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch > oneOf > item 1
Typearray
RequiredNo

Description: Array of architectures to match

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityTrue
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
architectures-
5.1.2.1.2.3.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch > oneOf > item 1 > architectures
Typeenum (of string)
RequiredNo
Same definition asmodules_items_anyOf_i1_oneOf_i0_condition_arch_oneOf_i0
5.1.2.1.2.3.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch > oneOf > item 2
Typenull
RequiredNo

Description: Null to disable this condition

5.1.2.1.2.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch
Typecombining
RequiredNo
Additional propertiesAny type allowed

Description: Architecture to not match

One of(Option)
architectures
item 1
item 2
5.1.2.1.2.4.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch > oneOf > architectures
Typeenum (of string)
RequiredNo
Same definition asmodules_items_anyOf_i1_oneOf_i0_condition_arch_oneOf_i0
5.1.2.1.2.4.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch > oneOf > item 1
Typearray
RequiredNo

Description: Array of architectures to not match

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityTrue
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
architectures-
5.1.2.1.2.4.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch > oneOf > item 1 > architectures
Typeenum (of string)
RequiredNo
Same definition asmodules_items_anyOf_i1_oneOf_i0_condition_arch_oneOf_i0
5.1.2.1.2.4.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch > oneOf > item 2
Typenull
RequiredNo

Description: Null to disable this condition

5.1.2.1.2.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > succeeded
Typecombining
RequiredNo
Additional propertiesAny type allowed

Description: Whether the module succeeded in the last run

One of(Option)
item 0
item 1
5.1.2.1.2.5.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > succeeded > oneOf > item 0
Typeboolean
RequiredNo

Description: True to only show the module if it succeeded, false to only show it if it failed

5.1.2.1.2.5.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > succeeded > oneOf > item 1
Typenull
RequiredNo

Description: Null to disable this condition

5.1.2.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery

Title: Battery

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print battery capacity, status, etc
-useSetupApiNobooleanNo-Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only
-tempNoobjectNoIn #/$defs/temperatureDetect and display temperature if supported
-percentNoobjectNoIn #/$defs/percentThresholds for percentage colors
-keyNostringNoIn #/$defs/keyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoIn #/$defs/keyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoIn #/$defs/keyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoIn #/$defs/keyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoIn #/$defs/outputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/batteryFormatOutput format of the module `Battery`. See Wiki for formatting syntax
1. {manufacturer}: Battery manufacturer
2. {model-name}: Battery model name
3. {technology}: Battery technology
4. {capacity}: Battery capacity (percentage num)
5. {status}: Battery status
6. {temperature}: Battery temperature (formatted)
7. {cycle-count}: Battery cycle count
8. {serial}: Battery serial number
9. {manufacture-date}: Battery manufactor date
10. {capacity-bar}: Battery capacity (percentage bar)
11. {time-days}: Battery time remaining days
12. {time-hours}: Battery time remaining hours
13. {time-minutes}: Battery time remaining minutes
14. {time-seconds}: Battery time remaining seconds
15. {time-formatted}: Battery time remaining (formatted)
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.2.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > type
Typeconst
RequiredNo

Description: Print battery capacity, status, etc

Specific value:"battery"

5.1.2.2.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > useSetupApi
Typeboolean
RequiredNo
Defaultfalse

Description: Set ifSetupAPI should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only

5.1.2.2.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp
Typecombining
RequiredNo
Additional propertiesAny type allowed
Defined in#/$defs/temperature

Description: Detect and display temperature if supported

One of(Option)
item 0
item 1
5.1.2.2.3.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 0
Typeboolean
RequiredNo
Defaultfalse
5.1.2.2.3.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 1
Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-greenNointegerNo-Values (in celsius) less than green will be shown in green
-yellowNointegerNo-Values (in celsius) greater than green and less than yellow will be shown in yellow.
Values greater than yellow will be shown in red
5.1.2.2.3.2.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 1 > green
Typeinteger
RequiredNo

Description: Values (in celsius) less than green will be shown in green

Restrictions
Minimum≥ 0
Maximum≤ 100
5.1.2.2.3.2.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 1 > yellow
Typeinteger
RequiredNo

Description: Values (in celsius) greater than green and less than yellow will be shown in yellow.Values greater than yellow will be shown in red

Restrictions
Minimum≥ 0
Maximum≤ 100
5.1.2.2.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent
Typeobject
RequiredNo
Additional propertiesNot allowed
Defined in#/$defs/percent

Description: Thresholds for percentage colors

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-greenNointegerNo-Values less than green will be shown in green
-yellowNointegerNo-Values greater than green and less than yellow will be shown in yellow.
Values greater than yellow will be shown in red
-typeNoobjectNoSame astypeSet the percentage output type
5.1.2.2.4.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent > green
Typeinteger
RequiredNo

Description: Values less than green will be shown in green

Restrictions
Minimum≥ 0
Maximum≤ 100
5.1.2.2.4.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent > yellow
Typeinteger
RequiredNo

Description: Values greater than green and less than yellow will be shown in yellow.Values greater than yellow will be shown in red

Restrictions
Minimum≥ 0
Maximum≤ 100
5.1.2.2.4.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent > type
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition astype

Description: Set the percentage output type

5.1.2.2.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > key
Typestring
RequiredNo
Defined in#/$defs/key

Description: Key of the moduleOne whitespace character () can be used to hide the key

Restrictions
Min length1
5.1.2.2.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > keyColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Defined in#/$defs/keyColor

Description: Color of the module key to override the global settingdisplay.color.key

5.1.2.2.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > keyIcon
Typestring
RequiredNo
Defined in#/$defs/keyIcon

Description: Set the icon to be displayed bydisplay.keyType: "icon"

5.1.2.2.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > keyWidth
Typeinteger
RequiredNo
Defined in#/$defs/keyWidth

Description: Width of the module key to override the global settingdisplay.keyWidth

Restrictions
Minimum≥ 1
5.1.2.2.9. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > outputColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Defined in#/$defs/outputColor

Description: Output color of the module to override the global settingdisplay.color.output

5.1.2.2.10. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > format
Typestring
RequiredNo
Defined in#/$defs/batteryFormat

Description: Output format of the moduleBattery. See Wiki for formatting syntax1. {manufacturer}: Battery manufacturer2. {model-name}: Battery model name3. {technology}: Battery technology4. {capacity}: Battery capacity (percentage num)5. {status}: Battery status6. {temperature}: Battery temperature (formatted)7. {cycle-count}: Battery cycle count8. {serial}: Battery serial number9. {manufacture-date}: Battery manufactor date10. {capacity-bar}: Battery capacity (percentage bar)11. {time-days}: Battery time remaining days12. {time-hours}: Battery time remaining hours13. {time-minutes}: Battery time remaining minutes14. {time-seconds}: Battery time remaining seconds15. {time-formatted}: Battery time remaining (formatted)

5.1.2.2.11. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS

Title: BIOS

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print information of 1st-stage bootloader (name, version, release date, etc)
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/biosFormatOutput format of the module `BIOS`. See Wiki for formatting syntax
1. {date}: Bios date
2. {release}: Bios release
3. {vendor}: Bios vendor
4. {version}: Bios version
5. {type}: Firmware type
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.3.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > type
Typeconst
RequiredNo

Description: Print information of 1st-stage bootloader (name, version, release date, etc)

Specific value:"bios"

5.1.2.3.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > key
Typestring
RequiredNo
Same definition askey

Description: Key of the moduleOne whitespace character () can be used to hide the key

5.1.2.3.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > keyColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition askeyColor

Description: Color of the module key to override the global settingdisplay.color.key

5.1.2.3.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

Description: Set the icon to be displayed bydisplay.keyType: "icon"

5.1.2.3.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

Description: Width of the module key to override the global settingdisplay.keyWidth

5.1.2.3.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > outputColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition asoutputColor

Description: Output color of the module to override the global settingdisplay.color.output

5.1.2.3.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > format
Typestring
RequiredNo
Defined in#/$defs/biosFormat

Description: Output format of the moduleBIOS. See Wiki for formatting syntax1. {date}: Bios date2. {release}: Bios release3. {vendor}: Bios vendor4. {version}: Bios version5. {type}: Firmware type

5.1.2.3.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth

Title: Bluetooth

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-List (connected) bluetooth devices
-showDisconnectedNobooleanNo-Set if disconnected bluetooth devices should be printed
-percentNoobjectNoSame aspercentThresholds for percentage colors
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/bluetoothFormatOutput format of the module `Bluetooth`. See Wiki for formatting syntax
1. {name}: Name
2. {address}: Address
3. {type}: Type
4. {battery-percentage}: Battery percentage number
5. {connected}: Is connected
6. {battery-percentage-bar}: Battery percentage bar
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.4.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > type
Typeconst
RequiredNo

Description: List (connected) bluetooth devices

Specific value:"bluetooth"

5.1.2.4.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > showDisconnected
Typeboolean
RequiredNo
Defaultfalse

Description: Set if disconnected bluetooth devices should be printed

5.1.2.4.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > percent
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition aspercent

Description: Thresholds for percentage colors

5.1.2.4.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > key
Typestring
RequiredNo
Same definition askey

Description: Key of the moduleOne whitespace character () can be used to hide the key

5.1.2.4.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > keyColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition askeyColor

Description: Color of the module key to override the global settingdisplay.color.key

5.1.2.4.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

Description: Set the icon to be displayed bydisplay.keyType: "icon"

5.1.2.4.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

Description: Width of the module key to override the global settingdisplay.keyWidth

5.1.2.4.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > outputColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition asoutputColor

Description: Output color of the module to override the global settingdisplay.color.output

5.1.2.4.9. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > format
Typestring
RequiredNo
Defined in#/$defs/bluetoothFormat

Description: Output format of the moduleBluetooth. See Wiki for formatting syntax1. {name}: Name2. {address}: Address3. {type}: Type4. {battery-percentage}: Battery percentage number5. {connected}: Is connected6. {battery-percentage-bar}: Battery percentage bar

5.1.2.4.10. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio

Title: Bluetooth Radio

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-List bluetooth radios width supported version and vendor
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/bluetoothradioFormatOutput format of the module `BluetoothRadio`. See Wiki for formatting syntax
1. {name}: Radio name for discovering
2. {address}: Address
3. {lmp-version}: LMP version
4. {lmp-subversion}: LMP subversion
5. {version}: Bluetooth version
6. {vendor}: Vendor
7. {discoverable}: Discoverable
8. {connectable}: Connectable / Pairable
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.5.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > type
Typeconst
RequiredNo

Description: List bluetooth radios width supported version and vendor

Specific value:"bluetoothradio"

5.1.2.5.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > key
Typestring
RequiredNo
Same definition askey

Description: Key of the moduleOne whitespace character () can be used to hide the key

5.1.2.5.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > keyColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition askeyColor

Description: Color of the module key to override the global settingdisplay.color.key

5.1.2.5.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

Description: Set the icon to be displayed bydisplay.keyType: "icon"

5.1.2.5.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

Description: Width of the module key to override the global settingdisplay.keyWidth

5.1.2.5.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > outputColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition asoutputColor

Description: Output color of the module to override the global settingdisplay.color.output

5.1.2.5.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > format
Typestring
RequiredNo
Defined in#/$defs/bluetoothradioFormat

Description: Output format of the moduleBluetoothRadio. See Wiki for formatting syntax1. {name}: Radio name for discovering2. {address}: Address3. {lmp-version}: LMP version4. {lmp-subversion}: LMP subversion5. {version}: Bluetooth version6. {vendor}: Vendor7. {discoverable}: Discoverable8. {connectable}: Connectable / Pairable

5.1.2.5.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Board

Title: Board

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print motherboard name and other info
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/boardFormatOutput format of the module `Board`. See Wiki for formatting syntax
1. {name}: Board name
2. {vendor}: Board vendor
3. {version}: Board version
4. {serial}: Board serial number
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.6.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Board > type
Typeconst
RequiredNo

Description: Print motherboard name and other info

Specific value:"board"

5.1.2.6.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Board > key
Typestring
RequiredNo
Same definition askey

Description: Key of the moduleOne whitespace character () can be used to hide the key

5.1.2.6.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Board > keyColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition askeyColor

Description: Color of the module key to override the global settingdisplay.color.key

5.1.2.6.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Board > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

Description: Set the icon to be displayed bydisplay.keyType: "icon"

5.1.2.6.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Board > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

Description: Width of the module key to override the global settingdisplay.keyWidth

5.1.2.6.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Board > outputColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition asoutputColor

Description: Output color of the module to override the global settingdisplay.color.output

5.1.2.6.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Board > format
Typestring
RequiredNo
Defined in#/$defs/boardFormat

Description: Output format of the moduleBoard. See Wiki for formatting syntax1. {name}: Board name2. {vendor}: Board vendor3. {version}: Board version4. {serial}: Board serial number

5.1.2.6.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Board > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager

Title: Boot Manager

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print information of 2nd-stage bootloader (name, firmware, etc)
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/bootmgrFormatOutput format of the module `Bootmgr`. See Wiki for formatting syntax
1. {name}: Name / description
2. {firmware-path}: Firmware file path
3. {firmware-name}: Firmware file name
4. {secure-boot}: Is secure boot enabled
5. {order}: Boot order
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.7.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > type
Typeconst
RequiredNo

Description: Print information of 2nd-stage bootloader (name, firmware, etc)

Specific value:"bootmgr"

5.1.2.7.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > key
Typestring
RequiredNo
Same definition askey

Description: Key of the moduleOne whitespace character () can be used to hide the key

5.1.2.7.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > keyColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition askeyColor

Description: Color of the module key to override the global settingdisplay.color.key

5.1.2.7.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

Description: Set the icon to be displayed bydisplay.keyType: "icon"

5.1.2.7.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

Description: Width of the module key to override the global settingdisplay.keyWidth

5.1.2.7.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > outputColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition asoutputColor

Description: Output color of the module to override the global settingdisplay.color.output

5.1.2.7.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > format
Typestring
RequiredNo
Defined in#/$defs/bootmgrFormat

Description: Output format of the moduleBootmgr. See Wiki for formatting syntax1. {name}: Name / description2. {firmware-path}: Firmware file path3. {firmware-name}: Firmware file name4. {secure-boot}: Is secure boot enabled5. {order}: Boot order

5.1.2.7.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness

Title: Brightness

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print current brightness level of your monitors
-percentNoobjectNoSame aspercentThresholds for percentage colors
-ddcciSleepNointegerNo-Set the sleep times (in ms) when sending DDC/CI requests.
Seehttps://www.ddcutil.com/performance_options/#option-sleep-multiplier for detail
-compactNobooleanNo-Set if multiple results should be printed in one line
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/brightnessFormatOutput format of the module `Brightness`. See Wiki for formatting syntax
1. {percentage}: Screen brightness (percentage num)
2. {name}: Screen name
3. {max}: Maximum brightness value
4. {min}: Minimum brightness value
5. {current}: Current brightness value
6. {percentage-bar}: Screen brightness (percentage bar)
7. {is-builtin}: Is built-in screen
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.8.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > type
Typeconst
RequiredNo

Description: Print current brightness level of your monitors

Specific value:"brightness"

5.1.2.8.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > percent
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition aspercent

Description: Thresholds for percentage colors

5.1.2.8.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > ddcciSleep
Typeinteger
RequiredNo
Default10

Description: Set the sleep times (in ms) when sending DDC/CI requests.Seehttps://www.ddcutil.com/performance_options/#option-sleep-multiplier for detail

Restrictions
Minimum≥ 0
Maximum≤ 400
5.1.2.8.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > compact
Typeboolean
RequiredNo
Defaultfalse

Description: Set if multiple results should be printed in one line

5.1.2.8.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > key
Typestring
RequiredNo
Same definition askey

Description: Key of the moduleOne whitespace character () can be used to hide the key

5.1.2.8.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > keyColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition askeyColor

Description: Color of the module key to override the global settingdisplay.color.key

5.1.2.8.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

Description: Set the icon to be displayed bydisplay.keyType: "icon"

5.1.2.8.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

Description: Width of the module key to override the global settingdisplay.keyWidth

5.1.2.8.9. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > outputColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition asoutputColor

Description: Output color of the module to override the global settingdisplay.color.output

5.1.2.8.10. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > format
Typestring
RequiredNo
Defined in#/$defs/brightnessFormat

Description: Output format of the moduleBrightness. See Wiki for formatting syntax1. {percentage}: Screen brightness (percentage num)2. {name}: Screen name3. {max}: Maximum brightness value4. {min}: Minimum brightness value5. {current}: Current brightness value6. {percentage-bar}: Screen brightness (percentage bar)7. {is-builtin}: Is built-in screen

5.1.2.8.11. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.9. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS

Title: BTRFS

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print Linux BTRFS volumes
-percentNoobjectNoSame aspercentThresholds for percentage colors
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/btrfsFormatOutput format of the module `Btrfs`. See Wiki for formatting syntax
1. {name}: Name / Label
2. {uuid}: UUID
3. {devices}: Associated devices
4. {features}: Enabled features
5. {used}: Size used
6. {allocated}: Size allocated
7. {total}: Size total
8. {used-percentage}: Used percentage num
9. {allocated-percentage}: Allocated percentage num
10. {used-percentage-bar}: Used percentage bar
11. {allocated-percentage-bar}: Allocated percentage bar
12. {node-size}: Node size
13. {sector-size}: Sector size
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.9.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > type
Typeconst
RequiredNo

Description: Print Linux BTRFS volumes

Specific value:"btrfs"

5.1.2.9.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > percent
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition aspercent

Description: Thresholds for percentage colors

5.1.2.9.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > key
Typestring
RequiredNo
Same definition askey

Description: Key of the moduleOne whitespace character () can be used to hide the key

5.1.2.9.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > keyColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition askeyColor

Description: Color of the module key to override the global settingdisplay.color.key

5.1.2.9.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

Description: Set the icon to be displayed bydisplay.keyType: "icon"

5.1.2.9.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

Description: Width of the module key to override the global settingdisplay.keyWidth

5.1.2.9.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > outputColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition asoutputColor

Description: Output color of the module to override the global settingdisplay.color.output

5.1.2.9.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > format
Typestring
RequiredNo
Defined in#/$defs/btrfsFormat

Description: Output format of the moduleBtrfs. See Wiki for formatting syntax1. {name}: Name / Label2. {uuid}: UUID3. {devices}: Associated devices4. {features}: Enabled features5. {used}: Size used6. {allocated}: Size allocated7. {total}: Size total8. {used-percentage}: Used percentage num9. {allocated-percentage}: Allocated percentage num10. {used-percentage-bar}: Used percentage bar11. {allocated-percentage-bar}: Allocated percentage bar12. {node-size}: Node size13. {sector-size}: Sector size

5.1.2.9.9. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.10. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Camera

Title: Camera

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print available cameras
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/cameraFormatOutput format of the module `Camera`. See Wiki for formatting syntax
1. {name}: Device name
2. {vendor}: Vendor
3. {colorspace}: Color space
4. {id}: Identifier
5. {width}: Width (in px)
6. {height}: Height (in px)
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.10.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > type
Typeconst
RequiredNo

Description: Print available cameras

Specific value:"camera"

5.1.2.10.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > key
Typestring
RequiredNo
Same definition askey

Description: Key of the moduleOne whitespace character () can be used to hide the key

5.1.2.10.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > keyColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition askeyColor

Description: Color of the module key to override the global settingdisplay.color.key

5.1.2.10.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

Description: Set the icon to be displayed bydisplay.keyType: "icon"

5.1.2.10.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

Description: Width of the module key to override the global settingdisplay.keyWidth

5.1.2.10.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > outputColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition asoutputColor

Description: Output color of the module to override the global settingdisplay.color.output

5.1.2.10.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > format
Typestring
RequiredNo
Defined in#/$defs/cameraFormat

Description: Output format of the moduleCamera. See Wiki for formatting syntax1. {name}: Device name2. {vendor}: Vendor3. {colorspace}: Color space4. {id}: Identifier5. {width}: Width (in px)6. {height}: Height (in px)

5.1.2.10.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.11. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis

Title: Chassis

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print chassis type (desktop, laptop, etc)
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/chassisFormatOutput format of the module `Chassis`. See Wiki for formatting syntax
1. {type}: Chassis type
2. {vendor}: Chassis vendor
3. {version}: Chassis version
4. {serial}: Chassis serial number
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.11.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > type
Typeconst
RequiredNo

Description: Print chassis type (desktop, laptop, etc)

Specific value:"chassis"

5.1.2.11.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > key
Typestring
RequiredNo
Same definition askey

Description: Key of the moduleOne whitespace character () can be used to hide the key

5.1.2.11.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > keyColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition askeyColor

Description: Color of the module key to override the global settingdisplay.color.key

5.1.2.11.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

Description: Set the icon to be displayed bydisplay.keyType: "icon"

5.1.2.11.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

Description: Width of the module key to override the global settingdisplay.keyWidth

5.1.2.11.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > outputColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition asoutputColor

Description: Output color of the module to override the global settingdisplay.color.output

5.1.2.11.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > format
Typestring
RequiredNo
Defined in#/$defs/chassisFormat

Description: Output format of the moduleChassis. See Wiki for formatting syntax1. {type}: Chassis type2. {vendor}: Chassis vendor3. {version}: Chassis version4. {serial}: Chassis serial number

5.1.2.11.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.12. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU

Title: CPU

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print CPU name, frequency, etc
-tempNoobjectNoSame astempDetect and display temperature if supported
-tempSensorNostringNo-Set the temperature sensor to use for CPU temperature detection
* Linux: `hwmon` or `thermal` path name (eg. `hwmon0`, `thermal_zone0)`
* macOS: SMC sensor key (eg. `Tp01`)
* Windows: thermal zone key (eg. `_TZ.CPUZ`)
* FreeBSD: sysctl key (eg. `dev.cpu.0.temperature`)
* NetBSD: sysmon sensor key (eg. `coretemp0`)
-showPeCoreCountNobooleanNo-Detect and display CPU frequency of different core types (eg. Pcore and Ecore) if supported
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/cpuFormatOutput format of the module `CPU`. See Wiki for formatting syntax
1. {name}: Name
2. {vendor}: Vendor
3. {cores-physical}: Physical core count
4. {cores-logical}: Logical core count
5. {cores-online}: Online core count
6. {freq-base}: Base frequency (formatted)
7. {freq-max}: Max frequency (formatted)
8. {temperature}: Temperature (formatted)
9. {core-types}: Logical core count grouped by frequency
10. {packages}: Processor package count
11. {march}: X86-64 CPU microarchitecture
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.12.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > type
Typeconst
RequiredNo

Description: Print CPU name, frequency, etc

Specific value:"cpu"

5.1.2.12.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > temp
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition astemp

Description: Detect and display temperature if supported

5.1.2.12.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > tempSensor
Typestring
RequiredNo

Description: Set the temperature sensor to use for CPU temperature detection

  • Linux:hwmon orthermal path name (eg.hwmon0,thermal_zone0)
  • macOS: SMC sensor key (eg.Tp01)
  • Windows: thermal zone key (eg.\_TZ.CPUZ)
  • FreeBSD: sysctl key (eg.dev.cpu.0.temperature)
  • NetBSD: sysmon sensor key (eg.coretemp0)
5.1.2.12.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > showPeCoreCount
Typeboolean
RequiredNo
Defaultfalse

Description: Detect and display CPU frequency of different core types (eg. Pcore and Ecore) if supported

5.1.2.12.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > key
Typestring
RequiredNo
Same definition askey

Description: Key of the moduleOne whitespace character () can be used to hide the key

5.1.2.12.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > keyColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition askeyColor

Description: Color of the module key to override the global settingdisplay.color.key

5.1.2.12.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

Description: Set the icon to be displayed bydisplay.keyType: "icon"

5.1.2.12.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

Description: Width of the module key to override the global settingdisplay.keyWidth

5.1.2.12.9. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > outputColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition asoutputColor

Description: Output color of the module to override the global settingdisplay.color.output

5.1.2.12.10. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > format
Typestring
RequiredNo
Defined in#/$defs/cpuFormat

Description: Output format of the moduleCPU. See Wiki for formatting syntax1. {name}: Name2. {vendor}: Vendor3. {cores-physical}: Physical core count4. {cores-logical}: Logical core count5. {cores-online}: Online core count6. {freq-base}: Base frequency (formatted)7. {freq-max}: Max frequency (formatted)8. {temperature}: Temperature (formatted)9. {core-types}: Logical core count grouped by frequency10. {packages}: Processor package count11. {march}: X86-64 CPU microarchitecture

5.1.2.12.11. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.13. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache

Title: CPU Cache

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print CPU cache sizes
-percentNoobjectNoSame aspercentThresholds for percentage colors
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/cpucacheFormatOutput format of the module `CPUCache`. See Wiki for formatting syntax
1. {result}: Separate result
2. {sum}: Sum result
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.13.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > type
Typeconst
RequiredNo

Description: Print CPU cache sizes

Specific value:"cpucache"

5.1.2.13.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > percent
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition aspercent

Description: Thresholds for percentage colors

5.1.2.13.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > key
Typestring
RequiredNo
Same definition askey

Description: Key of the moduleOne whitespace character () can be used to hide the key

5.1.2.13.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > keyColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition askeyColor

Description: Color of the module key to override the global settingdisplay.color.key

5.1.2.13.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

Description: Set the icon to be displayed bydisplay.keyType: "icon"

5.1.2.13.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

Description: Width of the module key to override the global settingdisplay.keyWidth

5.1.2.13.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > outputColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition asoutputColor

Description: Output color of the module to override the global settingdisplay.color.output

5.1.2.13.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > format
Typestring
RequiredNo
Defined in#/$defs/cpucacheFormat

Description: Output format of the moduleCPUCache. See Wiki for formatting syntax1. {result}: Separate result2. {sum}: Sum result

5.1.2.13.9. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.14. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage

Title: CPU Usage

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print CPU usage. Costs some time to collect data
-percentNoobjectNoSame aspercentThresholds for percentage colors
-separateNobooleanNo-Display CPU usage per CPU logical core, instead of an average result
-waitTimeNointegerNo-Wait time (in ms). CPU usage = (inUseEnd - inUseStart) / waitTime
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/cpuusageFormatOutput format of the module `CPUUsage`. See Wiki for formatting syntax
1. {avg}: CPU usage (percentage num, average)
2. {max}: CPU usage (percentage num, maximum)
3. {max-index}: CPU core index of maximum usage
4. {min}: CPU usage (percentage num, minimum)
5. {min-index}: CPU core index of minimum usage
6. {avg-bar}: CPU usage (percentage bar, average)
7. {max-bar}: CPU usage (percentage bar, maximum)
8. {min-bar}: CPU usage (percentage bar, minimum)
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.14.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > type
Typeconst
RequiredNo

Description: Print CPU usage. Costs some time to collect data

Specific value:"cpuusage"

5.1.2.14.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > percent
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition aspercent

Description: Thresholds for percentage colors

5.1.2.14.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > separate
Typeboolean
RequiredNo
Defaultfalse

Description: Display CPU usage per CPU logical core, instead of an average result

5.1.2.14.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > waitTime
Typeinteger
RequiredNo
Default200

Description: Wait time (in ms). CPU usage = (inUseEnd - inUseStart) / waitTime

Restrictions
Minimum≥ 1
5.1.2.14.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > key
Typestring
RequiredNo
Same definition askey

Description: Key of the moduleOne whitespace character () can be used to hide the key

5.1.2.14.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > keyColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition askeyColor

Description: Color of the module key to override the global settingdisplay.color.key

5.1.2.14.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

Description: Set the icon to be displayed bydisplay.keyType: "icon"

5.1.2.14.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

Description: Width of the module key to override the global settingdisplay.keyWidth

5.1.2.14.9. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > outputColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition asoutputColor

Description: Output color of the module to override the global settingdisplay.color.output

5.1.2.14.10. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > format
Typestring
RequiredNo
Defined in#/$defs/cpuusageFormat

Description: Output format of the moduleCPUUsage. See Wiki for formatting syntax1. {avg}: CPU usage (percentage num, average)2. {max}: CPU usage (percentage num, maximum)3. {max-index}: CPU core index of maximum usage4. {min}: CPU usage (percentage num, minimum)5. {min-index}: CPU core index of minimum usage6. {avg-bar}: CPU usage (percentage bar, average)7. {max-bar}: CPU usage (percentage bar, maximum)8. {min-bar}: CPU usage (percentage bar, minimum)

5.1.2.14.11. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.15. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors

Title: Colors

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print some colored blocks
-symbolNoCombinationNo-Set the symbol to use
-paddingLeftNointegerNo-Set the number of white spaces to print before the symbol
-blockNoobjectNo-Set behavior of block printing
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.15.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > type
Typeconst
RequiredNo

Description: Print some colored blocks

Specific value:"colors"

5.1.2.15.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol
Typecombining
RequiredNo
Default"background"

Description: Set the symbol to use

One of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
item 6
5.1.2.15.2.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 0
Typeconst
RequiredNo

Description: ███

Specific value:"block"

5.1.2.15.2.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 1
Typeconst
RequiredNo

Description: (whitespaces with background)

Specific value:"background"

5.1.2.15.2.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 2
Typeconst
RequiredNo

Description:

Specific value:"circle"

5.1.2.15.2.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 3
Typeconst
RequiredNo

Description:

Specific value:"diamond"

5.1.2.15.2.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 4
Typeconst
RequiredNo

Description:

Specific value:"triangle"

5.1.2.15.2.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 5
Typeconst
RequiredNo

Description:

Specific value:"square"

5.1.2.15.2.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 6
Typeconst
RequiredNo

Description:

Specific value:"star"

5.1.2.15.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > paddingLeft
Typeinteger
RequiredNo
Default0

Description: Set the number of white spaces to print before the symbol

Restrictions
Minimum≥ 0
5.1.2.15.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block
Typeobject
RequiredNo
Additional propertiesNot allowed

Description: Set behavior of block printing

PropertyPatternTypeDeprecatedDefinitionTitle/Description
-widthNointegerNo-Set the block width in spaces
-rangeNoarray of integerNo-Set the range of colors in the blocks to print
5.1.2.15.4.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block > width
Typeinteger
RequiredNo
Default3

Description: Set the block width in spaces

Restrictions
Minimum≥ 1
5.1.2.15.4.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block > range
Typearray of integer
RequiredNo

Description: Set the range of colors in the blocks to print

Array restrictions
Min items2
Max items2
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
range items-
5.1.2.15.4.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block > range > range items
Typeinteger
RequiredNo
Restrictions
Minimum≥ 0
Maximum≤ 15
5.1.2.15.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > key
Typestring
RequiredNo
Same definition askey

Description: Key of the moduleOne whitespace character () can be used to hide the key

5.1.2.15.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > keyColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition askeyColor

Description: Color of the module key to override the global settingdisplay.color.key

5.1.2.15.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

Description: Set the icon to be displayed bydisplay.keyType: "icon"

5.1.2.15.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

Description: Width of the module key to override the global settingdisplay.keyWidth

5.1.2.15.9. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.16. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Command

Title: Command

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Running custom shell scripts
-shellNostringNo-Set the shell program to execute the command text
Default: cmd for Windows, /bin/sh for *nix
-paramNostringNo-Set the parameter used when starting the shell
If set to an empty string, it will be ignored
Default: /c for Windows, -c for *nix
-textNostringNo-Set the command text to be executed
-useStdErrNobooleanNo-Set if stderr should be used instead of stdout for command output
-parallelNobooleanNo-Set if the command should be executed in parallel with other commands
Improve performance when using multiple commands, but may cause issues with some commands
-splitLinesNobooleanNo-Set if the command output should be split into multiple lines
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/commandFormatOutput format of the module `Command`. See Wiki for formatting syntax
1. {result}: Command result
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.16.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Command > type
Typeconst
RequiredNo

Description: Running custom shell scripts

Specific value:"command"

5.1.2.16.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Command > shell
Typestring
RequiredNo

Description: Set the shell program to execute the command textDefault: cmd for Windows, /bin/sh for *nix

5.1.2.16.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Command > param
Typestring
RequiredNo

Description: Set the parameter used when starting the shellIf set to an empty string, it will be ignoredDefault: /c for Windows, -c for *nix

5.1.2.16.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Command > text
Typestring
RequiredNo

Description: Set the command text to be executed

5.1.2.16.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Command > useStdErr
Typeboolean
RequiredNo
Defaultfalse

Description: Set if stderr should be used instead of stdout for command output

5.1.2.16.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Command > parallel
Typeboolean
RequiredNo
Defaulttrue

Description: Set if the command should be executed in parallel with other commandsImprove performance when using multiple commands, but may cause issues with some commands

5.1.2.16.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Command > splitLines
Typeboolean
RequiredNo
Defaultfalse

Description: Set if the command output should be split into multiple lines

5.1.2.16.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Command > key
Typestring
RequiredNo
Same definition askey

Description: Key of the moduleOne whitespace character () can be used to hide the key

5.1.2.16.9. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Command > keyColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition askeyColor

Description: Color of the module key to override the global settingdisplay.color.key

5.1.2.16.10. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Command > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

Description: Set the icon to be displayed bydisplay.keyType: "icon"

5.1.2.16.11. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Command > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

Description: Width of the module key to override the global settingdisplay.keyWidth

5.1.2.16.12. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Command > outputColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition asoutputColor

Description: Output color of the module to override the global settingdisplay.color.output

5.1.2.16.13. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Command > format
Typestring
RequiredNo
Defined in#/$defs/commandFormat

Description: Output format of the moduleCommand. See Wiki for formatting syntax1. {result}: Command result

5.1.2.16.14. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Command > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.17. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor

Title: Cursor

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print cursor style name
-percentNoobjectNoSame aspercentThresholds for percentage colors
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/cursorFormatOutput format of the module `Cursor`. See Wiki for formatting syntax
1. {theme}: Cursor theme
2. {size}: Cursor size
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.17.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > type
Typeconst
RequiredNo

Description: Print cursor style name

Specific value:"cursor"

5.1.2.17.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > percent
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition aspercent

Description: Thresholds for percentage colors

5.1.2.17.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > key
Typestring
RequiredNo
Same definition askey

Description: Key of the moduleOne whitespace character () can be used to hide the key

5.1.2.17.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > keyColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition askeyColor

Description: Color of the module key to override the global settingdisplay.color.key

5.1.2.17.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

Description: Set the icon to be displayed bydisplay.keyType: "icon"

5.1.2.17.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

Description: Width of the module key to override the global settingdisplay.keyWidth

5.1.2.17.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > outputColor
Typeobject
RequiredNo
Additional propertiesAny type allowed
Same definition asoutputColor

Description: Output color of the module to override the global settingdisplay.color.output

5.1.2.17.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > format
Typestring
RequiredNo
Defined in#/$defs/cursorFormat

Description: Output format of the moduleCursor. See Wiki for formatting syntax1. {theme}: Cursor theme2. {size}: Cursor size

5.1.2.17.9. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions ar

Clone this wiki locally


[8]ページ先頭

©2009-2025 Movatter.jp