Json Schema

JSON config

1. Property JSON config > $schema
2. Property JSON config > logo
3. Property JSON config > general
4. Property JSON config > display
5. Property JSON config > modules
- 5.1. JSON config > modules > modules items
  - 5.1.1. Property JSON config > modules > modules items > anyOf > item 0
  - 5.1.2. Property JSON config > modules > modules items > anyOf > item 1

Title: JSON config


Type	`object`
Required	No
Additional properties	Not allowed

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

Property	Pattern	Type	Deprecated	Definition	Title/Description
- $schema	No	string	No	-	JSON Schema URL for validation and IDE support
- logo	No	Combination	No	-	Fastfetch logo configuration See also https://github.com/fastfetch-cli/fastfetch/wiki/Logo-options
- general	No	object	No	-	General Fastfetch configuration
- display	No	object	No	-	Configure output formatting
- modules	No	array	No	-	Modules to run

1. Property `JSON config > $schema`


Type	`string`
Required	No
Format	`uri`
Default	`"https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json"`

Description: JSON Schema URL for validation and IDE support

2. Property `JSON config > logo`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: Fastfetch logo configuration See also https://github.com/fastfetch-cli/fastfetch/wiki/Logo-options

One of(Option)
item 0
item 1
item 2

2.1. Property `JSON config > logo > oneOf > item 0`


Type	`const`
Required	No

Description: Disable logo

Specific value: null

2.2. Property `JSON config > logo > oneOf > item 1`


Type	`string`
Required	No

Description: Path to a logo source file or the name of a built-in ASCII art logo

2.3. Property `JSON config > logo > oneOf > item 2`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Fastfetch logo configuration

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	Combination	No	-	Logo type
- source	No	string	No	-	Path to the logo source file
- color	No	object	No	-	Override colors in the logo
- width	No	Combination	No	-	-
- height	No	Combination	No	-	-
- padding	No	object	No	-	Logo padding
- printRemaining	No	boolean	No	-	Whether to print any remaining logo lines when the logo is taller than the module list
- preserveAspectRatio	No	boolean	No	-	Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol only
- recache	No	boolean	No	-	If true, regenerate image logo cache
- position	No	enum (of string)	No	-	Position of the logo
- chafa	No	object	No	-	Chafa configuration. See chafa documentation for details

2.3.1. Property `JSON config > logo > oneOf > item 2 > type`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`"auto"`

Description: Logo type

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
item 15

2.3.1.1. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 0`


Type	`const`
Required	No

Description: If a value is provided, try a built-in logo first, then a file. Otherwise, auto-detect the logo. Explicit type is highly recommended when use image files.

Specific value: "auto"

2.3.1.2. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 1`


Type	`const`
Required	No

Description: Built-in ASCII art

Specific value: "builtin"

2.3.1.3. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 2`


Type	`const`
Required	No

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

Specific value: "small"

2.3.1.4. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 3`


Type	`const`
Required	No

Description: Text file with color code replacement

Specific value: "file"

2.3.1.5. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 4`


Type	`const`
Required	No

Description: Text file, printed as is

Specific value: "file-raw"

2.3.1.6. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 5`


Type	`const`
Required	No

Description: Text data with color code replacement

Specific value: "data"

2.3.1.7. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 6`


Type	`const`
Required	No

Description: Text data, printed as is

Specific value: "data-raw"

2.3.1.8. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 7`


Type	`const`
Required	No

Description: Command that generates text data, printed as is

Specific value: "command-raw"

2.3.1.9. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 8`


Type	`const`
Required	No

Description: Image file rendered as sixel

Specific value: "sixel"

2.3.1.10. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 9`


Type	`const`
Required	No

Description: Image file rendered using the Kitty graphics protocol

Specific value: "kitty"

2.3.1.11. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 10`


Type	`const`
Required	No

Description: Image file. Instructs the terminal emulator to read image data directly from the specified file

Specific value: "kitty-direct"

2.3.1.12. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 11`


Type	`const`
Required	No

Description: Image file displayed using kitten icat. Requires the kitten binary to be installed

Specific value: "kitty-icat"

2.3.1.13. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 12`


Type	`const`
Required	No

Description: Image file rendered using the iTerm image protocol

Specific value: "iterm"

2.3.1.14. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 13`


Type	`const`
Required	No

Description: Image file rendered as ASCII art using libchafa

Specific value: "chafa"

2.3.1.15. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 14`


Type	`const`
Required	No

Description: Image file rendered as a raw binary string

Specific value: "raw"

2.3.1.16. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 15`


Type	`const`
Required	No

Description: Disable logo printing

Specific value: "none"

2.3.2. Property `JSON config > logo > oneOf > item 2 > source`


Type	`string`
Required	No

Description: Path to the logo source file

2.3.3. Property `JSON config > logo > oneOf > item 2 > color`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Override colors in the logo

Property	Pattern	Type	Deprecated	Definition	Title/Description
- 1	No	object	No	In #/$defs/colors	Color 1
- 2	No	object	No	Same as 1	Color 2
- 3	No	object	No	Same as 1	Color 3
- 4	No	object	No	Same as 1	Color 4
- 5	No	object	No	Same as 1	Color 5
- 6	No	object	No	Same as 1	Color 6
- 7	No	object	No	Same as 1	Color 7
- 8	No	object	No	Same as 1	Color 8
- 9	No	object	No	Same as 1	Color 9

2.3.3.1. Property `JSON config > logo > oneOf > item 2 > color > 1`


Type	`combining`
Required	No
Additional properties	Any type allowed
Defined in	#/$defs/colors

Description: Color 1

One of(Option)
item 0
item 1

2.3.3.1.1. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

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. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

2.3.3.2. Property `JSON config > logo > oneOf > item 2 > color > 2`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color 2

2.3.3.3. Property `JSON config > logo > oneOf > item 2 > color > 3`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color 3

2.3.3.4. Property `JSON config > logo > oneOf > item 2 > color > 4`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color 4

2.3.3.5. Property `JSON config > logo > oneOf > item 2 > color > 5`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color 5

2.3.3.6. Property `JSON config > logo > oneOf > item 2 > color > 6`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color 6

2.3.3.7. Property `JSON config > logo > oneOf > item 2 > color > 7`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color 7

2.3.3.8. Property `JSON config > logo > oneOf > item 2 > color > 8`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color 8

2.3.3.9. Property `JSON config > logo > oneOf > item 2 > color > 9`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color 9

2.3.4. Property `JSON config > logo > oneOf > item 2 > width`


Type	`combining`
Required	No
Additional properties	Any type allowed

One of(Option)
item 0
item 1

2.3.4.1. Property `JSON config > logo > oneOf > item 2 > width > oneOf > item 0`


Type	`null`
Required	No

Description: Auto-detect the width (default)

2.3.4.2. Property `JSON config > logo > oneOf > item 2 > width > oneOf > item 1`


Type	`integer`
Required	No

Description: Width of the logo in characters. Required by some image protocols

Restrictions
Minimum	≥ 1

2.3.5. Property `JSON config > logo > oneOf > item 2 > height`


Type	`combining`
Required	No
Additional properties	Any type allowed

One of(Option)
item 0
item 1

2.3.5.1. Property `JSON config > logo > oneOf > item 2 > height > oneOf > item 0`


Type	`null`
Required	No

Description: Auto-detect the height (default)

2.3.5.2. Property `JSON config > logo > oneOf > item 2 > height > oneOf > item 1`


Type	`integer`
Required	No

Description: Height of the logo in characters. Required by some image protocols

Restrictions
Minimum	≥ 1

2.3.6. Property `JSON config > logo > oneOf > item 2 > padding`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Logo padding

Property	Pattern	Type	Deprecated	Definition	Title/Description
- top	No	integer	No	-	Top padding of the logo
- left	No	integer	No	-	Left padding of the logo
- right	No	integer	No	-	Right padding of the logo

2.3.6.1. Property `JSON config > logo > oneOf > item 2 > padding > top`


Type	`integer`
Required	No

Description: Top padding of the logo

Restrictions
Minimum	≥ 0

2.3.6.2. Property `JSON config > logo > oneOf > item 2 > padding > left`


Type	`integer`
Required	No

Description: Left padding of the logo

Restrictions
Minimum	≥ 0

2.3.6.3. Property `JSON config > logo > oneOf > item 2 > padding > right`


Type	`integer`
Required	No

Description: Right padding of the logo

Restrictions
Minimum	≥ 0

2.3.7. Property `JSON config > logo > oneOf > item 2 > printRemaining`


Type	`boolean`
Required	No
Default	`true`

Description: Whether to print any remaining logo lines when the logo is taller than the module list

2.3.8. Property `JSON config > logo > oneOf > item 2 > preserveAspectRatio`


Type	`boolean`
Required	No
Default	`false`

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

2.3.9. Property `JSON config > logo > oneOf > item 2 > recache`


Type	`boolean`
Required	No
Default	`false`

Description: If true, regenerate image logo cache

2.3.10. Property `JSON config > logo > oneOf > item 2 > position`


Type	`enum (of string)`
Required	No
Default	`"left"`

Description: Position of the logo

Must be one of:

"left"
"top"
"right"

2.3.11. Property `JSON config > logo > oneOf > item 2 > chafa`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Chafa configuration. See chafa documentation for details

Property	Pattern	Type	Deprecated	Definition	Title/Description
- fgOnly	No	boolean	No	-	Produce character-cell output using foreground colors only
- symbols	No	string	No	-	Specify character symbols to employ in final output
- canvasMode	No	Combination	No	-	Determine how colors are used in the output. This value maps to enum ChafaCanvasMode.
- colorSpace	No	Combination	No	-	Set color space used for quantization. This value maps to enum ChafaColorSpace.
- ditherMode	No	Combination	No	-	Set output dither mode (No effect with 24-bit color). This value maps to enum ChafaDitherMode.

2.3.11.1. Property `JSON config > logo > oneOf > item 2 > chafa > fgOnly`


Type	`boolean`
Required	No
Default	`false`

