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: JSON config file for fastfetch. Usually be ~/.config/fastfetch.jsonc

Property	Pattern	Type	Deprecated	Definition	Title/Description
- $schema	No	string	No	-	JSON schema URL, for JSON validation and IDE intelligence
- logo	No	Combination	No	-	Fastfetch logo configurations See also https://github.com/fastfetch-cli/fastfetch/wiki/Logo-options
- general	No	object	No	-	Fastfetch general configurations
- display	No	object	No	-	Configure how things to be displayed
- modules	No	array	No	-	Fastfetch 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 JSON validation and IDE intelligence

2. Property `JSON config > logo`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: Fastfetch logo configurations 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: Set the source file of the logo

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


Type	`object`
Required	No
Additional properties	Not allowed

Description: Fastfetch logo configurations

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	enum (of string)	No	-	Set the type of the logo given
- source	No	string	No	-	Set the source file of the logo
- color	No	object	No	-	Overwrite a color in the logo
- width	No	integer	No	-	Set the width of the logo (in characters). Required for iTerm image protocol
- height	No	integer	No	-	Set the height of the logo (in characters). Required for iTerm image protocol
- padding	No	object	No	-	Set the padding of the logo
- printRemaining	No	boolean	No	-	Whether to print the remaining logo, if it has more lines than modules to display
- preserveAspectRatio	No	boolean	No	-	Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol
- recache	No	boolean	No	-	If true, regenerate image logo cache
- position	No	enum (of string)	No	-	Set the position of the logo should be displayed
- chafa	No	object	No	-	Chafa configuration. See chafa document for details

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


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

Description: Set the type of the logo given

Must be one of:

"auto"
"builtin"
"small"
"file"
"file-raw"
"data"
"data-raw"
"sixel"
"kitty"
"kitty-direct"
"kitty-icat"
"iterm"
"chafa"
"raw"
"none"

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


Type	`string`
Required	No

Description: Set the source file of the logo

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


Type	`object`
Required	No
Additional properties	Not allowed

Description: Overwrite a color in the logo

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

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


Type	`enum (of string)`
Required	No
Defined in	#/$defs/colors

Description: Color 1

Must be one of:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"

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


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

Description: Color 2

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


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

Description: Color 3

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


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

Description: Color 4

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


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

Description: Color 5

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


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

Description: Color 6

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


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

Description: Color 7

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


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

Description: Color 8

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


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

Description: Color 9

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


Type	`integer`
Required	No

Description: Set the width of the logo (in characters). Required for iTerm image protocol

Restrictions
Minimum	≥ 1

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


Type	`integer`
Required	No

Description: Set the height of the logo (in characters). Required for iTerm image protocol

Restrictions
Minimum	≥ 1

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


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set the padding of the logo

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

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


Type	`integer`
Required	No

Description: Set the 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: Set the 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: Set the right padding of the logo

Restrictions
Minimum	≥ 0

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


Type	`boolean`
Required	No
Default	`false`

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

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

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: Set the position of the logo should be displayed

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 document 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	enum (of string)	No	-	Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.
- colorSpace	No	enum (of string)	No	-	Set color space used for quantization. This value maps the value of enum ChafaColorSpace.
- ditherMode	No	enum (of string)	No	-	Set output dither mode (No effect with 24-bit color). This value maps the value of 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	`enum (of string)`
Required	No

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

Must be one of:

"TRUECOLOR"
"INDEXED_256"
"INDEXED_240"
"INDEXED_16"
"FGBG_BGFG"
"FGBG"
"INDEXED_8"
"INDEXED_16_8"

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


Type	`enum (of string)`
Required	No

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

Must be one of:

"RGB"
"DIN99D"

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


Type	`enum (of string)`
Required	No

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

Must be one of:

"NONE"
"ORDERED"
"DIFFUSION"

3. Property `JSON config > general`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Fastfetch general configurations

Property	Pattern	Type	Deprecated	Definition	Title/Description
- multithreading	No	boolean	No	-	Use multiple threads to detect values
- thread	No	boolean	No	-	Alias of multithreading
- 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 module Media and Player. 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	-	Set the command to be executed before printing logos
- detectVersion	No	boolean	No	-	Whether to detect and display component versions. Mainly for benchmarking

3.1. Property `JSON config > general > multithreading`


Type	`boolean`
Required	No
Default	`true`

Description: Use multiple threads to detect values

3.2. Property `JSON config > general > thread`


Type	`boolean`
Required	No
Default	`true`

Description: Alias of multithreading

3.3. Property `JSON config > general > escapeBedrock`


Type	`boolean`
Required	No
Default	`true`

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

3.4. Property `JSON config > general > playerName`


Type	`string`
Required	No

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

3.5. 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.5.1. Property `JSON config > general > dsForceDrm > oneOf > item 0`


Type	`const`
Required	No

Description: Try wayland, then x11, then drm

Specific value: false

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


Type	`const`
Required	No

Description: Use /sys/class/drm only.

Specific value: "sysfs-only"

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


Type	`const`
Required	No

Description: Try libdrm first, then sysfs if libdrm failed

Specific value: true

3.6. 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.7. 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.8. Property `JSON config > general > preRun`


Type	`string`
Required	No
Default	`""`

Description: Set the command to be executed before printing logos

3.9. 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 how things to be displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- stat	No	Combination	No	-	Show time usage (in ms) for individual modules with optional threshold
- pipe	No	boolean	No	-	Whether to enable pipe mode (disable logo and all escape sequences)
- showErrors	No	boolean	No	-	Print occurring errors to the console. False to ignore errored modules
- disableLinewrap	No	boolean	No	-	Whether to disable line wrap during the run
- hideCursor	No	boolean	No	-	Whether to hide the cursor during the run
- separator	No	string	No	-	Set the separator between key and value
- color	No	Combination	No	-	Set the color of the keys and title
- brightColor	No	boolean	No	-	Set if the keys, title and ASCII logo should be printed in bright color
- key	No	object	No	-	Set how module keys should be displayed
- size	No	object	No	-	Set how a size value should be displayed
- temp	No	object	No	-	Set how temperature values should be displayed
- bar	No	object	No	-	Set the bar configuration
- percent	No	object	No	-	Set how a percentage value should be displayed
- freq	No	object	No	-	Set how frequency values should be displayed
- noBuffer	No	boolean	No	-	Whether to disable the stdout application buffer
- constants	No	array of string	No	-	List of strings to be used in custom format of modules