Description: Produce character-cell output using foreground colors only

2.3.11.2. Property `JSON config > logo > oneOf > item 2 > chafa > symbols`


Type	`string`
Required	No

Description: Specify character symbols to employ in final output

2.3.11.3. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode`


Type	`combining`
Required	No

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. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 0`


Type	`const`
Required	No

Description: Use 24-bit true colors

Specific value: "TRUECOLOR"

2.3.11.3.2. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 1`


Type	`const`
Required	No

Description: Use 256 colors

Specific value: "INDEXED_256"

2.3.11.3.3. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 2`


Type	`const`
Required	No

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. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 3`


Type	`const`
Required	No

Description: Use 16 colors using the aixterm ANSI extension

Specific value: "INDEXED_16"

2.3.11.3.5. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 4`


Type	`const`
Required	No

Description: Use default foreground and background colors, plus inversion

Specific value: "FGBG_BGFG"

2.3.11.3.6. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 5`


Type	`const`
Required	No

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

Specific value: "FGBG"

2.3.11.3.7. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 6`


Type	`const`
Required	No

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

Specific value: "INDEXED_8"

2.3.11.3.8. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 7`


Type	`const`
Required	No

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. Property `JSON config > logo > oneOf > item 2 > chafa > colorSpace`


Type	`combining`
Required	No

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. Property `JSON config > logo > oneOf > item 2 > chafa > colorSpace > oneOf > item 0`


Type	`const`
Required	No

Description: RGB color space. Fast but imprecise

Specific value: "RGB"

2.3.11.4.2. Property `JSON config > logo > oneOf > item 2 > chafa > colorSpace > oneOf > item 1`


Type	`const`
Required	No

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

Specific value: "DIN99D"

2.3.11.5. Property `JSON config > logo > oneOf > item 2 > chafa > ditherMode`


Type	`combining`
Required	No

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. Property `JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 0`


Type	`const`
Required	No

Description: No dithering

Specific value: "NONE"

2.3.11.5.2. Property `JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 1`


Type	`const`
Required	No

Description: Ordered dithering (Bayer or similar)

Specific value: "ORDERED"

2.3.11.5.3. Property `JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 2`


Type	`const`
Required	No

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

Specific value: "DIFFUSION"

3. Property `JSON config > general`


Type	`object`
Required	No
Additional properties	Not allowed

Description: General Fastfetch configuration

Property	Pattern	Type	Deprecated	Definition	Title/Description
- thread	No	boolean	No	-	Use separate threads for HTTP requests
- escapeBedrock	No	boolean	No	-	On Bedrock Linux, whether to escape the bedrock jail
- playerName	No	string	No	-	The name of the player to use for Media and Player modules. Linux only
- dsForceDrm	No	Combination	No	-	Force display detection to use DRM (Linux only)
- wmiTimeout	No	integer	No	-	Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only
- processingTimeout	No	integer	No	-	Set the timeout (ms) when waiting for child processes, `-1` for no timeout
- preRun	No	string	No	-	Command to run before printing logos
- detectVersion	No	boolean	No	-	Whether to detect and display component versions. Mainly for benchmarking

3.1. Property `JSON config > general > thread`


Type	`boolean`
Required	No
Default	`true`

Description: Use separate threads for HTTP requests

3.2. Property `JSON config > general > escapeBedrock`


Type	`boolean`
Required	No
Default	`true`

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

3.3. Property `JSON config > general > playerName`


Type	`string`
Required	No

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

3.4. Property `JSON config > general > dsForceDrm`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`false`

Description: Force display detection to use DRM (Linux only)

One of(Option)
item 0
item 1
item 2

3.4.1. Property `JSON config > general > dsForceDrm > oneOf > item 0`


Type	`const`
Required	No

Description: Try wayland, then x11, then drm

Specific value: false

3.4.2. Property `JSON config > general > dsForceDrm > oneOf > item 1`


Type	`const`
Required	No

Description: Use /sys/class/drm only

Specific value: "sysfs-only"

3.4.3. Property `JSON config > general > dsForceDrm > oneOf > item 2`


Type	`const`
Required	No

Description: Try libdrm first, then sysfs if libdrm fails

Specific value: true

3.5. Property `JSON config > general > wmiTimeout`


Type	`integer`
Required	No
Default	`5000`

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

3.6. Property `JSON config > general > processingTimeout`


Type	`integer`
Required	No
Default	`5000`

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

3.7. Property `JSON config > general > preRun`


Type	`string`
Required	No
Default	`""`

Description: Command to run before printing logos

3.8. Property `JSON config > general > detectVersion`


Type	`boolean`
Required	No
Default	`true`

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

4. Property `JSON config > display`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Configure output formatting

Property	Pattern	Type	Deprecated	Definition	Title/Description
- stat	No	Combination	No	-	Show execution time (in ms) for individual modules, optionally above a threshold
- pipe	No	boolean	No	-	Whether to disable colors (auto-detected based on isatty(1) by default)
- showErrors	No	boolean	No	-	Whether to print errors to the console. If false, modules that error are ignored
- disableLinewrap	No	boolean	No	-	Whether to disable line wrap during execution
- hideCursor	No	boolean	No	-	Whether to hide the cursor during execution
- separator	No	string	No	-	Separator between the key and value
- color	No	Combination	No	-	Color of keys and titles
- brightColor	No	boolean	No	-	Whether to print keys, titles, and the ASCII logo in bright colors
- key	No	object	No	-	Configure how module keys are displayed
- size	No	object	No	-	Configure how sizes are displayed
- temp	No	object	No	-	Configure how temperatures are displayed
- bar	No	object	No	-	Bar configuration
- percent	No	object	No	-	Configure how percentages are displayed
- freq	No	object	No	-	Configure how frequencies are displayed
- duration	No	object	No	-	Configure how durations are displayed
- fraction	No	object	No	-	Configure how fractional values are displayed
- common	No	object	No	-	Override the settings for `duration`, `fraction`, `freq`, `percent`, `size`, and `temp` Place this before those properties to use it as their default configuration
- noBuffer	No	boolean	No	-	Whether to disable stdout buffering
- constants	No	array of string	No	-	List of strings available for use in module custom formats

4.1. Property `JSON config > display > stat`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: Show execution time (in ms) for individual modules, optionally above a threshold

One of(Option)
item 0
item 1

4.1.1. Property `JSON config > display > stat > oneOf > item 0`


Type	`boolean`
Required	No
Default	`false`

4.1.2. Property `JSON config > display > stat > oneOf > item 1`


Type	`integer`
Required	No

Restrictions
Minimum	≥ 1

4.2. Property `JSON config > display > pipe`


Type	`boolean`
Required	No
Default	`false`

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

4.3. Property `JSON config > display > showErrors`


Type	`boolean`
Required	No
Default	`false`

Description: Whether to print errors to the console. If false, modules that error are ignored

4.4. Property `JSON config > display > disableLinewrap`


Type	`boolean`
Required	No
Default	`true`

Description: Whether to disable line wrap during execution

4.5. Property `JSON config > display > hideCursor`


Type	`boolean`
Required	No
Default	`true`

Description: Whether to hide the cursor during execution

4.6. Property `JSON config > display > separator`


Type	`string`
Required	No
Default	`": "`

Description: Separator between the key and value

4.7. Property `JSON config > display > color`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: Color of keys and titles

One of(Option)
colors
item 1

4.7.1. Property `JSON config > display > color > oneOf > colors`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color for both keys and titles

4.7.2. Property `JSON config > display > color > oneOf > item 1`


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- keys	No	object	No	Same as 1	Color of keys
- title	No	object	No	Same as 1	Color of titles
- output	No	object	No	Same as 1	Color of module output
- separator	No	object	No	Same as 1	Color of the key-value separator

4.7.2.1. Property `JSON config > display > color > oneOf > item 1 > keys`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color of keys

4.7.2.2. Property `JSON config > display > color > oneOf > item 1 > title`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color of titles

4.7.2.3. Property `JSON config > display > color > oneOf > item 1 > output`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color of module output

4.7.2.4. Property `JSON config > display > color > oneOf > item 1 > separator`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	1

Description: Color of the key-value separator

4.8. Property `JSON config > display > brightColor`


Type	`boolean`
Required	No
Default	`true`

Description: Whether to print keys, titles, and the ASCII logo in bright colors

4.9. Property `JSON config > display > key`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Configure how module keys are displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- width	No	integer	No	-	Key width in characters. Set to 0 to disable alignment
- type	No	Combination	No	-	Whether to show a built-in icon before string keys
- paddingLeft	No	integer	No	-	Left padding for keys

4.9.1. Property `JSON config > display > key > width`


Type	`integer`
Required	No
Default	`0`

Description: Key width in characters. Set to 0 to disable alignment

Restrictions
Minimum	≥ 0

4.9.2. Property `JSON config > display > key > type`


Type	`combining`
Required	No
Default	`"string"`

Description: Whether to show a built-in 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. Property `JSON config > display > key > type > oneOf > item 0`


Type	`const`
Required	No

Description: Disable keys

Specific value: "none"

4.9.2.2. Property `JSON config > display > key > type > oneOf > item 1`


Type	`const`
Required	No

Description: Show string keys

Specific value: "string"

4.9.2.3. Property `JSON config > display > key > type > oneOf > item 2`


Type	`const`
Required	No

Description: Show the built-in icon (requires a recent Nerd Font)

Specific value: "icon"

4.9.2.4. Property `JSON config > display > key > type > oneOf > item 3`


Type	`const`
Required	No

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

Specific value: "both"

4.9.2.5. Property `JSON config > display > key > type > oneOf > item 4`


Type	`const`
Required	No

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

Specific value: "both-0"

4.9.2.6. Property `JSON config > display > key > type > oneOf > item 5`


Type	`const`
Required	No

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

Specific value: "both-1"

4.9.2.7. Property `JSON config > display > key > type > oneOf > item 6`


Type	`const`
Required	No

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

Specific value: "both-2"

4.9.2.8. Property `JSON config > display > key > type > oneOf > item 7`


Type	`const`
Required	No

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

Specific value: "both-3"

4.9.2.9. Property `JSON config > display > key > type > oneOf > item 8`


Type	`const`
Required	No

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

Specific value: "both-4"

4.9.3. Property `JSON config > display > key > paddingLeft`


Type	`integer`
Required	No
Default	`0`

Description: Left padding for keys

Restrictions
Minimum	≥ 0

4.10. Property `JSON config > display > size`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Configure how sizes are displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- binaryPrefix	No	Combination	No	-	Set the binary prefix to use when formatting sizes
- maxPrefix	No	enum (of string)	No	-	Set the largest binary prefix to use when formatting sizes
- ndigits	No	integer	No	-	Number of decimal places to use when formatting sizes
- spaceBeforeUnit	No	string	No	In #/$defs/spaceBeforeUnit	Whether to insert a space before the unit

4.10.1. Property `JSON config > display > size > binaryPrefix`


Type	`combining`
Required	No
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. Property `JSON config > display > size > binaryPrefix > oneOf > item 0`


Type	`const`
Required	No

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

Specific value: "iec"

4.10.1.2. Property `JSON config > display > size > binaryPrefix > oneOf > item 1`


Type	`const`
Required	No

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

Specific value: "si"

4.10.1.3. Property `JSON config > display > size > binaryPrefix > oneOf > item 2`


Type	`const`
Required	No

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

Specific value: "jedec"

4.10.2. Property `JSON config > display > size > maxPrefix`


Type	`enum (of string)`
Required	No
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. Property `JSON config > display > size > ndigits`


Type	`integer`
Required	No
Default	`2`

Description: Number of decimal places to use when formatting sizes

Restrictions
Minimum	≥ 0
Maximum	≤ 9

4.10.4. Property `JSON config > display > size > spaceBeforeUnit`


Type	`combining`
Required	No
Defined in	#/$defs/spaceBeforeUnit

Description: Whether to insert a space before the unit

One of(Option)
item 0
item 1
item 2

4.10.4.1. Property `JSON config > display > size > spaceBeforeUnit > oneOf > item 0`


Type	`const`
Required	No

Description: Use the default behavior of the module

Specific value: "default"

4.10.4.2. Property `JSON config > display > size > spaceBeforeUnit > oneOf > item 1`


Type	`const`
Required	No

Description: Always add a space before the unit

Specific value: "always"

4.10.4.3. Property `JSON config > display > size > spaceBeforeUnit > oneOf > item 2`


Type	`const`
Required	No

Description: Never add a space before the unit

Specific value: "never"

4.11. Property `JSON config > display > temp`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Configure how temperatures are displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- unit	No	Combination	No	-	Set the unit of temperature
- ndigits	No	integer	No	-	Number of decimal places to use when formatting temperatures
- color	No	object	No	-	Colors used for different temperature states
- spaceBeforeUnit	No	string	No	Same as spaceBeforeUnit	Whether to insert a space before the unit

4.11.1. Property `JSON config > display > temp > unit`


Type	`combining`
Required	No
Default	`"D"`

Description: Set the unit of temperature

One of(Option)
item 0
item 1
item 2
item 3

4.11.1.1. Property `JSON config > display > temp > unit > oneOf > item 0`


Type	`const`
Required	No

Description: Celsius

Specific value: "C"

4.11.1.2. Property `JSON config > display > temp > unit > oneOf > item 1`


Type	`const`
Required	No

Description: Fahrenheit

Specific value: "F"

4.11.1.3. Property `JSON config > display > temp > unit > oneOf > item 2`


Type	`const`
Required	No

Description: Kelvin

Specific value: "K"

4.11.1.4. Property `JSON config > display > temp > unit > oneOf > item 3`


Type	`const`
Required	No

Description: Default (alias for Celsius)

Specific value: "D"

4.11.2. Property `JSON config > display > temp > ndigits`


Type	`integer`
Required	No
Default	`1`

Description: Number of decimal places to use when formatting temperatures

Restrictions
Minimum	≥ 0
Maximum	≤ 9

4.11.3. Property `JSON config > display > temp > color`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Colors used for different temperature states

Property	Pattern	Type	Deprecated	Definition	Title/Description
- green	No	object	No	In #/$defs/colors	Color used in green state
- yellow	No	object	No	In #/$defs/colors	Color used in yellow state
- red	No	object	No	In #/$defs/colors	Color used in red state

4.11.3.1. Property `JSON config > display > temp > color > green`


Type	`combining`
Required	No
Additional properties	Any 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. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

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. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.11.3.2. Property `JSON config > display > temp > color > yellow`


Type	`combining`
Required	No
Additional properties	Any 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. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

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. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.11.3.3. Property `JSON config > display > temp > color > red`


Type	`combining`
Required	No
Additional properties	Any 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. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

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. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.11.4. Property `JSON config > display > temp > spaceBeforeUnit`


Type	`combining`
Required	No
Same definition as	spaceBeforeUnit

Description: Whether to insert a space before the unit

4.12. Property `JSON config > display > bar`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Bar configuration

Property	Pattern	Type	Deprecated	Definition	Title/Description
- char	No	object	No	-	Characters used in the bar
- border	No	Combination	No	-	-
- color	No	Combination	No	-	-
- width	No	integer	No	-	Width of the bar in characters

4.12.1. Property `JSON config > display > bar > char`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Characters used in the bar

Property	Pattern	Type	Deprecated	Definition	Title/Description
- elapsed	No	string	No	-	Character used for the elapsed portion
- total	No	string	No	-	Character used for the remaining portion

4.12.1.1. Property `JSON config > display > bar > char > elapsed`


Type	`string`
Required	No
Default	`"■"`

Description: Character used for the elapsed portion

4.12.1.2. Property `JSON config > display > bar > char > total`


Type	`string`
Required	No
Default	`"-"`

Description: Character used for the remaining portion

4.12.2. Property `JSON config > display > bar > border`


Type	`combining`
Required	No
Additional properties	Any type allowed

One of(Option)
item 0
item 1

4.12.2.1. Property `JSON config > display > bar > border > oneOf > item 0`


Type	`null`
Required	No

Description: Disable bar borders

4.12.2.2. Property `JSON config > display > bar > border > oneOf > item 1`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Strings used for percentage bar borders

Property	Pattern	Type	Deprecated	Definition	Title/Description
- left	No	string	No	-	String used for the left border
- right	No	string	No	-	String used for the right border
- leftElapsed	No	string	No	-	If both `leftElapsed` and `rightElapsed` are set, the border is used as part of the bar content
- rightElapsed	No	string	No	-	If both `leftElapsed` and `rightElapsed` are set, the border is used as part of the bar content

4.12.2.2.1. Property `JSON config > display > bar > border > oneOf > item 1 > left`


Type	`string`
Required	No
Default	`"[ "`

Description: String used for the left border

4.12.2.2.2. Property `JSON config > display > bar > border > oneOf > item 1 > right`


Type	`string`
Required	No
Default	`" ]"`

Description: String used for the right border

4.12.2.2.3. Property `JSON config > display > bar > border > oneOf > item 1 > leftElapsed`


Type	`string`
Required	No
Default	`""`

Description: If both leftElapsed and rightElapsed are set, the border is used as part of the bar content

4.12.2.2.4. Property `JSON config > display > bar > border > oneOf > item 1 > rightElapsed`


Type	`string`
Required	No
Default	`""`

Description: If both leftElapsed and rightElapsed are set, the border is used as part of the bar content

4.12.3. Property `JSON config > display > bar > color`


Type	`combining`
Required	No
Additional properties	Any type allowed

One of(Option)
item 0
item 1

4.12.3.1. Property `JSON config > display > bar > color > oneOf > item 0`


Type	`null`
Required	No

Description: Disable color in percentage bars

4.12.3.2. Property `JSON config > display > bar > color > oneOf > item 1`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Colors used for percentage bars

Property	Pattern	Type	Deprecated	Definition	Title/Description
- elapsed	No	object	No	In #/$defs/colors	Color used for the elapsed portion of percentage bars By default, it is selected automatically from `percent.color.{green,yellow,red}`
- total	No	object	No	In #/$defs/colors	Color used for the remaining portion of percentage bars
- border	No	object	No	In #/$defs/colors	Color used for percentage bar borders

4.12.3.2.1. Property `JSON config > display > bar > color > oneOf > item 1 > elapsed`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`"auto"`
Defined in	#/$defs/colors

Description: Color used for the elapsed portion of percentage bars By default, it is selected automatically from percent.color.{green,yellow,red}

One of(Option)
item 0
item 1

4.12.3.2.1.1. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

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. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.12.3.2.2. Property `JSON config > display > bar > color > oneOf > item 1 > total`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`"light_white"`
Defined in	#/$defs/colors

Description: Color used for the remaining portion of percentage bars

One of(Option)
item 0
item 1

4.12.3.2.2.1. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

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. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.12.3.2.3. Property `JSON config > display > bar > color > oneOf > item 1 > border`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`"light_white"`
Defined in	#/$defs/colors

Description: Color used for percentage bar borders

One of(Option)
item 0
item 1

4.12.3.2.3.1. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

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. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.12.4. Property `JSON config > display > bar > width`


Type	`integer`
Required	No
Default	`10`

Description: Width of the bar in characters

Restrictions
Minimum	≥ 1

4.13. Property `JSON config > display > percent`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Configure how percentages are displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	object	No	In #/$defs/percentType	Percentage output style
- ndigits	No	number	No	-	Number of decimal places to use when formatting percentages
- color	No	object	No	-	Colors used for different percentage states
- spaceBeforeUnit	No	string	No	Same as spaceBeforeUnit	Whether to insert a space before the unit
- width	No	integer	No	-	Width of the percentage number in characters

4.13.1. Property `JSON config > display > percent > type`


Type	`combining`
Required	No
Additional properties	Any type allowed
Defined in	#/$defs/percentType

Description: Percentage output style

One of(Option)
item 0
item 1

4.13.1.1. Property `JSON config > display > percent > type > oneOf > item 0`


Type	`number`
Required	No
Default	`9`

Description: 0 uses the global setting; 1 shows the percentage number; 2 shows a multicolor bar; 3 shows both; 6 shows only the bar; 9 shows a colored number; 10 shows a monochrome bar

Restrictions
Minimum	≥ 0
Maximum	≤ 255

4.13.1.2. Property `JSON config > display > percent > type > oneOf > item 1`


Type	`array of enum (of string)`
Required	No
Default	`["num", "num-color"]`

Description: Array of style flags

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	True
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
item 1 items	-

4.13.1.2.1. JSON config > display > percent > type > oneOf > item 1 > item 1 items


Type	`enum (of string)`
Required	No

Must be one of:

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

4.13.2. Property `JSON config > display > percent > ndigits`


Type	`number`
Required	No
Default	`0`

Description: Number of decimal places to use when formatting percentages

Restrictions
Minimum	≥ 0
Maximum	≤ 9

4.13.3. Property `JSON config > display > percent > color`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Colors used for different percentage states

Property	Pattern	Type	Deprecated	Definition	Title/Description
- green	No	object	No	In #/$defs/colors	Color used in green state
- yellow	No	object	No	In #/$defs/colors	Color used in yellow state
- red	No	object	No	In #/$defs/colors	Color used in red state

4.13.3.1. Property `JSON config > display > percent > color > green`


Type	`combining`
Required	No
Additional properties	Any 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. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

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. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.13.3.2. Property `JSON config > display > percent > color > yellow`


Type	`combining`
Required	No
Additional properties	Any 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. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

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. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.13.3.3. Property `JSON config > display > percent > color > red`


Type	`combining`
Required	No
Additional properties	Any 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. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`