4.1. Property `JSON config > display > stat`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: Show time usage (in ms) for individual modules with optional 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 enable pipe mode (disable logo and all escape sequences)

4.3. Property `JSON config > display > showErrors`


Type	`boolean`
Required	No
Default	`false`

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

4.4. Property `JSON config > display > disableLinewrap`


Type	`boolean`
Required	No
Default	`true`

Description: Whether to disable line wrap during the run

4.5. Property `JSON config > display > hideCursor`


Type	`boolean`
Required	No
Default	`true`

Description: Whether to hide the cursor during the run

4.6. Property `JSON config > display > separator`


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

Description: Set the separator between key and value

4.7. Property `JSON config > display > color`


Type	`combining`
Required	No
Additional properties	Any type allowed

Description: Set the color of the keys and title

One of(Option)
colors
item 1

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


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

Description: Set the both color of the keys and title

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	enum (of string)	No	Same as 1	Set the color of the keys
- title	No	enum (of string)	No	Same as 1	Set the color of the title
- output	No	enum (of string)	No	Same as 1	Set the color of the module output
- separator	No	enum (of string)	No	Same as 1	Set the color of the key-value separator

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


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

Description: Set the color of the keys

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


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

Description: Set the color of the title

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


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

Description: Set the color of the module output

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


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

Description: Set the color of the key-value separator

4.8. Property `JSON config > display > brightColor`


Type	`boolean`
Required	No
Default	`true`

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

4.9. Property `JSON config > display > key`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set how module keys should be displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- width	No	integer	No	-	Align the width of keys to number of characters, 0 to disable
- type	No	enum (of string)	No	-	Set whether to show icon before string keys
- paddingLeft	No	integer	No	-	Set the left padding of keys

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


Type	`integer`
Required	No
Default	`0`

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

Restrictions
Minimum	≥ 0

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


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

Description: Set whether to show icon before string keys

Must be one of:

"none"
"string"
"icon"
"both"

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


Type	`integer`
Required	No
Default	`0`

Description: Set the left padding of keys

Restrictions
Minimum	≥ 0

4.10. Property `JSON config > display > size`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set how a size value should be displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- binaryPrefix	No	Combination	No	-	Set the binary prefix to used when formatting sizes
- maxPrefix	No	enum (of string)	No	-	Set the largest binary prefix to use when formatting sizes
- ndigits	No	integer	No	-	Set the number of digits to keep after the decimal point when formatting sizes

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


Type	`combining`
Required	No

Description: Set the binary prefix to used 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 K = 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: Set the number of digits to keep after the decimal point when formatting sizes

Restrictions
Minimum	≥ 0
Maximum	≤ 9

4.11. Property `JSON config > display > temp`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set how temperature values should be displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- unit	No	enum (of string)	No	-	Set the unit of the temperature
- ndigits	No	integer	No	-	Set the number of digits to keep after the decimal point when formatting temperature values
- color	No	object	No	-	Set color used in different states of temperature values

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


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

Description: Set the unit of the temperature

Must be one of:

"CELSIUS"
"C"
"FAHRENHEIT"
"F"
"KELVIN"
"K"

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


Type	`integer`
Required	No
Default	`1`

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

Restrictions
Minimum	≥ 0
Maximum	≤ 9

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


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set color used in different states of temperature values

Property	Pattern	Type	Deprecated	Definition	Title/Description
- green	No	enum (of string)	No	Same as 1	Color used in green state
- yellow	No	enum (of string)	No	Same as 1	Color used in yellow state
- red	No	enum (of string)	No	Same as 1	Color used in red state

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


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

Description: Color used in green state

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


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

Description: Color used in yellow state

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


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

Description: Color used in red state

4.12. Property `JSON config > display > bar`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set the bar configuration

Property	Pattern	Type	Deprecated	Definition	Title/Description
- charElapsed	No	string	No	-	Set the character to use in elapsed part
- charTotal	No	string	No	-	Set the character to use in total part
- borderLeft	No	string	No	-	Set the string to use at left border
- borderRight	No	string	No	-	Set the string to use at right border
- width	No	integer	No	-	Set the width of the bar, in number of characters

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


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

Description: Set the character to use in elapsed part

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


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

Description: Set the character to use in total part

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


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

Description: Set the string to use at left border

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


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

Description: Set the string to use at right border

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


Type	`integer`
Required	No
Default	`10`

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

Restrictions
Minimum	≥ 1

4.13. Property `JSON config > display > percent`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set how a percentage value should be displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	object	No	In #/$defs/percentType	Set the percentage output type
- ndigits	No	number	No	-	Set the number of digits to keep after the decimal point when formatting percentage numbers
- color	No	object	No	-	Set color used in different states of percentage bars and numbers

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


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

Description: Set the percentage output type

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: 1 for percentage number, 2 for multi-color bar, 3 for both, 6 for bar only, 9 for colored number, 10 for monochrome bar

Restrictions
Minimum	≥ 0
Maximum	≤ 255

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


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

Description: array of string flags

	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
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: Set the number of digits to keep after the decimal point when formatting percentage numbers

Restrictions
Minimum	≥ 0
Maximum	≤ 9

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


Type	`object`
Required	No
Additional properties	Not allowed

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

Property	Pattern	Type	Deprecated	Definition	Title/Description
- green	No	enum (of string)	No	Same as 1	Color used in green state
- yellow	No	enum (of string)	No	Same as 1	Color used in yellow state
- red	No	enum (of string)	No	Same as 1	Color used in red state

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


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

Description: Color used in green state

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


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

Description: Color used in yellow state

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


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

Description: Color used in red state

4.14. Property `JSON config > display > freq`


Type	`object`
Required	No
Additional properties	Not allowed

Description: Set how frequency values should be displayed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- ndigits	No	integer	No	-	Set the number of digits to keep after the decimal point when formatting frequency values A positive value will show the frequency in GHz of decimal -1 will show the frequency in MHz

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


Type	`integer`
Required	No
Default	`2`