Type	`string`
Required	No

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. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`


Type	`null`
Required	No

4.13.4. Property `JSON config > display > percent > spaceBeforeUnit`


Type	`combining`
Required	No
Same definition as	spaceBeforeUnit

Description: Whether to insert a space before the unit

4.13.5. Property `JSON config > display > percent > width`


Type	`integer`
Required	No
Default	`0`

Description: Width of the percentage number in characters

Restrictions
Minimum	≥ 0

4.14. Property `JSON config > display > freq`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Configure how frequencies are displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- ndigits	No	Combination	No	-	Set the number of decimal places to display when formatting frequency values
- spaceBeforeUnit	No	string	No	Same as spaceBeforeUnit	Whether to insert a space before the unit

4.14.1. Property `JSON config > display > freq > ndigits`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`2`

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

One of(Option)
item 0
item 1

4.14.1.1. Property `JSON config > display > freq > ndigits > oneOf > item 0`


Type	`integer`
Required	No

Description: An integer displays the frequency in GHz with the specified number of decimal places

Restrictions
Minimum	≥ 0
Maximum	≤ 9

4.14.1.2. Property `JSON config > display > freq > ndigits > oneOf > item 1`


Type	`null`
Required	No

Description: A null value displays the frequency as an integer in MHz

4.14.2. Property `JSON config > display > freq > spaceBeforeUnit`


Type	`combining`
Required	No
Same definition as	spaceBeforeUnit

Description: Whether to insert a space before the unit

4.15. Property `JSON config > display > duration`


Type	`object`
Required	No
Additional properties	Any type allowed

Description: Configure how durations are displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- abbreviation	No	boolean	No	-	Whether to abbreviate durations If true, values are shown as "1h 2m" instead of "1 hour, 2 mins"
- spaceBeforeUnit	No	string	No	Same as spaceBeforeUnit	Whether to insert a space before the unit

4.15.1. Property `JSON config > display > duration > abbreviation`


Type	`boolean`
Required	No
Default	`false`

Description: Whether to abbreviate durations If true, values are shown as "1h 2m" instead of "1 hour, 2 mins"

4.15.2. Property `JSON config > display > duration > spaceBeforeUnit`


Type	`combining`
Required	No
Same definition as	spaceBeforeUnit

Description: Whether to insert a space before the unit

4.16. Property `JSON config > display > fraction`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Configure how fractional values are displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- ndigits	No	Combination	No	-	-
- trailingZeros	No	Combination	No	-	Control when trailing zeros are preserved

4.16.1. Property `JSON config > display > fraction > ndigits`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`2`

One of(Option)
item 0
item 1

4.16.1.1. Property `JSON config > display > fraction > ndigits > oneOf > item 0`


Type	`number`
Required	No

Description: Number of decimal places to use when formatting fractional values

Restrictions
Minimum	≥ 0
Maximum	≤ 9

4.16.1.2. Property `JSON config > display > fraction > ndigits > oneOf > item 1`


Type	`null`
Required	No

Description: Automatically determine the number of decimal places based on the value

4.16.2. Property `JSON config > display > fraction > trailingZeros`


Type	`combining`
Required	No
Additional properties	Any type allowed
Default	`null`

Description: Control when trailing zeros are preserved

One of(Option)
item 0
item 1
item 2
item 3

4.16.2.1. Property `JSON config > display > fraction > trailingZeros > oneOf > item 0`


Type	`null`
Required	No

Description: Same as default

4.16.2.2. Property `JSON config > display > fraction > trailingZeros > oneOf > item 1`


Type	`const`
Required	No

Description: Use the built-in behavior

Specific value: "default"

4.16.2.3. Property `JSON config > display > fraction > trailingZeros > oneOf > item 2`


Type	`const`
Required	No

Description: Always keep trailing zeros

Specific value: "always"

4.16.2.4. Property `JSON config > display > fraction > trailingZeros > oneOf > item 3`


Type	`const`
Required	No

Description: Never keep trailing zeros

Specific value: "never"

4.17. Property `JSON config > display > common`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Override the settings for duration, fraction, freq, percent, size, and temp Place this before those properties to use it as their default configuration

Property	Pattern	Type	Deprecated	Definition	Title/Description
- ndigits	No	integer	No	-	Default number of decimal places to display
- spaceBeforeUnit	No	string	No	Same as spaceBeforeUnit	Whether to insert a space before the unit

4.17.1. Property `JSON config > display > common > ndigits`


Type	`integer`
Required	No

Description: Default number of decimal places to display

Restrictions
Minimum	≥ 0
Maximum	≤ 9

4.17.2. Property `JSON config > display > common > spaceBeforeUnit`


Type	`combining`
Required	No
Same definition as	spaceBeforeUnit

Description: Whether to insert a space before the unit

4.18. Property `JSON config > display > noBuffer`


Type	`boolean`
Required	No
Default	`false`

Description: Whether to disable stdout buffering

4.19. Property `JSON config > display > constants`


Type	`array of string`
Required	No

Description: List of strings available for use in module custom formats

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
constants items	-

4.19.1. JSON config > display > constants > constants items


Type	`string`
Required	No

5. Property `JSON config > modules`


Type	`array`
Required	No

Description: Modules to run

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
modules items	-

5.1. JSON config > modules > modules items


Type	`combining`
Required	No
Additional properties	Any type allowed

Any of(Option)
item 0
item 1

5.1.1. Property `JSON config > modules > modules items > anyOf > item 0`


Type	`enum (of string)`
Required	No

Description: Run a module with its default configuration

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. Property `JSON config > modules > modules items > anyOf > item 1`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: Run a module with a custom configuration

Property	Pattern	Type	Deprecated	Definition	Title/Description
+ type	No	string	No	-	-

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
Logo
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. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break`

Title: Break


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print an empty line
- condition	No	object	No	In #/$defs/conditions	Show the module only if these conditions are met

5.1.2.1.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > type`


Type	`const`
Required	No

Description: Print an empty line

Specific value: "break"

5.1.2.1.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Defined in	#/$defs/conditions

Description: Show the module only if these conditions are met

Property	Pattern	Type	Deprecated	Definition	Title/Description
- system	No	Combination	No	-	System to match
- !system	No	Combination	No	-	System not to match
- arch	No	Combination	No	-	Architecture to match
- !arch	No	Combination	No	-	Architecture not to match
- succeeded	No	Combination	No	-	Whether the module succeeded in the last run

5.1.2.1.2.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: System to match

One of(Option)
systems
item 1
item 2

5.1.2.1.2.1.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system > oneOf > systems`


Type	`enum (of string)`
Required	No
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. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system > oneOf > item 1`


Type	`array`
Required	No

Description: Array of systems to match

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	True
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
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


Type	`enum (of string)`
Required	No
Same definition as	modules_items_anyOf_i1_oneOf_i0_condition_system_oneOf_i0

5.1.2.1.2.1.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system > oneOf > item 2`


Type	`null`
Required	No

Description: Set to null to disable this condition

5.1.2.1.2.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: System not to match

One of(Option)
systems
item 1
item 2

5.1.2.1.2.2.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system > oneOf > systems`


Type	`enum (of string)`
Required	No
Same definition as	modules_items_anyOf_i1_oneOf_i0_condition_system_oneOf_i0

5.1.2.1.2.2.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system > oneOf > item 1`


Type	`array`
Required	No

Description: Array of systems not to match

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	True
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
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


Type	`enum (of string)`
Required	No
Same definition as	modules_items_anyOf_i1_oneOf_i0_condition_system_oneOf_i0

5.1.2.1.2.2.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system > oneOf > item 2`


Type	`null`
Required	No

Description: Set to null to disable this condition

5.1.2.1.2.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: Architecture to match

One of(Option)
architectures
item 1
item 2

5.1.2.1.2.3.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch > oneOf > architectures`


Type	`enum (of string)`
Required	No
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. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch > oneOf > item 1`


Type	`array`
Required	No

Description: Array of architectures to match

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	True
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
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


Type	`enum (of string)`
Required	No
Same definition as	modules_items_anyOf_i1_oneOf_i0_condition_arch_oneOf_i0

5.1.2.1.2.3.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch > oneOf > item 2`


Type	`null`
Required	No

Description: Set to null to disable this condition

5.1.2.1.2.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: Architecture not to match

One of(Option)
architectures
item 1
item 2