Description: Set the number of digits to keep after the decimal point when formatting frequency values A positive value will show the frequency in GHz of decimal -1 will show the frequency in MHz

Restrictions
Minimum	≥ -1
Maximum	≤ 9

4.15. Property `JSON config > display > noBuffer`


Type	`boolean`
Required	No
Default	`false`

Description: Whether to disable the stdout application buffer

4.16. Property `JSON config > display > constants`


Type	`array of string`
Required	No

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

	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.16.1. JSON config > display > constants > constants items


Type	`string`
Required	No

5. Property `JSON config > modules`


Type	`array`
Required	No

Description: Fastfetch 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 module with default configurations

Must be one of:

"battery"
"bios"
"bluetooth"
"bluetoothradio"
"board"
"bootmgr"
"break"
"brightness"
"btrfs"
"camera"
"chassis"
"cpu"
"cpucache"
"cpuusage"
"command"
"colors"
"cursor"
"datetime"
"display"
"disk"
"diskio"
"de"
"dns"
"editor"
"font"
"gamepad"
"gpu"
"host"
"icons"
"initsystem"
"kernel"
"lm"
"loadavg"
"locale"
"localip"
"media"
"memory"
"monitor"
"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 module with custom configurations

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
Login Manager
Local IP
Loadavg
Locale
Media
Memory
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 a empty line

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


Type	`const`
Required	No

Description: Print a empty line

Specific value: "break"

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 capacity, status, etc
- useSetupApi	No	boolean	No	-	Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only
- temp	No	object	No	In #/$defs/temperature	Detect and display temperature if supported
- percent	No	object	No	In #/$defs/percent	Threshold of percentage colors
- key	No	string	No	In #/$defs/key	Key of the module
- keyColor	No	enum (of string)	No	In #/$defs/keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	In #/$defs/keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	In #/$defs/keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	In #/$defs/outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/batteryFormat	Output format of the module `Battery`. See `-h format` for formatting syntax 1. {manufacturer}: Battery manufacturer 2. {model-name}: Battery model name 3. {technology}: Battery technology 4. {capacity}: Battery capacity (percentage num) 5. {status}: Battery status 6. {temperature}: Battery temperature (formatted) 7. {cycle-count}: Battery cycle count 8. {serial}: Battery serial number 9. {manufacture-date}: Battery manufactor date 10. {capacity-bar}: Battery capacity (percentage bar) 11. {time-days}: Battery time remaining days 12. {time-hours}: Battery time remaining hours 13. {time-minutes}: Battery time remaining minutes 14. {time-seconds}: Battery time remaining seconds

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


Type	`const`
Required	No

Description: Print battery capacity, status, etc

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: Set if SetupAPI should be used on Windows to detect battery info, which supports multi batteries, but 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: 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	-	Value (in celsius) less then green will be shown in green
- yellow	No	integer	No	-	Value (in celsius) greater than green and less then yellow will be shown in yellow. Value greater than yellow will be 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: Value (in celsius) less then green will be 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: Value (in celsius) greater than green and less then yellow will be shown in yellow. Value greater than yellow will be 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: Threshold of percentage colors

Property	Pattern	Type	Deprecated	Definition	Title/Description
- green	No	integer	No	-	Value less then green will be shown in green
- yellow	No	integer	No	-	Value greater than green and less then yellow will be shown in yellow. Value greater than yellow will be shown in red
- type	No	object	No	Same as type	Set the percentage output type

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


Type	`integer`
Required	No

Description: Value less then green will be 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: Value greater than green and less then yellow will be shown in yellow. Value greater than yellow will be 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: Set the percentage output type

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: Key of the module

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


Type	`enum (of string)`
Required	No
Defined in	#/$defs/keyColor

Description: Color of the module key. Left empty to use display.color.keys

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: Set the icon to be displayed by display.keyType: "icon"

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


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

Description: Width of the module key. Use 0 to use display.keyWidth

Restrictions
Minimum	≥ 0

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


Type	`enum (of string)`
Required	No
Defined in	#/$defs/outputColor

Description: Output color of the module. Left empty to use 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 of the module Battery. See -h format for formatting syntax 1. {manufacturer}: Battery manufacturer 2. {model-name}: Battery model name 3. {technology}: Battery technology 4. {capacity}: Battery capacity (percentage num) 5. {status}: Battery status 6. {temperature}: Battery temperature (formatted) 7. {cycle-count}: Battery cycle count 8. {serial}: Battery serial number 9. {manufacture-date}: Battery manufactor date 10. {capacity-bar}: Battery capacity (percentage bar) 11. {time-days}: Battery time remaining days 12. {time-hours}: Battery time remaining hours 13. {time-minutes}: Battery time remaining minutes 14. {time-seconds}: Battery time remaining seconds

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 information of 1st-stage bootloader (name, version, release date, etc)
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/biosFormat	Output format of the module `Bios`. See `-h format` 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.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > type`


Type	`const`
Required	No

Description: Print information of 1st-stage bootloader (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: Key of the module

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


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

Description: Color of the module key. Left empty to use display.color.keys

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: Set the icon to be displayed by display.keyType: "icon"

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


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

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


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

Description: Output color of the module. Left empty to use 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 of the module Bios. See -h format 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.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	-	Set if disconnected bluetooth devices should be printed
- percent	No	object	No	Same as percent	Threshold of percentage colors
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/bluetoothFormat	Output format of the module `Bluetooth`. See `-h format` 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.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: Set if disconnected bluetooth devices should be printed

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: Threshold of percentage colors

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: Key of the module

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


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

Description: Color of the module key. Left empty to use display.color.keys

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: Set the icon to be displayed by display.keyType: "icon"

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


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

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


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

Description: Output color of the module. Left empty to use 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 of the module Bluetooth. See -h format 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.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 width supported version and vendor
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/bluetoothradioFormat	Output format of the module `BluetoothRadio`. See `-h format` 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.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > type`


Type	`const`
Required	No

Description: List bluetooth radios width supported version and vendor

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: Key of the module

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


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

Description: Color of the module key. Left empty to use display.color.keys

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: Set the icon to be displayed by display.keyType: "icon"

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


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

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


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