5.1.2.1.2.4.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch > oneOf > architectures`


Type	`enum (of string)`
Required	No
Same definition as	modules_items_anyOf_i1_oneOf_i0_condition_arch_oneOf_i0

5.1.2.1.2.4.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch > oneOf > item 1`


Type	`array`
Required	No

Description: Array of architectures not to match

	Array restrictions
Min items	N/A
Max items	N/A
Items unicity	True
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
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


Type	`enum (of string)`
Required	No
Same definition as	modules_items_anyOf_i1_oneOf_i0_condition_arch_oneOf_i0

5.1.2.1.2.4.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch > oneOf > item 2`


Type	`null`
Required	No

Description: Set to null to disable this condition

5.1.2.1.2.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > succeeded`


Type	`combining`
Required	No
Additional properties	Any 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. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > succeeded > oneOf > item 0`


Type	`boolean`
Required	No

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

5.1.2.1.2.5.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > succeeded > oneOf > item 1`


Type	`null`
Required	No

Description: Set to null to disable this condition

5.1.2.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery`

Title: Battery


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print battery information
- useSetupApi	No	boolean	No	-	Whether to use the `CM API` on Windows to detect battery information. Supports multiple batteries, but is slower (Windows only)
- temp	No	object	No	In #/$defs/temperature	Whether to detect and display temperature, if supported
- percent	No	object	No	In #/$defs/percent	Color thresholds for percentage output
- key	No	string	No	In #/$defs/key	Module key Use a single space (` `) to hide the key
- keyColor	No	object	No	In #/$defs/keyColor	Color of the module key. Overrides `display.color.key`
- keyIcon	No	string	No	In #/$defs/keyIcon	Icon to display when `display.key.type` is set to `icon`
- keyWidth	No	integer	No	In #/$defs/keyWidth	Width of the module key. Overrides `display.keyWidth`
- outputColor	No	object	No	In #/$defs/outputColor	Color of the module output. Overrides `display.color.output`
- format	No	string	No	In #/$defs/batteryFormat	Output format for the `Battery` module. 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 manufacture 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)
- condition	No	object	No	Same as condition	Show the module only if these conditions are met

5.1.2.2.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > type`


Type	`const`
Required	No

Description: Print battery information

Specific value: "battery"

5.1.2.2.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > useSetupApi`


Type	`boolean`
Required	No
Default	`false`

Description: Whether to use the CM API on Windows to detect battery information. Supports multiple batteries, but is slower (Windows only)

5.1.2.2.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp`


Type	`combining`
Required	No
Additional properties	Any type allowed
Defined in	#/$defs/temperature

Description: Whether to detect and display temperature, if supported

One of(Option)
item 0
item 1

5.1.2.2.3.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 0`


Type	`boolean`
Required	No
Default	`false`

5.1.2.2.3.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 1`


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- green	No	integer	No	-	Values in Celsius below this threshold are shown in green
- yellow	No	integer	No	-	Values in Celsius between the green and yellow thresholds are shown in yellow. Values above the yellow threshold are shown in red

5.1.2.2.3.2.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 1 > green`


Type	`integer`
Required	No

Description: Values in Celsius below this threshold are shown in green

Restrictions
Minimum	≥ 0
Maximum	≤ 100

5.1.2.2.3.2.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 1 > yellow`


Type	`integer`
Required	No

Description: Values in Celsius between the green and yellow thresholds are shown in yellow. Values above the yellow threshold are shown in red

Restrictions
Minimum	≥ 0
Maximum	≤ 100

5.1.2.2.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent`


Type	`object`
Required	No
Additional properties	Not allowed
Defined in	#/$defs/percent

Description: Color thresholds for percentage output

Property	Pattern	Type	Deprecated	Definition	Title/Description
- green	No	integer	No	-	Values below this threshold are shown in green
- yellow	No	integer	No	-	Values between the green and yellow thresholds are shown in yellow. Values above the yellow threshold are shown in red
- type	No	object	No	Same as type	Percentage output style

5.1.2.2.4.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent > green`


Type	`integer`
Required	No

Description: Values below this threshold are shown in green

Restrictions
Minimum	≥ 0
Maximum	≤ 100

5.1.2.2.4.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent > yellow`


Type	`integer`
Required	No

Description: Values between the green and yellow thresholds are shown in yellow. Values above the yellow threshold are shown in red

Restrictions
Minimum	≥ 0
Maximum	≤ 100

5.1.2.2.4.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent > type`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	type

Description: Percentage output style

5.1.2.2.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > key`


Type	`string`
Required	No
Defined in	#/$defs/key

Description: Module key Use a single space ( ) to hide the key

Restrictions
Min length	1

5.1.2.2.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Defined in	#/$defs/keyColor

Description: Color of the module key. Overrides display.color.key

5.1.2.2.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > keyIcon`


Type	`string`
Required	No
Defined in	#/$defs/keyIcon

Description: Icon to display when display.key.type is set to icon

5.1.2.2.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > keyWidth`


Type	`integer`
Required	No
Defined in	#/$defs/keyWidth

Description: Width of the module key. Overrides display.keyWidth

Restrictions
Minimum	≥ 1

5.1.2.2.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Defined in	#/$defs/outputColor

Description: Color of the module output. Overrides display.color.output

5.1.2.2.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > format`


Type	`string`
Required	No
Defined in	#/$defs/batteryFormat

Description: Output format for the Battery module. 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 manufacture 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)

5.1.2.2.11. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Show the module only if these conditions are met

5.1.2.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS`

Title: BIOS


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print first-stage bootloader information (name, version, release date, etc.)
- key	No	string	No	Same as key	Module key Use a single space (` `) to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key. Overrides `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Icon to display when `display.key.type` is set to `icon`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Overrides `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Color of the module output. Overrides `display.color.output`
- format	No	string	No	In #/$defs/biosFormat	Output format for the `BIOS` module. 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
- condition	No	object	No	Same as condition	Show the module only if these conditions are met

5.1.2.3.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > type`


Type	`const`
Required	No

Description: Print first-stage bootloader information (name, version, release date, etc.)

Specific value: "bios"

5.1.2.3.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > key`


Type	`string`
Required	No
Same definition as	key

Description: Module key Use a single space ( ) to hide the key

5.1.2.3.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key. Overrides display.color.key

5.1.2.3.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Icon to display when display.key.type is set to icon

5.1.2.3.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key. Overrides display.keyWidth

5.1.2.3.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Color of the module output. Overrides display.color.output

5.1.2.3.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > format`


Type	`string`
Required	No
Defined in	#/$defs/biosFormat

Description: Output format for the BIOS module. 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

5.1.2.3.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Show the module only if these conditions are met

5.1.2.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth`

Title: Bluetooth


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	List connected Bluetooth devices
- showDisconnected	No	boolean	No	-	Whether to show disconnected Bluetooth devices
- percent	No	object	No	Same as percent	Color thresholds for percentage output
- key	No	string	No	Same as key	Module key Use a single space (` `) to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key. Overrides `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Icon to display when `display.key.type` is set to `icon`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Overrides `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Color of the module output. Overrides `display.color.output`
- format	No	string	No	In #/$defs/bluetoothFormat	Output format for the `Bluetooth` module. 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
- condition	No	object	No	Same as condition	Show the module only if these conditions are met

5.1.2.4.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > type`


Type	`const`
Required	No

Description: List connected Bluetooth devices

Specific value: "bluetooth"

5.1.2.4.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > showDisconnected`


Type	`boolean`
Required	No
Default	`false`

Description: Whether to show disconnected Bluetooth devices

5.1.2.4.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > percent`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	percent

Description: Color thresholds for percentage output

5.1.2.4.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > key`


Type	`string`
Required	No
Same definition as	key

Description: Module key Use a single space ( ) to hide the key

5.1.2.4.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key. Overrides display.color.key

5.1.2.4.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Icon to display when display.key.type is set to icon

5.1.2.4.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key. Overrides display.keyWidth

5.1.2.4.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Color of the module output. Overrides display.color.output

5.1.2.4.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > format`


Type	`string`
Required	No
Defined in	#/$defs/bluetoothFormat

Description: Output format for the Bluetooth module. 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

5.1.2.4.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Show the module only if these conditions are met

5.1.2.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio`

Title: Bluetooth Radio


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	List Bluetooth radios (supported versions, vendors, etc.)
- key	No	string	No	Same as key	Module key Use a single space (` `) to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key. Overrides `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Icon to display when `display.key.type` is set to `icon`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Overrides `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Color of the module output. Overrides `display.color.output`
- format	No	string	No	In #/$defs/bluetoothradioFormat	Output format for the `BluetoothRadio` module. 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
- condition	No	object	No	Same as condition	Show the module only if these conditions are met

5.1.2.5.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > type`


Type	`const`
Required	No

Description: List Bluetooth radios (supported versions, vendors, etc.)

Specific value: "bluetoothradio"

5.1.2.5.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > key`


Type	`string`
Required	No
Same definition as	key

Description: Module key Use a single space ( ) to hide the key

5.1.2.5.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key. Overrides display.color.key

5.1.2.5.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Icon to display when display.key.type is set to icon

5.1.2.5.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key. Overrides display.keyWidth

5.1.2.5.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Color of the module output. Overrides display.color.output

5.1.2.5.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > format`


Type	`string`
Required	No
Defined in	#/$defs/bluetoothradioFormat

Description: Output format for the BluetoothRadio module. 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

5.1.2.5.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Show the module only if these conditions are met

5.1.2.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board`

Title: Board


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print motherboard name and other information
- key	No	string	No	Same as key	Module key Use a single space (` `) to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key. Overrides `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Icon to display when `display.key.type` is set to `icon`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Overrides `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Color of the module output. Overrides `display.color.output`
- format	No	string	No	In #/$defs/boardFormat	Output format for the `Board` module. See Wiki for formatting syntax 1. {name}: Board name 2. {vendor}: Board vendor 3. {version}: Board version 4. {serial}: Board serial number
- condition	No	object	No	Same as condition	Show the module only if these conditions are met

5.1.2.6.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > type`