Description: Output color of the module. Left empty to use 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 of the module BluetoothRadio. See -h format 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.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 info
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/boardFormat	Output format of the module `Board`. See `-h format` for formatting syntax 1. {name}: Board name 2. {vendor}: Board vendor 3. {version}: Board version 4. {serial}: Board serial number

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 info

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: Key of the module

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


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

Description: Color of the module key. Left empty to use display.color.keys

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: Set the icon to be displayed by display.keyType: "icon"

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


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

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


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

Description: Output color of the module. Left empty to use 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 of the module Board. See -h format for formatting syntax 1. {name}: Board name 2. {vendor}: Board vendor 3. {version}: Board version 4. {serial}: Board serial number

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 information of 2nd-stage bootloader (name, firmware, etc)
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/bootmgrFormat	Output format of the module `Bootmgr`. See `-h format` 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.1.2.7.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > type`


Type	`const`
Required	No

Description: Print information of 2nd-stage bootloader (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: Key of the module

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


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

Description: Color of the module key. Left empty to use display.color.keys

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: Set the icon to be displayed by display.keyType: "icon"

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


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

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


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

Description: Output color of the module. Left empty to use 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 of the module Bootmgr. See -h format 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.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 current brightness level of your monitors
- percent	No	object	No	Same as percent	Threshold of percentage colors
- ddcciSleep	No	integer	No	-	Set the sleep times (in ms) when sending DDC/CI requests. See https://www.ddcutil.com/performance_options/#option-sleep-multiplier for detail
- compact	No	boolean	No	-	Set if multiple results should be printed in one line
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/brightnessFormat	Output format of the module `Brightness`. See `-h format` 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)

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


Type	`const`
Required	No

Description: Print 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: Threshold of percentage colors

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


Type	`integer`
Required	No
Default	`10`

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

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: Set if multiple results should be printed in one 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: Key of the module

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


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

Description: Color of the module key. Left empty to use display.color.keys

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: Set the icon to be displayed by display.keyType: "icon"

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


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

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


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

Description: Output color of the module. Left empty to use 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 of the module Brightness. See -h format 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)

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	Threshold of percentage colors
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/btrfsFormat	Output format of the module `Btrfs`. See `-h format` 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.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: Threshold of percentage colors

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: Key of the module

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


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

Description: Color of the module key. Left empty to use display.color.keys

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: Set the icon to be displayed by display.keyType: "icon"

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


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

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


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

Description: Output color of the module. Left empty to use 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 of the module Btrfs. See -h format 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.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	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/cameraFormat	Output format of the module `Camera`. See `-h format` 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.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: Key of the module

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


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

Description: Color of the module key. Left empty to use display.color.keys

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: Set the icon to be displayed by display.keyType: "icon"

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


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

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


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

Description: Output color of the module. Left empty to use 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 of the module Camera. See -h format 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.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 (desktop, laptop, etc)
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/chassisFormat	Output format of the module `Chassis`. See `-h format` for formatting syntax 1. {type}: Chassis type 2. {vendor}: Chassis vendor 3. {version}: Chassis version 4. {serial}: Chassis serial number

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 (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: Key of the module

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


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

Description: Color of the module key. Left empty to use display.color.keys

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: Set the icon to be displayed by display.keyType: "icon"

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


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

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


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

Description: Output color of the module. Left empty to use 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 of the module Chassis. See -h format for formatting syntax 1. {type}: Chassis type 2. {vendor}: Chassis vendor 3. {version}: Chassis version 4. {serial}: Chassis serial number

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	Detect and display temperature if supported
- showPeCoreCount	No	boolean	No	-	Detect and display CPU frequency of different core types (eg. Pcore and Ecore) if supported
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/cpuFormat	Output format of the module `CPU`. See `-h format` 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

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: Detect and display temperature if supported

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


Type	`boolean`
Required	No
Default	`false`

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

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


Type	`string`
Required	No
Same definition as	key

Description: Key of the module

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


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

Description: Color of the module key. Left empty to use display.color.keys

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


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

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


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

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


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

Description: Output color of the module. Left empty to use display.color.output

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


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

Description: Output format of the module CPU. See -h format 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

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	Threshold of percentage colors
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/cpucacheFormat	Output format of the module `CPUCache`. See `-h format` for formatting syntax 1. {result}: Separate result 2. {sum}: Sum result

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: Threshold of percentage colors

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: Key of the module

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


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

Description: Color of the module key. Left empty to use display.color.keys

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: Set the icon to be displayed by display.keyType: "icon"

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


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

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


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

Description: Output color of the module. Left empty to use 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 of the module CPUCache. See -h format for formatting syntax 1. {result}: Separate result 2. {sum}: Sum result

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. Costs some time to collect data
- percent	No	object	No	Same as percent	Threshold of percentage colors
- separate	No	boolean	No	-	Display CPU usage per CPU logical core, instead of an average result
- waitTime	No	integer	No	-	Wait time (in ms). CPU usage = (inUseEnd - inUseStart) / waitTime
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/cpuusageFormat	Output format of the module `CPUUsage`. See `-h format` 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.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > type`


Type	`const`
Required	No

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

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: Threshold of percentage colors

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: Display CPU usage per CPU logical core, instead of an average result

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: Key of the module

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


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

Description: Color of the module key. Left empty to use display.color.keys

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: Set the icon to be displayed by display.keyType: "icon"

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


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

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


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

Description: Output color of the module. Left empty to use 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 of the module CPUUsage. See -h format 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.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	-	Print some colored blocks
- symbol	No	enum (of string)	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
- key	No	string	No	Same as key	Key of the module
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`

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


Type	`const`
Required	No

Description: Print some colored blocks

Specific value: "colors"

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


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

Description: Set the symbol to use

Must be one of:

"block"
"background"
"circle"
"diamond"
"triangle"
"square"
"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

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 > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module

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


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

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	-	Running custom shell scripts
- shell	No	string	No	-	Set the shell program to execute the command text Default: cmd for Windows, /bin/sh for *nix
- param	No	string	No	-	Set the parameter used when starting the shell Default: /c for Windows, -c for *nix
- text	No	string	No	-	Set the command text to be executed
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/commandFormat	Output format of the module `Command`. See `-h format` for formatting syntax 1. {result}: Command result

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


Type	`const`
Required	No

Description: Running custom shell scripts

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: Set the shell program to execute the command text Default: cmd for Windows, /bin/sh for *nix

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


Type	`string`
Required	No

Description: Set the parameter used when starting the shell Default: /c for Windows, -c for *nix

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


Type	`string`
Required	No

Description: Set the command text to be executed

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


Type	`string`
Required	No
Same definition as	key

Description: Key of the module

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


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

Description: Color of the module key. Left empty to use display.color.keys

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


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

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


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

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


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

Description: Output color of the module. Left empty to use display.color.output

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


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

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

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
- type	No	const	No	-	Print cursor style name
- percent	No	object	No	Same as percent	Threshold of percentage colors
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/cursorFormat	Output format of the module `Cursor`. See `-h format` for formatting syntax 1. {theme}: Cursor theme 2. {size}: Cursor size

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


Type	`const`
Required	No

Description: Print cursor style name

Specific value: "cursor"

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


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

Description: Threshold of percentage colors

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


Type	`string`
Required	No
Same definition as	key

Description: Key of the module

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


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

Description: Color of the module key. Left empty to use display.color.keys

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


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

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


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

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


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

Description: Output color of the module. Left empty to use display.color.output

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


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

Description: Output format of the module Cursor. See -h format for formatting syntax 1. {theme}: Cursor theme 2. {size}: Cursor size

5.1.2.18. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom`

Title: Custom


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print a custom string, with or without key
- key	No	string	No	-	Leave empty not to print the key
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	-	Text to print

5.1.2.18.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > type`


Type	`const`
Required	No

Description: Print a custom string, with or without key

Specific value: "custom"

5.1.2.18.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > key`


Type	`string`
Required	No

Description: Leave empty not to print the key

5.1.2.18.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > keyColor`


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

Description: Color of the module key. Left empty to use display.color.keys

5.1.2.18.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.18.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > keyWidth`


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

5.1.2.18.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > outputColor`


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

Description: Output color of the module. Left empty to use display.color.output

5.1.2.18.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > format`


Type	`string`
Required	No

Description: Text to print

5.1.2.19. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time`

Title: Date Time


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print current date and time
- percent	No	object	No	Same as percent	Threshold of percentage colors
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/datetimeFormat	Output format of the module `DateTime`. See `-h format` for formatting syntax 1. {year}: Year 2. {year-short}: Last two digits of year 3. {month}: Month 4. {month-pretty}: Month with leading zero 5. {month-name}: Month name 6. {month-name-short}: Month name short 7. {week}: Week number on year 8. {weekday}: Weekday 9. {weekday-short}: Weekday short 10. {day-in-year}: Day in year 11. {day-in-month}: Day in month 12. {day-in-week}: Day in week 13. {hour}: Hour 14. {hour-pretty}: Hour with leading zero 15. {hour-12}: Hour 12h format 16. {hour-12-pretty}: Hour 12h format with leading zero 17. {minute}: Minute 18. {minute-pretty}: Minute with leading zero 19. {second}: Second 20. {second-pretty}: Second with leading zero 21. {offset-from-utc}: Offset from UTC in the ISO 8601 format 22. {timezone-name}: Locale-dependent timezone name or abbreviation 23. {day-pretty}: Day in month with leading zero

5.1.2.19.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > type`


Type	`const`
Required	No

Description: Print current date and time

Specific value: "datetime"

5.1.2.19.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > percent`


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

Description: Threshold of percentage colors

5.1.2.19.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module

5.1.2.19.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > keyColor`


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

Description: Color of the module key. Left empty to use display.color.keys

5.1.2.19.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.19.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > keyWidth`


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

5.1.2.19.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > outputColor`


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

Description: Output color of the module. Left empty to use display.color.output

5.1.2.19.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > format`


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

Description: Output format of the module DateTime. See -h format for formatting syntax 1. {year}: Year 2. {year-short}: Last two digits of year 3. {month}: Month 4. {month-pretty}: Month with leading zero 5. {month-name}: Month name 6. {month-name-short}: Month name short 7. {week}: Week number on year 8. {weekday}: Weekday 9. {weekday-short}: Weekday short 10. {day-in-year}: Day in year 11. {day-in-month}: Day in month 12. {day-in-week}: Day in week 13. {hour}: Hour 14. {hour-pretty}: Hour with leading zero 15. {hour-12}: Hour 12h format 16. {hour-12-pretty}: Hour 12h format with leading zero 17. {minute}: Minute 18. {minute-pretty}: Minute with leading zero 19. {second}: Second 20. {second-pretty}: Second with leading zero 21. {offset-from-utc}: Offset from UTC in the ISO 8601 format 22. {timezone-name}: Locale-dependent timezone name or abbreviation 23. {day-pretty}: Day in month with leading zero

5.1.2.20. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Display`

Title: Display


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print resolutions, refresh rates, etc
- compactType	No	enum (of string)	No	-	Set if all displays should be printed in one line
- preciseRefreshRate	No	boolean	No	-	Set if decimal refresh rates should not be rounded into integers when printing
- order	No	enum (of string)	No	-	Set the order should be used when printing
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/displayFormat	Output format of the module `Display`. See `-h format` for formatting syntax 1. {width}: Screen configured width (in pixels) 2. {height}: Screen configured height (in pixels) 3. {refresh-rate}: Screen configured refresh rate (in Hz) 4. {scaled-width}: Screen scaled width (in pixels) 5. {scaled-height}: Screen scaled height (in pixels) 6. {name}: Screen name 7. {type}: Screen type (builtin, external or unknown) 8. {rotation}: Screen rotation (in degrees) 9. {is-primary}: True if being the primary screen 10. {physical-width}: Screen physical width (in millimeters) 11. {physical-height}: Screen physical height (in millimeters) 12. {inch}: Physical diagonal length in inches 13. {ppi}: Pixels per inch (PPI) 14. {bit-depth}: Bits per color channel 15. {hdr-enabled}: True if high dynamic range (HDR) mode is enabled 16. {manufacture-year}: Year of manufacturing 17. {manufacture-week}: Nth week of manufacturing in the year 18. {serial}: Serial number 19. {platform-api}: The platform API used when detecting the display 20. {hdr-compatible}: True if the display is HDR compatible 21. {scale-factor}: HiDPI scale factor 22. {preferred-width}: Screen preferred width (in pixels) 23. {preferred-height}: Screen preferred height (in pixels) 24. {preferred-refresh-rate}: Screen preferred refresh rate (in Hz)