Type	`const`
Required	No

Description: Print motherboard name and other information

Specific value: "board"

5.1.2.6.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > key`


Type	`string`
Required	No
Same definition as	key

Description: Module key Use a single space ( ) to hide the key

5.1.2.6.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key. Overrides display.color.key

5.1.2.6.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Icon to display when display.key.type is set to icon

5.1.2.6.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key. Overrides display.keyWidth

5.1.2.6.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Color of the module output. Overrides display.color.output

5.1.2.6.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > format`


Type	`string`
Required	No
Defined in	#/$defs/boardFormat

Description: Output format for the Board module. See Wiki for formatting syntax 1. {name}: Board name 2. {vendor}: Board vendor 3. {version}: Board version 4. {serial}: Board serial number

5.1.2.6.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Show the module only if these conditions are met

5.1.2.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager`

Title: Boot Manager


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print second-stage bootloader information (name, firmware, etc.)
- key	No	string	No	Same as key	Module key Use a single space (` `) to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key. Overrides `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Icon to display when `display.key.type` is set to `icon`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Overrides `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Color of the module output. Overrides `display.color.output`
- format	No	string	No	In #/$defs/bootmgrFormat	Output format for the `Bootmgr` module. 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
- condition	No	object	No	Same as condition	Show the module only if these conditions are met

5.1.2.7.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > type`


Type	`const`
Required	No

Description: Print second-stage bootloader information (name, firmware, etc.)

Specific value: "bootmgr"

5.1.2.7.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > key`


Type	`string`
Required	No
Same definition as	key

Description: Module key Use a single space ( ) to hide the key

5.1.2.7.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key. Overrides display.color.key

5.1.2.7.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Icon to display when display.key.type is set to icon

5.1.2.7.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key. Overrides display.keyWidth

5.1.2.7.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Color of the module output. Overrides display.color.output

5.1.2.7.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > format`


Type	`string`
Required	No
Defined in	#/$defs/bootmgrFormat

Description: Output format for the Bootmgr module. 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

5.1.2.7.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Show the module only if these conditions are met

5.1.2.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness`

Title: Brightness


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print the current brightness level of your monitors
- percent	No	object	No	Same as percent	Color thresholds for percentage output
- ddcciSleep	No	integer	No	-	Sleep time in milliseconds between DDC/CI requests See https://www.ddcutil.com/performance_options/#option-sleep-multiplier for details
- compact	No	boolean	No	-	Whether to print multiple results on a single line
- key	No	string	No	Same as key	Module key Use a single space (` `) to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key. Overrides `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Icon to display when `display.key.type` is set to `icon`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Overrides `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Color of the module output. Overrides `display.color.output`
- format	No	string	No	In #/$defs/brightnessFormat	Output format for the `Brightness` module. 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
- condition	No	object	No	Same as condition	Show the module only if these conditions are met

5.1.2.8.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > type`


Type	`const`
Required	No

Description: Print the current brightness level of your monitors

Specific value: "brightness"

5.1.2.8.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > percent`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	percent

Description: Color thresholds for percentage output

5.1.2.8.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > ddcciSleep`


Type	`integer`
Required	No
Default	`10`

Description: Sleep time in milliseconds between DDC/CI requests See https://www.ddcutil.com/performance_options/#option-sleep-multiplier for details

Restrictions
Minimum	≥ 0
Maximum	≤ 400

5.1.2.8.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > compact`


Type	`boolean`
Required	No
Default	`false`

Description: Whether to print multiple results on a single line

5.1.2.8.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > key`


Type	`string`
Required	No
Same definition as	key

Description: Module key Use a single space ( ) to hide the key

5.1.2.8.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key. Overrides display.color.key

5.1.2.8.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Icon to display when display.key.type is set to icon

5.1.2.8.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key. Overrides display.keyWidth

5.1.2.8.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Color of the module output. Overrides display.color.output

5.1.2.8.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > format`


Type	`string`
Required	No
Defined in	#/$defs/brightnessFormat

Description: Output format for the Brightness module. 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

5.1.2.8.11. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Show the module only if these conditions are met

5.1.2.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS`

Title: BTRFS


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print Linux BTRFS volumes
- percent	No	object	No	Same as percent	Color thresholds for percentage output
- key	No	string	No	Same as key	Module key Use a single space (` `) to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key. Overrides `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Icon to display when `display.key.type` is set to `icon`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Overrides `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Color of the module output. Overrides `display.color.output`
- format	No	string	No	In #/$defs/btrfsFormat	Output format for the `Btrfs` module. 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
- condition	No	object	No	Same as condition	Show the module only if these conditions are met

5.1.2.9.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > type`


Type	`const`
Required	No

Description: Print Linux BTRFS volumes

Specific value: "btrfs"

5.1.2.9.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > percent`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	percent

Description: Color thresholds for percentage output

5.1.2.9.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > key`


Type	`string`
Required	No
Same definition as	key

Description: Module key Use a single space ( ) to hide the key

5.1.2.9.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key. Overrides display.color.key

5.1.2.9.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Icon to display when display.key.type is set to icon

5.1.2.9.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key. Overrides display.keyWidth

5.1.2.9.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Color of the module output. Overrides display.color.output

5.1.2.9.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > format`


Type	`string`
Required	No
Defined in	#/$defs/btrfsFormat

Description: Output format for the Btrfs module. 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

5.1.2.9.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Show the module only if these conditions are met

5.1.2.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera`

Title: Camera


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print available cameras
- key	No	string	No	Same as key	Module key Use a single space (` `) to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key. Overrides `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Icon to display when `display.key.type` is set to `icon`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Overrides `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Color of the module output. Overrides `display.color.output`
- format	No	string	No	In #/$defs/cameraFormat	Output format for the `Camera` module. 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)
- condition	No	object	No	Same as condition	Show the module only if these conditions are met

5.1.2.10.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > type`


Type	`const`
Required	No

Description: Print available cameras

Specific value: "camera"

5.1.2.10.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > key`


Type	`string`
Required	No
Same definition as	key

Description: Module key Use a single space ( ) to hide the key

5.1.2.10.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key. Overrides display.color.key

5.1.2.10.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Icon to display when display.key.type is set to icon

5.1.2.10.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key. Overrides display.keyWidth

5.1.2.10.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Color of the module output. Overrides display.color.output

5.1.2.10.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > format`


Type	`string`
Required	No
Defined in	#/$defs/cameraFormat

Description: Output format for the Camera module. 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)

5.1.2.10.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Show the module only if these conditions are met

5.1.2.11. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis`

Title: Chassis


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print chassis type information (desktop, laptop, etc.)
- key	No	string	No	Same as key	Module key Use a single space (` `) to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key. Overrides `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Icon to display when `display.key.type` is set to `icon`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Overrides `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Color of the module output. Overrides `display.color.output`
- format	No	string	No	In #/$defs/chassisFormat	Output format for the `Chassis` module. See Wiki for formatting syntax 1. {type}: Chassis type 2. {vendor}: Chassis vendor 3. {version}: Chassis version 4. {serial}: Chassis serial number
- condition	No	object	No	Same as condition	Show the module only if these conditions are met

5.1.2.11.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > type`


Type	`const`
Required	No

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

Specific value: "chassis"

5.1.2.11.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > key`


Type	`string`
Required	No
Same definition as	key

Description: Module key Use a single space ( ) to hide the key

5.1.2.11.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key. Overrides display.color.key

5.1.2.11.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Icon to display when display.key.type is set to icon

5.1.2.11.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key. Overrides display.keyWidth

5.1.2.11.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Color of the module output. Overrides display.color.output

5.1.2.11.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > format`


Type	`string`
Required	No
Defined in	#/$defs/chassisFormat

Description: Output format for the Chassis module. See Wiki for formatting syntax 1. {type}: Chassis type 2. {vendor}: Chassis vendor 3. {version}: Chassis version 4. {serial}: Chassis serial number

5.1.2.11.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Show the module only if these conditions are met

5.1.2.12. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU`

Title: CPU


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print CPU name, frequency, etc.
- temp	No	object	No	Same as temp	Whether to detect and display temperature, if supported
- tempSensor	No	string	No	-	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`)
- showPeCoreCount	No	boolean	No	-	Whether to detect and display CPU frequencies for different core types (for example, P-cores and E-cores), if supported
- key	No	string	No	Same as key	Module key Use a single space (` `) to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key. Overrides `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Icon to display when `display.key.type` is set to `icon`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Overrides `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Color of the module output. Overrides `display.color.output`
- format	No	string	No	In #/$defs/cpuFormat	Output format for the `CPU` module. 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}: CPU microarchitecture 12. {numa-nodes}: NUMA node count
- condition	No	object	No	Same as condition	Show the module only if these conditions are met

5.1.2.12.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > type`


Type	`const`
Required	No

Description: Print CPU name, frequency, etc.

Specific value: "cpu"

5.1.2.12.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > temp`


Type	`combining`
Required	No
Additional properties	Any type allowed
Same definition as	temp

Description: Whether to detect and display temperature, if supported

5.1.2.12.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > tempSensor`


Type	`string`
Required	No

Description: 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)

5.1.2.12.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > showPeCoreCount`


Type	`boolean`
Required	No
Default	`false`

Description: Whether to detect and display CPU frequencies for different core types (for example, P-cores and E-cores), if supported

5.1.2.12.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > key`


Type	`string`
Required	No
Same definition as	key

Description: Module key Use a single space ( ) to hide the key

5.1.2.12.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key. Overrides display.color.key

5.1.2.12.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Icon to display when display.key.type is set to icon

5.1.2.12.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key. Overrides display.keyWidth

5.1.2.12.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Color of the module output. Overrides display.color.output

5.1.2.12.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > format`


Type	`string`
Required	No
Defined in	#/$defs/cpuFormat

Description: Output format for the CPU module. 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}: CPU microarchitecture 12. {numa-nodes}: NUMA node count

5.1.2.12.11. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Show the module only if these conditions are met