5.1.2.20.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > type`


Type	`const`
Required	No

Description: Print resolutions, refresh rates, etc

Specific value: "display"

5.1.2.20.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > compactType`


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

Description: Set if all displays should be printed in one line

Must be one of:

"none"
"original"
"scaled"
"original-with-refresh-rate"
"scaled-with-refresh-rate"

5.1.2.20.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > preciseRefreshRate`


Type	`boolean`
Required	No
Default	`false`

Description: Set if decimal refresh rates should not be rounded into integers when printing

5.1.2.20.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > order`


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

Description: Set the order should be used when printing

Must be one of:

"none"
"asc"
"desc"

5.1.2.20.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module

5.1.2.20.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > keyColor`


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

Description: Color of the module key. Left empty to use display.color.keys

5.1.2.20.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.20.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > keyWidth`


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

5.1.2.20.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > outputColor`


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

Description: Output color of the module. Left empty to use display.color.output

5.1.2.20.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > format`


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

Description: Output format of the module Display. See -h format for formatting syntax 1. {width}: Screen configured width (in pixels) 2. {height}: Screen configured height (in pixels) 3. {refresh-rate}: Screen configured refresh rate (in Hz) 4. {scaled-width}: Screen scaled width (in pixels) 5. {scaled-height}: Screen scaled height (in pixels) 6. {name}: Screen name 7. {type}: Screen type (builtin, external or unknown) 8. {rotation}: Screen rotation (in degrees) 9. {is-primary}: True if being the primary screen 10. {physical-width}: Screen physical width (in millimeters) 11. {physical-height}: Screen physical height (in millimeters) 12. {inch}: Physical diagonal length in inches 13. {ppi}: Pixels per inch (PPI) 14. {bit-depth}: Bits per color channel 15. {hdr-enabled}: True if high dynamic range (HDR) mode is enabled 16. {manufacture-year}: Year of manufacturing 17. {manufacture-week}: Nth week of manufacturing in the year 18. {serial}: Serial number 19. {platform-api}: The platform API used when detecting the display 20. {hdr-compatible}: True if the display is HDR compatible 21. {scale-factor}: HiDPI scale factor 22. {preferred-width}: Screen preferred width (in pixels) 23. {preferred-height}: Screen preferred height (in pixels) 24. {preferred-refresh-rate}: Screen preferred refresh rate (in Hz)

5.1.2.21. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk`

Title: Disk


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print partitions, space usage, disk type, etc
- folders	No	string	No	-	A colon (semicolon on Windows) separated list of folder paths for the disk output Default: auto detection using mount-points This option overrides other `show*` options
- showExternal	No	boolean	No	-	Set if external volume should be printed
- showHidden	No	boolean	No	-	Set if hidden volumes should be printed
- showSubvolumes	No	boolean	No	-	Set if subvolumes should be printed
- showReadOnly	No	boolean	No	-	Set if read only volumes should be printed
- showUnknown	No	boolean	No	-	Set if unknown (unable to detect sizes) volumes should be printed
- useAvailable	No	boolean	No	-	Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes
- percent	No	object	No	Same as percent	Threshold of percentage colors
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/diskFormat	Output format of the module `Disk`. See `-h format` for formatting syntax 1. {size-used}: Size used 2. {size-total}: Size total 3. {size-percentage}: Size percentage num 4. {files-used}: Files used 5. {files-total}: Files total 6. {files-percentage}: Files percentage num 7. {is-external}: True if external volume 8. {is-hidden}: True if hidden volume 9. {filesystem}: Filesystem 10. {name}: Label / name 11. {is-readonly}: True if read-only 12. {create-time}: Create time in local timezone 13. {size-percentage-bar}: Size percentage bar 14. {files-percentage-bar}: Files percentage bar 15. {(null)}: (null)

5.1.2.21.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > type`


Type	`const`
Required	No

Description: Print partitions, space usage, disk type, etc

Specific value: "disk"

5.1.2.21.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > folders`


Type	`string`
Required	No

Description: A colon (semicolon on Windows) separated list of folder paths for the disk output Default: auto detection using mount-points This option overrides other show* options

5.1.2.21.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showExternal`


Type	`boolean`
Required	No
Default	`true`

Description: Set if external volume should be printed

5.1.2.21.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showHidden`


Type	`boolean`
Required	No
Default	`false`

Description: Set if hidden volumes should be printed

5.1.2.21.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showSubvolumes`


Type	`boolean`
Required	No
Default	`false`

Description: Set if subvolumes should be printed

5.1.2.21.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showReadOnly`


Type	`boolean`
Required	No
Default	`false`

Description: Set if read only volumes should be printed

5.1.2.21.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showUnknown`


Type	`boolean`
Required	No
Default	`false`

Description: Set if unknown (unable to detect sizes) volumes should be printed

5.1.2.21.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > useAvailable`


Type	`boolean`
Required	No
Default	`false`

Description: Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes

5.1.2.21.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > percent`


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

Description: Threshold of percentage colors

5.1.2.21.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module

5.1.2.21.11. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > keyColor`


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

Description: Color of the module key. Left empty to use display.color.keys

5.1.2.21.12. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.21.13. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > keyWidth`


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

5.1.2.21.14. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > outputColor`


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

Description: Output color of the module. Left empty to use display.color.output

5.1.2.21.15. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > format`


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

Description: Output format of the module Disk. See -h format for formatting syntax 1. {size-used}: Size used 2. {size-total}: Size total 3. {size-percentage}: Size percentage num 4. {files-used}: Files used 5. {files-total}: Files total 6. {files-percentage}: Files percentage num 7. {is-external}: True if external volume 8. {is-hidden}: True if hidden volume 9. {filesystem}: Filesystem 10. {name}: Label / name 11. {is-readonly}: True if read-only 12. {create-time}: Create time in local timezone 13. {size-percentage-bar}: Size percentage bar 14. {files-percentage-bar}: Files percentage bar 15. {(null)}: (null)