5.1.2.13. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache`

Title: CPU Cache


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print CPU cache sizes
- percent	No	object	No	Same as percent	Color thresholds for percentage output
- key	No	string	No	Same as key	Module key Use a single space (` `) to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key. Overrides `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Icon to display when `display.key.type` is set to `icon`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Overrides `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Color of the module output. Overrides `display.color.output`
- format	No	string	No	In #/$defs/cpucacheFormat	Output format for the `CPUCache` module. See Wiki for formatting syntax 1. {result}: Separate result 2. {sum}: Sum result
- condition	No	object	No	Same as condition	Show the module only if these conditions are met

5.1.2.13.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > type`


Type	`const`
Required	No

Description: Print CPU cache sizes

Specific value: "cpucache"

5.1.2.13.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > percent`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	percent

Description: Color thresholds for percentage output

5.1.2.13.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > key`


Type	`string`
Required	No
Same definition as	key

Description: Module key Use a single space ( ) to hide the key

5.1.2.13.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key. Overrides display.color.key

5.1.2.13.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Icon to display when display.key.type is set to icon

5.1.2.13.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key. Overrides display.keyWidth

5.1.2.13.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Color of the module output. Overrides display.color.output

5.1.2.13.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > format`


Type	`string`
Required	No
Defined in	#/$defs/cpucacheFormat

Description: Output format for the CPUCache module. See Wiki for formatting syntax 1. {result}: Separate result 2. {sum}: Sum result

5.1.2.13.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Show the module only if these conditions are met

5.1.2.14. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage`

Title: CPU Usage


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print CPU usage. Collecting data takes some time
- percent	No	object	No	Same as percent	Color thresholds for percentage output
- separate	No	boolean	No	-	Show CPU usage for each logical core instead of an average
- waitTime	No	integer	No	-	Wait time (in ms). CPU usage = (inUseEnd - inUseStart) / waitTime
- key	No	string	No	Same as key	Module key Use a single space (` `) to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key. Overrides `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Icon to display when `display.key.type` is set to `icon`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Overrides `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Color of the module output. Overrides `display.color.output`
- format	No	string	No	In #/$defs/cpuusageFormat	Output format for the `CPUUsage` module. 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)
- condition	No	object	No	Same as condition	Show the module only if these conditions are met

5.1.2.14.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > type`


Type	`const`
Required	No

Description: Print CPU usage. Collecting data takes some time

Specific value: "cpuusage"

5.1.2.14.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > percent`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	percent

Description: Color thresholds for percentage output

5.1.2.14.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > separate`


Type	`boolean`
Required	No
Default	`false`

Description: Show CPU usage for each logical core instead of an average

5.1.2.14.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > waitTime`


Type	`integer`
Required	No
Default	`200`

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

Restrictions
Minimum	≥ 1

5.1.2.14.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > key`


Type	`string`
Required	No
Same definition as	key

Description: Module key Use a single space ( ) to hide the key

5.1.2.14.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key. Overrides display.color.key

5.1.2.14.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Icon to display when display.key.type is set to icon

5.1.2.14.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key. Overrides display.keyWidth

5.1.2.14.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Color of the module output. Overrides display.color.output

5.1.2.14.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > format`


Type	`string`
Required	No
Defined in	#/$defs/cpuusageFormat

Description: Output format for the CPUUsage module. 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)

5.1.2.14.11. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Show the module only if these conditions are met

5.1.2.15. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors`

Title: Colors


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Display the terminal's 16-color palette
- symbol	No	Combination	No	-	Set the symbol to use
- paddingLeft	No	integer	No	-	Set the number of white spaces to print before the symbol
- block	No	object	No	-	Set behavior of block printing. Only works when symbol is set to `block` or `background`
- brightness	No	Combination	No	-	Set the brightness of colors. Works together with the block color range to determine which colors are displayed
- key	No	string	No	Same as key	Module key Use a single space (` `) to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key. Overrides `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Icon to display when `display.key.type` is set to `icon`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Overrides `display.keyWidth`
- condition	No	object	No	Same as condition	Show the module only if these conditions are met

5.1.2.15.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > type`


Type	`const`
Required	No

Description: Display the terminal's 16-color palette

Specific value: "colors"

5.1.2.15.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol`


Type	`combining`
Required	No
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. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 0`


Type	`const`
Required	No

Description: ███

Specific value: "block"

5.1.2.15.2.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 1`


Type	`const`
Required	No

Description: Whitespace with background color

Specific value: "background"

5.1.2.15.2.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 2`


Type	`const`
Required	No

Description: ●

Specific value: "circle"

5.1.2.15.2.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 3`


Type	`const`
Required	No

Description: ◆

Specific value: "diamond"

5.1.2.15.2.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 4`


Type	`const`
Required	No

Description: ▲

Specific value: "triangle"

5.1.2.15.2.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 5`


Type	`const`
Required	No

Description: ■

Specific value: "square"

5.1.2.15.2.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 6`


Type	`const`
Required	No

Description: ★

Specific value: "star"

5.1.2.15.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > paddingLeft`


Type	`integer`
Required	No
Default	`0`

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

Restrictions
Minimum	≥ 0

5.1.2.15.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set behavior of block printing. Only works when symbol is set to block or background

Property	Pattern	Type	Deprecated	Definition	Title/Description
- width	No	integer	No	-	Set the block width in spaces
- range	No	array of integer	No	-	Set the range of colors in the blocks to print

5.1.2.15.4.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block > width`


Type	`integer`
Required	No
Default	`3`

Description: Set the block width in spaces

Restrictions
Minimum	≥ 1

5.1.2.15.4.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block > range`


Type	`array of integer`
Required	No

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

	Array restrictions
Min items	2
Max items	2
Items unicity	False
Additional items	False
Tuple validation	See below

Each item of this array must be	Description
range items	-

5.1.2.15.4.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block > range > range items


Type	`integer`
Required	No

Restrictions
Minimum	≥ 0
Maximum	≤ 15

5.1.2.15.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > brightness`


Type	`combining`
Required	No
Default	`"default"`

Description: Set the brightness of colors. Works together with the block color range to determine which colors are displayed

One of(Option)
item 0
item 1
item 2

5.1.2.15.5.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > brightness > oneOf > item 0`


Type	`const`
Required	No

Description: Use the default setting (block/background: 0-15, others: 8-1)

Specific value: "default"

5.1.2.15.5.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > brightness > oneOf > item 1`


Type	`const`
Required	No

Description: Use ANSI bright foreground colors (codes 90-97, not color indices 9-15)

Specific value: "light"

5.1.2.15.5.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > brightness > oneOf > item 2`


Type	`const`
Required	No

Description: Use normal ANSI colors (30-37; standard foreground colors, corresponding to color indices 0-7)

Specific value: "normal"

5.1.2.15.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > key`


Type	`string`
Required	No
Same definition as	key

Description: Module key Use a single space ( ) to hide the key

5.1.2.15.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key. Overrides display.color.key

5.1.2.15.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Icon to display when display.key.type is set to icon

5.1.2.15.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key. Overrides display.keyWidth

5.1.2.15.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Show the module only if these conditions are met

5.1.2.16. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command`

Title: Command


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Run a custom shell command
- shell	No	string	No	-	Shell program used to execute the command text Default: `cmd` on Windows, `/bin/sh` on Unix-like systems
- param	No	string	No	-	Parameter used when starting the shell If set to an empty string, it is ignored Default: `/c` on Windows, `-c` on Unix-like systems
- text	No	string	No	-	Command text to execute
- useStdErr	No	boolean	No	-	Whether to use stderr instead of stdout for command output
- parallel	No	boolean	No	-	Whether to execute the command in parallel with other commands This can improve performance when using multiple commands, but may cause issues with some commands
- splitLines	No	boolean	No	-	Whether to split command output into multiple lines
- key	No	string	No	Same as key	Module key Use a single space (` `) to hide the key
- keyColor	No	object	No	Same as keyColor	Color of the module key. Overrides `display.color.key`
- keyIcon	No	string	No	Same as keyIcon	Icon to display when `display.key.type` is set to `icon`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Overrides `display.keyWidth`
- outputColor	No	object	No	Same as outputColor	Color of the module output. Overrides `display.color.output`
- format	No	string	No	In #/$defs/commandFormat	Output format for the `Command` module. See Wiki for formatting syntax 1. {result}: Command result
- condition	No	object	No	Same as condition	Show the module only if these conditions are met

5.1.2.16.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > type`


Type	`const`
Required	No

Description: Run a custom shell command

Specific value: "command"

5.1.2.16.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > shell`


Type	`string`
Required	No

Description: Shell program used to execute the command text Default: cmd on Windows, /bin/sh on Unix-like systems

5.1.2.16.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > param`


Type	`string`
Required	No

Description: Parameter used when starting the shell If set to an empty string, it is ignored Default: /c on Windows, -c on Unix-like systems

5.1.2.16.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > text`


Type	`string`
Required	No

Description: Command text to execute

5.1.2.16.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > useStdErr`


Type	`boolean`
Required	No
Default	`false`

Description: Whether to use stderr instead of stdout for command output

5.1.2.16.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > parallel`


Type	`boolean`
Required	No
Default	`true`

Description: Whether to execute the command in parallel with other commands This can improve performance when using multiple commands, but may cause issues with some commands

5.1.2.16.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > splitLines`


Type	`boolean`
Required	No
Default	`false`

Description: Whether to split command output into multiple lines

5.1.2.16.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > key`


Type	`string`
Required	No
Same definition as	key

Description: Module key Use a single space ( ) to hide the key

5.1.2.16.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > keyColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	keyColor

Description: Color of the module key. Overrides display.color.key

5.1.2.16.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Icon to display when display.key.type is set to icon

5.1.2.16.11. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > keyWidth`


Type	`integer`
Required	No
Same definition as	keyWidth

Description: Width of the module key. Overrides display.keyWidth

5.1.2.16.12. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > outputColor`


Type	`object`
Required	No
Additional properties	Any type allowed
Same definition as	outputColor

Description: Color of the module output. Overrides display.color.output

5.1.2.16.13. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > format`


Type	`string`
Required	No
Defined in	#/$defs/commandFormat

Description: Output format for the Command module. See Wiki for formatting syntax 1. {result}: Command result

5.1.2.16.14. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > condition`


Type	`object`
Required	No
Additional properties	Not allowed
Same definition as	condition

Description: Show the module only if these conditions are met

5.1.2.17. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor`

Title: Cursor


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description

Uh oh!

Json Schema

JSON config

1. Property JSON config > $schema

2. Property JSON config > logo

2.1. Property JSON config > logo > oneOf > item 0

2.2. Property JSON config > logo > oneOf > item 1

2.3. Property JSON config > logo > oneOf > item 2

2.3.1. Property JSON config > logo > oneOf > item 2 > type

2.3.1.1. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 0

2.3.1.2. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 1

2.3.1.3. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 2

2.3.1.4. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 3

2.3.1.5. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 4

2.3.1.6. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 5

2.3.1.7. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 6

2.3.1.8. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 7

2.3.1.9. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 8

2.3.1.10. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 9

2.3.1.11. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 10

2.3.1.12. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 11

2.3.1.13. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 12

2.3.1.14. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 13

2.3.1.15. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 14

2.3.1.16. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 15

2.3.2. Property JSON config > logo > oneOf > item 2 > source

2.3.3. Property JSON config > logo > oneOf > item 2 > color

2.3.3.1. Property JSON config > logo > oneOf > item 2 > color > 1

2.3.3.1.1. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0

2.3.3.1.2. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1

2.3.3.2. Property JSON config > logo > oneOf > item 2 > color > 2

2.3.3.3. Property JSON config > logo > oneOf > item 2 > color > 3

2.3.3.4. Property JSON config > logo > oneOf > item 2 > color > 4

2.3.3.5. Property JSON config > logo > oneOf > item 2 > color > 5

2.3.3.6. Property JSON config > logo > oneOf > item 2 > color > 6

2.3.3.7. Property JSON config > logo > oneOf > item 2 > color > 7

2.3.3.8. Property JSON config > logo > oneOf > item 2 > color > 8

2.3.3.9. Property JSON config > logo > oneOf > item 2 > color > 9

2.3.4. Property JSON config > logo > oneOf > item 2 > width

2.3.4.1. Property JSON config > logo > oneOf > item 2 > width > oneOf > item 0

2.3.4.2. Property JSON config > logo > oneOf > item 2 > width > oneOf > item 1

2.3.5. Property JSON config > logo > oneOf > item 2 > height

2.3.5.1. Property JSON config > logo > oneOf > item 2 > height > oneOf > item 0

2.3.5.2. Property JSON config > logo > oneOf > item 2 > height > oneOf > item 1

2.3.6. Property JSON config > logo > oneOf > item 2 > padding

2.3.6.1. Property JSON config > logo > oneOf > item 2 > padding > top

2.3.6.2. Property JSON config > logo > oneOf > item 2 > padding > left

2.3.6.3. Property JSON config > logo > oneOf > item 2 > padding > right

2.3.7. Property JSON config > logo > oneOf > item 2 > printRemaining

2.3.8. Property JSON config > logo > oneOf > item 2 > preserveAspectRatio

2.3.9. Property JSON config > logo > oneOf > item 2 > recache

2.3.10. Property JSON config > logo > oneOf > item 2 > position

2.3.11. Property JSON config > logo > oneOf > item 2 > chafa

2.3.11.1. Property JSON config > logo > oneOf > item 2 > chafa > fgOnly

2.3.11.2. Property JSON config > logo > oneOf > item 2 > chafa > symbols

2.3.11.3. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode

2.3.11.3.1. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 0

2.3.11.3.2. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 1

2.3.11.3.3. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 2

2.3.11.3.4. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 3

2.3.11.3.5. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 4

2.3.11.3.6. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 5

2.3.11.3.7. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 6

2.3.11.3.8. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 7

2.3.11.4. Property JSON config > logo > oneOf > item 2 > chafa > colorSpace

2.3.11.4.1. Property JSON config > logo > oneOf > item 2 > chafa > colorSpace > oneOf > item 0

2.3.11.4.2. Property JSON config > logo > oneOf > item 2 > chafa > colorSpace > oneOf > item 1

2.3.11.5. Property JSON config > logo > oneOf > item 2 > chafa > ditherMode

2.3.11.5.1. Property JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 0

2.3.11.5.2. Property JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 1

2.3.11.5.3. Property JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 2

3. Property JSON config > general

3.1. Property JSON config > general > thread

3.2. Property JSON config > general > escapeBedrock

3.3. Property JSON config > general > playerName

3.4. Property JSON config > general > dsForceDrm

3.4.1. Property JSON config > general > dsForceDrm > oneOf > item 0

3.4.2. Property JSON config > general > dsForceDrm > oneOf > item 1

3.4.3. Property JSON config > general > dsForceDrm > oneOf > item 2

3.5. Property JSON config > general > wmiTimeout

1. Property `JSON config > $schema`

2. Property `JSON config > logo`

2.1. Property `JSON config > logo > oneOf > item 0`

2.2. Property `JSON config > logo > oneOf > item 1`

2.3. Property `JSON config > logo > oneOf > item 2`

2.3.1. Property `JSON config > logo > oneOf > item 2 > type`

2.3.1.1. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 0`

2.3.1.2. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 1`

2.3.1.3. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 2`

2.3.1.4. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 3`

2.3.1.5. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 4`

2.3.1.6. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 5`

2.3.1.7. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 6`

2.3.1.8. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 7`

2.3.1.9. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 8`

2.3.1.10. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 9`

2.3.1.11. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 10`

2.3.1.12. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 11`

2.3.1.13. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 12`

2.3.1.14. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 13`

2.3.1.15. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 14`

2.3.1.16. Property `JSON config > logo > oneOf > item 2 > type > oneOf > item 15`

2.3.2. Property `JSON config > logo > oneOf > item 2 > source`

2.3.3. Property `JSON config > logo > oneOf > item 2 > color`

2.3.3.1. Property `JSON config > logo > oneOf > item 2 > color > 1`

2.3.3.1.1. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0`

2.3.3.1.2. Property `JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1`

2.3.3.2. Property `JSON config > logo > oneOf > item 2 > color > 2`

2.3.3.3. Property `JSON config > logo > oneOf > item 2 > color > 3`

2.3.3.4. Property `JSON config > logo > oneOf > item 2 > color > 4`

2.3.3.5. Property `JSON config > logo > oneOf > item 2 > color > 5`

2.3.3.6. Property `JSON config > logo > oneOf > item 2 > color > 6`

2.3.3.7. Property `JSON config > logo > oneOf > item 2 > color > 7`

2.3.3.8. Property `JSON config > logo > oneOf > item 2 > color > 8`

2.3.3.9. Property `JSON config > logo > oneOf > item 2 > color > 9`

2.3.4. Property `JSON config > logo > oneOf > item 2 > width`

2.3.4.1. Property `JSON config > logo > oneOf > item 2 > width > oneOf > item 0`

2.3.4.2. Property `JSON config > logo > oneOf > item 2 > width > oneOf > item 1`

2.3.5. Property `JSON config > logo > oneOf > item 2 > height`

2.3.5.1. Property `JSON config > logo > oneOf > item 2 > height > oneOf > item 0`

2.3.5.2. Property `JSON config > logo > oneOf > item 2 > height > oneOf > item 1`

2.3.6. Property `JSON config > logo > oneOf > item 2 > padding`

2.3.6.1. Property `JSON config > logo > oneOf > item 2 > padding > top`

2.3.6.2. Property `JSON config > logo > oneOf > item 2 > padding > left`

2.3.6.3. Property `JSON config > logo > oneOf > item 2 > padding > right`

2.3.7. Property `JSON config > logo > oneOf > item 2 > printRemaining`

2.3.8. Property `JSON config > logo > oneOf > item 2 > preserveAspectRatio`

2.3.9. Property `JSON config > logo > oneOf > item 2 > recache`

2.3.10. Property `JSON config > logo > oneOf > item 2 > position`

2.3.11. Property `JSON config > logo > oneOf > item 2 > chafa`

2.3.11.1. Property `JSON config > logo > oneOf > item 2 > chafa > fgOnly`

2.3.11.2. Property `JSON config > logo > oneOf > item 2 > chafa > symbols`

2.3.11.3. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode`

2.3.11.3.1. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 0`

2.3.11.3.2. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 1`

2.3.11.3.3. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 2`

2.3.11.3.4. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 3`

2.3.11.3.5. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 4`

2.3.11.3.6. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 5`

2.3.11.3.7. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 6`

2.3.11.3.8. Property `JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 7`

2.3.11.4. Property `JSON config > logo > oneOf > item 2 > chafa > colorSpace`

2.3.11.4.1. Property `JSON config > logo > oneOf > item 2 > chafa > colorSpace > oneOf > item 0`

2.3.11.4.2. Property `JSON config > logo > oneOf > item 2 > chafa > colorSpace > oneOf > item 1`

2.3.11.5. Property `JSON config > logo > oneOf > item 2 > chafa > ditherMode`

2.3.11.5.1. Property `JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 0`

2.3.11.5.2. Property `JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 1`

2.3.11.5.3. Property `JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 2`

3. Property `JSON config > general`

3.1. Property `JSON config > general > thread`

3.2. Property `JSON config > general > escapeBedrock`

3.3. Property `JSON config > general > playerName`

3.4. Property `JSON config > general > dsForceDrm`

3.4.1. Property `JSON config > general > dsForceDrm > oneOf > item 0`

3.4.2. Property `JSON config > general > dsForceDrm > oneOf > item 1`

3.4.3. Property `JSON config > general > dsForceDrm > oneOf > item 2`

3.5. Property `JSON config > general > wmiTimeout`

3.6. Property `JSON config > general > processingTimeout`

3.7. Property `JSON config > general > preRun`

3.8. Property `JSON config > general > detectVersion`