5.1.2.22. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO`

Title: DiskIO


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print physical disk I/O throughput
- namePrefix	No	string	No	-	Show disks with given name prefix only
- detectTotal	No	boolean	No	-	Detect total bytes instead of current rate
- waitTime	No	integer	No	-	Wait time (in ms). Disk I/O = (totalBytesEnd - totalBytesStart) / waitTime
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/diskioFormat	Output format of the module `DiskIO`. See `-h format` for formatting syntax 1. {size-read}: Size of data read [per second] (formatted) 2. {size-written}: Size of data written [per second] (formatted) 3. {name}: Device name 4. {dev-path}: Device raw file path 5. {bytes-read}: Size of data read [per second] (in bytes) 6. {bytes-written}: Size of data written [per second] (in bytes) 7. {read-count}: Number of reads 8. {write-count}: Number of writes

5.1.2.22.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > type`


Type	`const`
Required	No

Description: Print physical disk I/O throughput

Specific value: "diskio"

5.1.2.22.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > namePrefix`


Type	`string`
Required	No

Description: Show disks with given name prefix only

5.1.2.22.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > detectTotal`


Type	`boolean`
Required	No
Default	`false`

Description: Detect total bytes instead of current rate

5.1.2.22.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > waitTime`


Type	`integer`
Required	No
Default	`200`

Description: Wait time (in ms). Disk I/O = (totalBytesEnd - totalBytesStart) / waitTime

Restrictions
Minimum	≥ 1

5.1.2.22.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module

5.1.2.22.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > keyColor`


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

Description: Color of the module key. Left empty to use display.color.keys

5.1.2.22.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.22.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > keyWidth`


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

5.1.2.22.9. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > outputColor`


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

Description: Output color of the module. Left empty to use display.color.output

5.1.2.22.10. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > format`


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

Description: Output format of the module DiskIO. See -h format for formatting syntax 1. {size-read}: Size of data read [per second] (formatted) 2. {size-written}: Size of data written [per second] (formatted) 3. {name}: Device name 4. {dev-path}: Device raw file path 5. {bytes-read}: Size of data read [per second] (in bytes) 6. {bytes-written}: Size of data written [per second] (in bytes) 7. {read-count}: Number of reads 8. {write-count}: Number of writes

5.1.2.23. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment`

Title: Desktop Environment


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print desktop environment name
- slowVersionDetection	No	boolean	No	-	Set if DE version should be detected with slow operations. Should be unnecessary for most cases.
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/deFormat	Output format of the module `DE`. See `-h format` for formatting syntax 1. {process-name}: DE process name 2. {pretty-name}: DE pretty name 3. {version}: DE version

5.1.2.23.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > type`


Type	`const`
Required	No

Description: Print desktop environment name

Specific value: "de"

5.1.2.23.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > slowVersionDetection`


Type	`boolean`
Required	No
Default	`"false"`

Description: Set if DE version should be detected with slow operations. Should be unnecessary for most cases.

5.1.2.23.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module

5.1.2.23.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > keyColor`


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

Description: Color of the module key. Left empty to use display.color.keys

5.1.2.23.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.23.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > keyWidth`


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

5.1.2.23.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > outputColor`


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

Description: Output color of the module. Left empty to use display.color.output

5.1.2.23.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > format`


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

Description: Output format of the module DE. See -h format for formatting syntax 1. {process-name}: DE process name 2. {pretty-name}: DE pretty name 3. {version}: DE version

5.1.2.24. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS`

Title: DNS


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print DNS servers
- showType	No	enum (of string)	No	-	Specify the type of DNS servers should be detected
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/dnsFormat	Output format of the module `DNS`. See `-h format` for formatting syntax 1. {result}: DNS result

5.1.2.24.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > type`


Type	`const`
Required	No

Description: Print DNS servers

Specific value: "dns"

5.1.2.24.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > showType`


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

Description: Specify the type of DNS servers should be detected

Must be one of:

"ipv4"
"ipv6"
"both"

5.1.2.24.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module

5.1.2.24.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > keyColor`


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

Description: Color of the module key. Left empty to use display.color.keys

5.1.2.24.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.24.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > keyWidth`


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

5.1.2.24.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > outputColor`


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

Description: Output color of the module. Left empty to use display.color.output

5.1.2.24.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > format`


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

Description: Output format of the module DNS. See -h format for formatting syntax 1. {result}: DNS result

5.1.2.25. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor`

Title: Editor


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print information of the default editor ($VISUAL or $EDITOR)
- percent	No	object	No	Same as percent	Threshold of percentage colors
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/editorFormat	Output format of the module `Editor`. See `-h format` for formatting syntax 1. {type}: Type (Visual / Editor) 2. {name}: Name 3. {exe-name}: Exe name of real path 4. {full-path}: Full path of real path 5. {version}: Version

5.1.2.25.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor > type`


Type	`const`
Required	No

Description: Print information of the default editor ($VISUAL or $EDITOR)

Specific value: "editor"

5.1.2.25.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor > percent`


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

Description: Threshold of percentage colors

5.1.2.25.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module

5.1.2.25.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor > keyColor`


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

Description: Color of the module key. Left empty to use display.color.keys

5.1.2.25.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.25.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor > keyWidth`


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

5.1.2.25.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor > outputColor`


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

Description: Output color of the module. Left empty to use display.color.output

5.1.2.25.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor > format`


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

Description: Output format of the module Editor. See -h format for formatting syntax 1. {type}: Type (Visual / Editor) 2. {name}: Name 3. {exe-name}: Exe name of real path 4. {full-path}: Full path of real path 5. {version}: Version

5.1.2.26. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Font`

Title: Font


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print system font names
- percent	No	object	No	Same as percent	Threshold of percentage colors
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/fontFormat	Output format of the module `Font`. See `-h format` for formatting syntax 1. {font1}: Font 1 2. {font2}: Font 2 3. {font3}: Font 3 4. {font4}: Font 4 5. {combined}: Combined fonts for display

5.1.2.26.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Font > type`


Type	`const`
Required	No

Description: Print system font names

Specific value: "font"

5.1.2.26.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Font > percent`


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

Description: Threshold of percentage colors

5.1.2.26.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Font > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module

5.1.2.26.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Font > keyColor`


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

Description: Color of the module key. Left empty to use display.color.keys

5.1.2.26.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Font > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.26.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Font > keyWidth`


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

5.1.2.26.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Font > outputColor`


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

Description: Output color of the module. Left empty to use display.color.output

5.1.2.26.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Font > format`


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

Description: Output format of the module Font. See -h format for formatting syntax 1. {font1}: Font 1 2. {font2}: Font 2 3. {font3}: Font 3 4. {font4}: Font 4 5. {combined}: Combined fonts for display

5.1.2.27. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad`

Title: Gamepad


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	List connected gamepads
- percent	No	object	No	Same as percent	Threshold of percentage colors
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth	No	integer	No	Same as keyWidth	Width of the module key. Use 0 to use `display.keyWidth`
- outputColor	No	enum (of string)	No	Same as outputColor	Output color of the module. Left empty to use `display.color.output`
- format	No	string	No	In #/$defs/gamepadFormat	Output format of the module `Gamepad`. See `-h format` for formatting syntax 1. {name}: Name 2. {serial}: Serial number 3. {battery-percentage}: Battery percentage num 4. {battery-percentage-bar}: Battery percentage bar

5.1.2.27.1. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > type`


Type	`const`
Required	No

Description: List connected gamepads

Specific value: "gamepad"

5.1.2.27.2. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > percent`


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

Description: Threshold of percentage colors

5.1.2.27.3. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > key`


Type	`string`
Required	No
Same definition as	key

Description: Key of the module

5.1.2.27.4. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > keyColor`


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

Description: Color of the module key. Left empty to use display.color.keys

5.1.2.27.5. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > keyIcon`


Type	`string`
Required	No
Same definition as	keyIcon

Description: Set the icon to be displayed by display.keyType: "icon"

5.1.2.27.6. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > keyWidth`


Type	`integer`
Required	No
Default	`0`
Same definition as	keyWidth

Description: Width of the module key. Use 0 to use display.keyWidth

5.1.2.27.7. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > outputColor`


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

Description: Output color of the module. Left empty to use display.color.output

5.1.2.27.8. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > format`


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

Description: Output format of the module Gamepad. See -h format for formatting syntax 1. {name}: Name 2. {serial}: Serial number 3. {battery-percentage}: Battery percentage num 4. {battery-percentage-bar}: Battery percentage bar

5.1.2.28. Property `JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU`

Title: GPU


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated	Definition	Title/Description
- type	No	const	No	-	Print GPU names, graphic memory size, type, etc
- temp	No	object	No	Same as temp	Detect and display temperature if supported
- driverSpecific	No	boolean	No	-	Use driver specific method to detect more detailed GPU information (memory usage, core count, etc)
- detectionMethod	No	enum (of string)	No	-	Force using a specified method to detect GPUs
- hideType	No	enum (of string)	No	-	Specify the type of GPUs should not be printed
- key	No	string	No	Same as key	Key of the module
- keyColor	No	enum (of string)	No	Same as keyColor	Color of the module key. Left empty to use `display.color.keys`
- keyIcon	No	string	No	Same as keyIcon	Set the icon to be displayed by `display.keyType: "icon"`

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.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.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.5. Property JSON config > logo > oneOf > item 2 > height

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

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

3. Property JSON config > general

3.1. Property JSON config > general > multithreading

3.2. Property JSON config > general > thread

3.3. Property JSON config > general > escapeBedrock

3.4. Property JSON config > general > playerName

3.5. Property JSON config > general > dsForceDrm

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

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

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

3.6. Property JSON config > general > wmiTimeout

3.7. Property JSON config > general > processingTimeout

3.8. Property JSON config > general > preRun

3.9. Property JSON config > general > detectVersion

4. Property JSON config > display

4.1. Property JSON config > display > stat

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

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

4.2. Property JSON config > display > pipe

4.3. Property JSON config > display > showErrors

4.4. Property JSON config > display > disableLinewrap

4.5. Property JSON config > display > hideCursor

4.6. Property JSON config > display > separator

4.7. Property JSON config > display > color

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

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

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

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

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

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

4.8. Property JSON config > display > brightColor

4.9. Property JSON config > display > key

4.9.1. Property JSON config > display > key > width

4.9.2. Property JSON config > display > key > type

4.9.3. Property JSON config > display > key > paddingLeft

4.10. Property JSON config > display > size

4.10.1. Property JSON config > display > size > binaryPrefix

4.10.1.1. Property JSON config > display > size > binaryPrefix > oneOf > item 0

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

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

4.10.2. Property JSON config > display > size > maxPrefix

4.10.3. Property JSON config > display > size > ndigits

4.11. Property JSON config > display > temp

4.11.1. Property JSON config > display > temp > unit

4.11.2. Property JSON config > display > temp > ndigits

4.11.3. Property JSON config > display > temp > color

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

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

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

3. Property `JSON config > general`

3.1. Property `JSON config > general > multithreading`

3.2. Property `JSON config > general > thread`

3.3. Property `JSON config > general > escapeBedrock`

3.4. Property `JSON config > general > playerName`

3.5. Property `JSON config > general > dsForceDrm`

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

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

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

3.6. Property `JSON config > general > wmiTimeout`

3.7. Property `JSON config > general > processingTimeout`

3.8. Property `JSON config > general > preRun`

3.9. Property `JSON config > general > detectVersion`

4. Property `JSON config > display`

4.1. Property `JSON config > display > stat`

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

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

4.2. Property `JSON config > display > pipe`

4.3. Property `JSON config > display > showErrors`

4.4. Property `JSON config > display > disableLinewrap`

4.5. Property `JSON config > display > hideCursor`

4.6. Property `JSON config > display > separator`

4.7. Property `JSON config > display > color`

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

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

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

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

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

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

4.8. Property `JSON config > display > brightColor`

4.9. Property `JSON config > display > key`

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

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

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

4.10. Property `JSON config > display > size`

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

4.10.1.1. Property `JSON config > display > size > binaryPrefix > oneOf > item 0`

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

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

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

4.10.3. Property `JSON config > display > size > ndigits`

4.11. Property `JSON config > display > temp`

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

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

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

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

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