42 Json Schema
Carter Li edited this page 2026-06-03 16:10:06 +08:00

JSON config

Title: JSON config

Type object
Required No
Additional properties Not allowed

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

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

1. Property JSON config > $schema

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

Description: JSON Schema URL for validation and IDE support

Type combining
Required No
Additional properties Any type allowed

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

One of(Option)
item 0
item 1
item 2

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

Type const
Required No

Description: Disable logo

Specific value: null

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

Type string
Required No

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

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

Type object
Required No
Additional properties Not allowed

Description: Fastfetch logo configuration

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

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

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

Description: Logo type

One of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
item 6
item 7
item 8
item 9
item 10
item 11
item 12
item 13
item 14
item 15
2.3.1.1. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 0
Type const
Required No

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

Specific value: "auto"

2.3.1.2. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 1
Type const
Required No

Description: Built-in ASCII art

Specific value: "builtin"

2.3.1.3. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 2
Type const
Required No

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

Specific value: "small"

2.3.1.4. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 3
Type const
Required No

Description: Text file with color code replacement

Specific value: "file"

2.3.1.5. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 4
Type const
Required No

Description: Text file, printed as is

Specific value: "file-raw"

2.3.1.6. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 5
Type const
Required No

Description: Text data with color code replacement

Specific value: "data"

2.3.1.7. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 6
Type const
Required No

Description: Text data, printed as is

Specific value: "data-raw"

2.3.1.8. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 7
Type const
Required No

Description: Command that generates text data, printed as is

Specific value: "command-raw"

2.3.1.9. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 8
Type const
Required No

Description: Image file rendered as sixel

Specific value: "sixel"

2.3.1.10. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 9
Type const
Required No

Description: Image file rendered using the Kitty graphics protocol

Specific value: "kitty"

2.3.1.11. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 10
Type const
Required No

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

Specific value: "kitty-direct"

2.3.1.12. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 11
Type const
Required No

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

Specific value: "kitty-icat"

2.3.1.13. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 12
Type const
Required No

Description: Image file rendered using the iTerm image protocol

Specific value: "iterm"

2.3.1.14. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 13
Type const
Required No

Description: Image file rendered as ASCII art using libchafa

Specific value: "chafa"

2.3.1.15. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 14
Type const
Required No

Description: Image file rendered as a raw binary string

Specific value: "raw"

2.3.1.16. Property JSON config > logo > oneOf > item 2 > type > oneOf > item 15
Type const
Required No

Description: Disable logo printing

Specific value: "none"

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

Type string
Required No

Description: Path to the logo source file

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

Type object
Required No
Additional properties Not allowed

Description: Override colors in the logo

Property Pattern Type Deprecated Definition Title/Description
- 1 No object No In #/$defs/colors Color 1
- 2 No object No Same as 1 Color 2
- 3 No object No Same as 1 Color 3
- 4 No object No Same as 1 Color 4
- 5 No object No Same as 1 Color 5
- 6 No object No Same as 1 Color 6
- 7 No object No Same as 1 Color 7
- 8 No object No Same as 1 Color 8
- 9 No object No Same as 1 Color 9
2.3.3.1. Property JSON config > logo > oneOf > item 2 > color > 1
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/colors

Description: Color 1

One of(Option)
item 0
item 1
2.3.3.1.1. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Type string
Required No

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
2.3.3.1.2. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Type null
Required No
2.3.3.2. Property JSON config > logo > oneOf > item 2 > color > 2
Type combining
Required No
Additional properties Any type allowed
Same definition as 1

Description: Color 2

2.3.3.3. Property JSON config > logo > oneOf > item 2 > color > 3
Type combining
Required No
Additional properties Any type allowed
Same definition as 1

Description: Color 3

2.3.3.4. Property JSON config > logo > oneOf > item 2 > color > 4
Type combining
Required No
Additional properties Any type allowed
Same definition as 1

Description: Color 4

2.3.3.5. Property JSON config > logo > oneOf > item 2 > color > 5
Type combining
Required No
Additional properties Any type allowed
Same definition as 1

Description: Color 5

2.3.3.6. Property JSON config > logo > oneOf > item 2 > color > 6
Type combining
Required No
Additional properties Any type allowed
Same definition as 1

Description: Color 6

2.3.3.7. Property JSON config > logo > oneOf > item 2 > color > 7
Type combining
Required No
Additional properties Any type allowed
Same definition as 1

Description: Color 7

2.3.3.8. Property JSON config > logo > oneOf > item 2 > color > 8
Type combining
Required No
Additional properties Any type allowed
Same definition as 1

Description: Color 8

2.3.3.9. Property JSON config > logo > oneOf > item 2 > color > 9
Type combining
Required No
Additional properties Any type allowed
Same definition as 1

Description: Color 9

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

Type combining
Required No
Additional properties Any type allowed
One of(Option)
item 0
item 1
2.3.4.1. Property JSON config > logo > oneOf > item 2 > width > oneOf > item 0
Type null
Required No

Description: Auto-detect the width (default)

2.3.4.2. Property JSON config > logo > oneOf > item 2 > width > oneOf > item 1
Type integer
Required No

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

Restrictions
Minimum ≥ 1

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

Type combining
Required No
Additional properties Any type allowed
One of(Option)
item 0
item 1
2.3.5.1. Property JSON config > logo > oneOf > item 2 > height > oneOf > item 0
Type null
Required No

Description: Auto-detect the height (default)

2.3.5.2. Property JSON config > logo > oneOf > item 2 > height > oneOf > item 1
Type integer
Required No

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

Restrictions
Minimum ≥ 1

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

Type object
Required No
Additional properties Not allowed

Description: Logo padding

Property Pattern Type Deprecated Definition Title/Description
- top No integer No - Top padding of the logo
- bottom No integer No - Bottom padding of the logo; only supported when position is `top`
- left No integer No - Left padding of the logo
- right No integer No - Right padding of the logo
2.3.6.1. Property JSON config > logo > oneOf > item 2 > padding > top
Type integer
Required No

Description: Top padding of the logo

Restrictions
Minimum ≥ 0
2.3.6.2. Property JSON config > logo > oneOf > item 2 > padding > bottom
Type integer
Required No

Description: Bottom padding of the logo; only supported when position is top

Restrictions
Minimum ≥ 0
2.3.6.3. Property JSON config > logo > oneOf > item 2 > padding > left
Type integer
Required No

Description: Left padding of the logo

Restrictions
Minimum ≥ 0
2.3.6.4. Property JSON config > logo > oneOf > item 2 > padding > right
Type integer
Required No

Description: Right padding of the logo

Restrictions
Minimum ≥ 0

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

Type boolean
Required No
Default true

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

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

Type boolean
Required No
Default false

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

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

Type boolean
Required No
Default false

Description: If true, regenerate image logo cache

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

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

Description: Position of the logo

Must be one of:

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

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

Type object
Required No
Additional properties Not allowed

Description: Chafa configuration. See chafa documentation for details

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

Description: Produce character-cell output using foreground colors only

2.3.11.2. Property JSON config > logo > oneOf > item 2 > chafa > symbols
Type string
Required No

Description: Specify character symbols to employ in final output

2.3.11.3. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode
Type combining
Required No

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

One of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
item 6
item 7
2.3.11.3.1. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 0
Type const
Required No

Description: Use 24-bit true colors

Specific value: "TRUECOLOR"

2.3.11.3.2. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 1
Type const
Required No

Description: Use 256 colors

Specific value: "INDEXED_256"

2.3.11.3.3. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 2
Type const
Required No

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

Specific value: "INDEXED_240"

2.3.11.3.4. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 3
Type const
Required No

Description: Use 16 colors using the aixterm ANSI extension

Specific value: "INDEXED_16"

2.3.11.3.5. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 4
Type const
Required No

Description: Use default foreground and background colors, plus inversion

Specific value: "FGBG_BGFG"

2.3.11.3.6. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 5
Type const
Required No

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

Specific value: "FGBG"

2.3.11.3.7. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 6
Type const
Required No

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

Specific value: "INDEXED_8"

2.3.11.3.8. Property JSON config > logo > oneOf > item 2 > chafa > canvasMode > oneOf > item 7
Type const
Required No

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

Specific value: "INDEXED_16_8"

2.3.11.4. Property JSON config > logo > oneOf > item 2 > chafa > colorSpace
Type combining
Required No

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

One of(Option)
item 0
item 1
2.3.11.4.1. Property JSON config > logo > oneOf > item 2 > chafa > colorSpace > oneOf > item 0
Type const
Required No

Description: RGB color space. Fast but imprecise

Specific value: "RGB"

2.3.11.4.2. Property JSON config > logo > oneOf > item 2 > chafa > colorSpace > oneOf > item 1
Type const
Required No

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

Specific value: "DIN99D"

2.3.11.5. Property JSON config > logo > oneOf > item 2 > chafa > ditherMode
Type combining
Required No

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

One of(Option)
item 0
item 1
item 2
2.3.11.5.1. Property JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 0
Type const
Required No

Description: No dithering

Specific value: "NONE"

2.3.11.5.2. Property JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 1
Type const
Required No

Description: Ordered dithering (Bayer or similar)

Specific value: "ORDERED"

2.3.11.5.3. Property JSON config > logo > oneOf > item 2 > chafa > ditherMode > oneOf > item 2
Type const
Required No

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

Specific value: "DIFFUSION"

3. Property JSON config > general

Type object
Required No
Additional properties Not allowed

Description: General Fastfetch configuration

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

3.1. Property JSON config > general > thread

Type boolean
Required No
Default true

Description: Use separate threads for HTTP requests

3.2. Property JSON config > general > escapeBedrock

Type boolean
Required No
Default true

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

3.3. Property JSON config > general > playerName

Type string
Required No

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

3.4. Property JSON config > general > dsForceDrm

Type combining
Required No
Additional properties Any type allowed
Default false

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

One of(Option)
item 0
item 1
item 2

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

Type const
Required No

Description: Try wayland, then x11, then drm

Specific value: false

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

Type const
Required No

Description: Use /sys/class/drm only

Specific value: "sysfs-only"

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

Type const
Required No

Description: Try libdrm first, then sysfs if libdrm fails

Specific value: true

3.5. Property JSON config > general > processingTimeout

Type integer
Required No
Default 5000

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

3.6. Property JSON config > general > preRun

Type string
Required No
Default ""

Description: Command to run before printing logos

3.7. Property JSON config > general > detectVersion

Type boolean
Required No
Default true

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

4. Property JSON config > display

Type object
Required No
Additional properties Not allowed

Description: Configure output formatting

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

4.1. Property JSON config > display > stat

Type combining
Required No
Additional properties Any type allowed

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

One of(Option)
item 0
item 1

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

Type boolean
Required No
Default false

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

Type integer
Required No
Restrictions
Minimum ≥ 1

4.2. Property JSON config > display > pipe

Type boolean
Required No
Default false

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

4.3. Property JSON config > display > showErrors

Type boolean
Required No
Default false

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

4.4. Property JSON config > display > disableLinewrap

Type boolean
Required No
Default true

Description: Whether to disable line wrap during execution

4.5. Property JSON config > display > hideCursor

Type boolean
Required No
Default true

Description: Whether to hide the cursor during execution

4.6. Property JSON config > display > separator

Type string
Required No
Default ": "

Description: Separator between the key and value

4.7. Property JSON config > display > color

Type combining
Required No
Additional properties Any type allowed

Description: Color of keys and titles

One of(Option)
colors
item 1

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

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

Description: Color for both keys and titles

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

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- keys No object No Same as 1 Color of keys
- title No object No Same as 1 Color of titles
- output No object No Same as 1 Color of module output
- separator No object No Same as 1 Color of the key-value separator
4.7.2.1. Property JSON config > display > color > oneOf > item 1 > keys
Type combining
Required No
Additional properties Any type allowed
Same definition as 1

Description: Color of keys

4.7.2.2. Property JSON config > display > color > oneOf > item 1 > title
Type combining
Required No
Additional properties Any type allowed
Same definition as 1

Description: Color of titles

4.7.2.3. Property JSON config > display > color > oneOf > item 1 > output
Type combining
Required No
Additional properties Any type allowed
Same definition as 1

Description: Color of module output

4.7.2.4. Property JSON config > display > color > oneOf > item 1 > separator
Type combining
Required No
Additional properties Any type allowed
Same definition as 1

Description: Color of the key-value separator

4.8. Property JSON config > display > brightColor

Type boolean
Required No
Default true

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

4.9. Property JSON config > display > key

Type object
Required No
Additional properties Not allowed

Description: Configure how module keys are displayed

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

4.9.1. Property JSON config > display > key > width

Type integer
Required No
Default 0

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

Restrictions
Minimum ≥ 0

4.9.2. Property JSON config > display > key > type

Type combining
Required No
Default "string"

Description: Whether to show a built-in icon before string keys

One of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
item 6
item 7
item 8
4.9.2.1. Property JSON config > display > key > type > oneOf > item 0
Type const
Required No

Description: Disable keys

Specific value: "none"

4.9.2.2. Property JSON config > display > key > type > oneOf > item 1
Type const
Required No

Description: Show string keys

Specific value: "string"

4.9.2.3. Property JSON config > display > key > type > oneOf > item 2
Type const
Required No

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

Specific value: "icon"

4.9.2.4. Property JSON config > display > key > type > oneOf > item 3
Type const
Required No

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

Specific value: "both"

4.9.2.5. Property JSON config > display > key > type > oneOf > item 4
Type const
Required No

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

Specific value: "both-0"

4.9.2.6. Property JSON config > display > key > type > oneOf > item 5
Type const
Required No

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

Specific value: "both-1"

4.9.2.7. Property JSON config > display > key > type > oneOf > item 6
Type const
Required No

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

Specific value: "both-2"

4.9.2.8. Property JSON config > display > key > type > oneOf > item 7
Type const
Required No

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

Specific value: "both-3"

4.9.2.9. Property JSON config > display > key > type > oneOf > item 8
Type const
Required No

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

Specific value: "both-4"

4.9.3. Property JSON config > display > key > paddingLeft

Type integer
Required No
Default 0

Description: Left padding for keys

Restrictions
Minimum ≥ 0

4.10. Property JSON config > display > size

Type object
Required No
Additional properties Not allowed

Description: Configure how sizes are displayed

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

4.10.1. Property JSON config > display > size > binaryPrefix

Type combining
Required No
Default "iec"

Description: Set the binary prefix to use when formatting sizes

One of(Option)
item 0
item 1
item 2
4.10.1.1. Property JSON config > display > size > binaryPrefix > oneOf > item 0
Type const
Required No

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

Specific value: "iec"

4.10.1.2. Property JSON config > display > size > binaryPrefix > oneOf > item 1
Type const
Required No

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

Specific value: "si"

4.10.1.3. Property JSON config > display > size > binaryPrefix > oneOf > item 2
Type const
Required No

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

Specific value: "jedec"

4.10.2. Property JSON config > display > size > maxPrefix

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

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

Must be one of:

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

4.10.3. Property JSON config > display > size > ndigits

Type integer
Required No
Default 2

Description: Number of decimal places to use when formatting sizes

Restrictions
Minimum ≥ 0
Maximum ≤ 9

4.10.4. Property JSON config > display > size > spaceBeforeUnit

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

Description: Whether to insert a space before the unit

One of(Option)
item 0
item 1
item 2
4.10.4.1. Property JSON config > display > size > spaceBeforeUnit > oneOf > item 0
Type const
Required No

Description: Use the default behavior of the module

Specific value: "default"

4.10.4.2. Property JSON config > display > size > spaceBeforeUnit > oneOf > item 1
Type const
Required No

Description: Always add a space before the unit

Specific value: "always"

4.10.4.3. Property JSON config > display > size > spaceBeforeUnit > oneOf > item 2
Type const
Required No

Description: Never add a space before the unit

Specific value: "never"

4.11. Property JSON config > display > temp

Type object
Required No
Additional properties Not allowed

Description: Configure how temperatures are displayed

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

4.11.1. Property JSON config > display > temp > unit

Type combining
Required No
Default "D"

Description: Set the unit of temperature

One of(Option)
item 0
item 1
item 2
item 3
4.11.1.1. Property JSON config > display > temp > unit > oneOf > item 0
Type const
Required No

Description: Celsius

Specific value: "C"

4.11.1.2. Property JSON config > display > temp > unit > oneOf > item 1
Type const
Required No

Description: Fahrenheit

Specific value: "F"

4.11.1.3. Property JSON config > display > temp > unit > oneOf > item 2
Type const
Required No

Description: Kelvin

Specific value: "K"

4.11.1.4. Property JSON config > display > temp > unit > oneOf > item 3
Type const
Required No

Description: Default (alias for Celsius)

Specific value: "D"

4.11.2. Property JSON config > display > temp > ndigits

Type integer
Required No
Default 1

Description: Number of decimal places to use when formatting temperatures

Restrictions
Minimum ≥ 0
Maximum ≤ 9

4.11.3. Property JSON config > display > temp > color

Type object
Required No
Additional properties Not allowed

Description: Colors used for different temperature states

Property Pattern Type Deprecated Definition Title/Description
- green No object No In #/$defs/colors Color used in green state
- yellow No object No In #/$defs/colors Color used in yellow state
- red No object No In #/$defs/colors Color used in red state
4.11.3.1. Property JSON config > display > temp > color > green
Type combining
Required No
Additional properties Any type allowed
Default "green"
Defined in #/$defs/colors

Description: Color used in green state

One of(Option)
item 0
item 1
4.11.3.1.1. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Type string
Required No

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.11.3.1.2. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Type null
Required No
4.11.3.2. Property JSON config > display > temp > color > yellow
Type combining
Required No
Additional properties Any type allowed
Default "light_yellow"
Defined in #/$defs/colors

Description: Color used in yellow state

One of(Option)
item 0
item 1
4.11.3.2.1. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Type string
Required No

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.11.3.2.2. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Type null
Required No
4.11.3.3. Property JSON config > display > temp > color > red
Type combining
Required No
Additional properties Any type allowed
Default "light_red"
Defined in #/$defs/colors

Description: Color used in red state

One of(Option)
item 0
item 1
4.11.3.3.1. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Type string
Required No

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.11.3.3.2. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Type null
Required No

4.11.4. Property JSON config > display > temp > spaceBeforeUnit

Type combining
Required No
Same definition as spaceBeforeUnit

Description: Whether to insert a space before the unit

4.12. Property JSON config > display > bar

Type object
Required No
Additional properties Not allowed

Description: Bar configuration

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

4.12.1. Property JSON config > display > bar > char

Type object
Required No
Additional properties Not allowed

Description: Characters used in the bar

Property Pattern Type Deprecated Definition Title/Description
- elapsed No string No - Character used for the elapsed portion
- total No string No - Character used for the remaining portion
4.12.1.1. Property JSON config > display > bar > char > elapsed
Type string
Required No
Default "■"

Description: Character used for the elapsed portion

4.12.1.2. Property JSON config > display > bar > char > total
Type string
Required No
Default "-"

Description: Character used for the remaining portion

4.12.2. Property JSON config > display > bar > border

Type combining
Required No
Additional properties Any type allowed
One of(Option)
item 0
item 1
4.12.2.1. Property JSON config > display > bar > border > oneOf > item 0
Type null
Required No

Description: Disable bar borders

4.12.2.2. Property JSON config > display > bar > border > oneOf > item 1
Type object
Required No
Additional properties Not allowed

Description: Strings used for percentage bar borders

Property Pattern Type Deprecated Definition Title/Description
- left No string No - String used for the left border
- right No string No - String used for the right border
- leftElapsed No string No - If both `leftElapsed` and `rightElapsed` are set, the border is used as part of the bar content
- rightElapsed No string No - If both `leftElapsed` and `rightElapsed` are set, the border is used as part of the bar content
4.12.2.2.1. Property JSON config > display > bar > border > oneOf > item 1 > left
Type string
Required No
Default "[ "

Description: String used for the left border

4.12.2.2.2. Property JSON config > display > bar > border > oneOf > item 1 > right
Type string
Required No
Default " ]"

Description: String used for the right border

4.12.2.2.3. Property JSON config > display > bar > border > oneOf > item 1 > leftElapsed
Type string
Required No
Default ""

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

4.12.2.2.4. Property JSON config > display > bar > border > oneOf > item 1 > rightElapsed
Type string
Required No
Default ""

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

4.12.3. Property JSON config > display > bar > color

Type combining
Required No
Additional properties Any type allowed
One of(Option)
item 0
item 1
4.12.3.1. Property JSON config > display > bar > color > oneOf > item 0
Type null
Required No

Description: Disable color in percentage bars

4.12.3.2. Property JSON config > display > bar > color > oneOf > item 1
Type object
Required No
Additional properties Not allowed

Description: Colors used for percentage bars

Property Pattern Type Deprecated Definition Title/Description
- elapsed No object No In #/$defs/colors Color used for the elapsed portion of percentage bars
By default, it is selected automatically from `percent.color.{green,yellow,red}`
- total No object No In #/$defs/colors Color used for the remaining portion of percentage bars
- border No object No In #/$defs/colors Color used for percentage bar borders
4.12.3.2.1. Property JSON config > display > bar > color > oneOf > item 1 > elapsed
Type combining
Required No
Additional properties Any type allowed
Default "auto"
Defined in #/$defs/colors

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

One of(Option)
item 0
item 1
4.12.3.2.1.1. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Type string
Required No

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.12.3.2.1.2. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Type null
Required No
4.12.3.2.2. Property JSON config > display > bar > color > oneOf > item 1 > total
Type combining
Required No
Additional properties Any type allowed
Default "light_white"
Defined in #/$defs/colors

Description: Color used for the remaining portion of percentage bars

One of(Option)
item 0
item 1
4.12.3.2.2.1. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Type string
Required No

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.12.3.2.2.2. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Type null
Required No
4.12.3.2.3. Property JSON config > display > bar > color > oneOf > item 1 > border
Type combining
Required No
Additional properties Any type allowed
Default "light_white"
Defined in #/$defs/colors

Description: Color used for percentage bar borders

One of(Option)
item 0
item 1
4.12.3.2.3.1. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Type string
Required No

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.12.3.2.3.2. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Type null
Required No

4.12.4. Property JSON config > display > bar > width

Type integer
Required No
Default 10

Description: Width of the bar in characters

Restrictions
Minimum ≥ 1

4.13. Property JSON config > display > percent

Type object
Required No
Additional properties Not allowed

Description: Configure how percentages are displayed

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

4.13.1. Property JSON config > display > percent > type

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

Description: Percentage output style

One of(Option)
item 0
item 1
4.13.1.1. Property JSON config > display > percent > type > oneOf > item 0
Type number
Required No
Default 9

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

Restrictions
Minimum ≥ 0
Maximum ≤ 255
4.13.1.2. Property JSON config > display > percent > type > oneOf > item 1
Type array of enum (of string)
Required No
Default ["num", "num-color"]

Description: Array of style flags

Array restrictions
Min items N/A
Max items N/A
Items unicity True
Additional items False
Tuple validation See below
Each item of this array must be Description
item 1 items -
4.13.1.2.1. JSON config > display > percent > type > oneOf > item 1 > item 1 items
Type enum (of string)
Required No

Must be one of:

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

4.13.2. Property JSON config > display > percent > ndigits

Type number
Required No
Default 0

Description: Number of decimal places to use when formatting percentages

Restrictions
Minimum ≥ 0
Maximum ≤ 9

4.13.3. Property JSON config > display > percent > color

Type object
Required No
Additional properties Not allowed

Description: Colors used for different percentage states

Property Pattern Type Deprecated Definition Title/Description
- green No object No In #/$defs/colors Color used in green state
- yellow No object No In #/$defs/colors Color used in yellow state
- red No object No In #/$defs/colors Color used in red state
4.13.3.1. Property JSON config > display > percent > color > green
Type combining
Required No
Additional properties Any type allowed
Default "green"
Defined in #/$defs/colors

Description: Color used in green state

One of(Option)
item 0
item 1
4.13.3.1.1. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Type string
Required No

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.13.3.1.2. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Type null
Required No
4.13.3.2. Property JSON config > display > percent > color > yellow
Type combining
Required No
Additional properties Any type allowed
Default "light_yellow"
Defined in #/$defs/colors

Description: Color used in yellow state

One of(Option)
item 0
item 1
4.13.3.2.1. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Type string
Required No

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.13.3.2.2. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Type null
Required No
4.13.3.3. Property JSON config > display > percent > color > red
Type combining
Required No
Additional properties Any type allowed
Default "light_red"
Defined in #/$defs/colors

Description: Color used in red state

One of(Option)
item 0
item 1
4.13.3.3.1. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 0
Type string
Required No

Examples:

"reset_"
"bright_"
"dim_"
"italic_"
"underline_"
"blink_"
"inverse_"
"hidden_"
"strike_"
"light_"
"black"
"red"
"green"
"yellow"
"blue"
"magenta"
"cyan"
"white"
"default"
4.13.3.3.2. Property JSON config > logo > oneOf > item 2 > color > 1 > oneOf > item 1
Type null
Required No

4.13.4. Property JSON config > display > percent > spaceBeforeUnit

Type combining
Required No
Same definition as spaceBeforeUnit

Description: Whether to insert a space before the unit

4.13.5. Property JSON config > display > percent > width

Type integer
Required No
Default 0

Description: Width of the percentage number in characters

Restrictions
Minimum ≥ 0

4.14. Property JSON config > display > freq

Type object
Required No
Additional properties Not allowed

Description: Configure how frequencies are displayed

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

4.14.1. Property JSON config > display > freq > ndigits

Type combining
Required No
Additional properties Any type allowed
Default 2

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

One of(Option)
item 0
item 1
4.14.1.1. Property JSON config > display > freq > ndigits > oneOf > item 0
Type integer
Required No

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

Restrictions
Minimum ≥ 0
Maximum ≤ 9
4.14.1.2. Property JSON config > display > freq > ndigits > oneOf > item 1
Type null
Required No

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

4.14.2. Property JSON config > display > freq > spaceBeforeUnit

Type combining
Required No
Same definition as spaceBeforeUnit

Description: Whether to insert a space before the unit

4.15. Property JSON config > display > duration

Type object
Required No
Additional properties Any type allowed

Description: Configure how durations are displayed

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

4.15.1. Property JSON config > display > duration > abbreviation

Type boolean
Required No
Default false

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

4.15.2. Property JSON config > display > duration > spaceBeforeUnit

Type combining
Required No
Same definition as spaceBeforeUnit

Description: Whether to insert a space before the unit

4.16. Property JSON config > display > fraction

Type object
Required No
Additional properties Not allowed

Description: Configure how fractional values are displayed

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

4.16.1. Property JSON config > display > fraction > ndigits

Type combining
Required No
Additional properties Any type allowed
Default 2
One of(Option)
item 0
item 1
4.16.1.1. Property JSON config > display > fraction > ndigits > oneOf > item 0
Type number
Required No

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

Restrictions
Minimum ≥ 0
Maximum ≤ 9
4.16.1.2. Property JSON config > display > fraction > ndigits > oneOf > item 1
Type null
Required No

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

4.16.2. Property JSON config > display > fraction > trailingZeros

Type combining
Required No
Additional properties Any type allowed
Default null

Description: Control when trailing zeros are preserved

One of(Option)
item 0
item 1
item 2
item 3
4.16.2.1. Property JSON config > display > fraction > trailingZeros > oneOf > item 0
Type null
Required No

Description: Same as default

4.16.2.2. Property JSON config > display > fraction > trailingZeros > oneOf > item 1
Type const
Required No

Description: Use the built-in behavior

Specific value: "default"

4.16.2.3. Property JSON config > display > fraction > trailingZeros > oneOf > item 2
Type const
Required No

Description: Always keep trailing zeros

Specific value: "always"

4.16.2.4. Property JSON config > display > fraction > trailingZeros > oneOf > item 3
Type const
Required No

Description: Never keep trailing zeros

Specific value: "never"

4.17. Property JSON config > display > common

Type object
Required No
Additional properties Not allowed

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

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

4.17.1. Property JSON config > display > common > ndigits

Type integer
Required No

Description: Default number of decimal places to display

Restrictions
Minimum ≥ 0
Maximum ≤ 9

4.17.2. Property JSON config > display > common > spaceBeforeUnit

Type combining
Required No
Same definition as spaceBeforeUnit

Description: Whether to insert a space before the unit

4.18. Property JSON config > display > noBuffer

Type boolean
Required No
Default false

Description: Whether to disable stdout buffering

4.19. Property JSON config > display > constants

Type array of string
Required No

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

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
constants items -

4.19.1. JSON config > display > constants > constants items

Type string
Required No

5. Property JSON config > modules

Type array
Required No

Description: Modules to run

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
modules items -

5.1. JSON config > modules > modules items

Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1

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

Type enum (of string)
Required No

Description: Run a module with its default configuration

Must be one of:

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

5.1.2. Property JSON config > modules > modules items > anyOf > item 1

Type combining
Required No
Additional properties Any type allowed

Description: Run a module with a custom configuration

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

Title: Break

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print an empty line
- condition No object No In #/$defs/conditions Show the module only if these conditions are met
5.1.2.1.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > type
Type const
Required No

Description: Print an empty line

Specific value: "break"

5.1.2.1.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition
Type object
Required No
Additional properties Not allowed
Defined in #/$defs/conditions

Description: Show the module only if these conditions are met

Property Pattern Type Deprecated Definition Title/Description
- system No Combination No - System to match
- !system No Combination No - System not to match
- arch No Combination No - Architecture to match
- !arch No Combination No - Architecture not to match
- succeeded No Combination No - Whether the module succeeded in the last run
5.1.2.1.2.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system
Type combining
Required No
Additional properties Any type allowed

Description: System to match

One of(Option)
systems
item 1
item 2
5.1.2.1.2.1.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system > oneOf > systems
Type enum (of string)
Required No
Defined in #/$defs/systems

Must be one of:

  • "Android"
  • "Linux"
  • "DragonFly"
  • "MidnightBSD"
  • "FreeBSD"
  • "macOS"
  • "Windows"
  • "SunOS"
  • "OpenBSD"
  • "NetBSD"
  • "Haiku"
5.1.2.1.2.1.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system > oneOf > item 1
Type array
Required No

Description: Array of systems to match

Array restrictions
Min items N/A
Max items N/A
Items unicity True
Additional items False
Tuple validation See below
Each item of this array must be Description
systems -
5.1.2.1.2.1.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system > oneOf > item 1 > systems
Type enum (of string)
Required No
Same definition as modules_items_anyOf_i1_oneOf_i0_condition_system_oneOf_i0
5.1.2.1.2.1.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > system > oneOf > item 2
Type null
Required No

Description: Set to null to disable this condition

5.1.2.1.2.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system
Type combining
Required No
Additional properties Any type allowed

Description: System not to match

One of(Option)
systems
item 1
item 2
5.1.2.1.2.2.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system > oneOf > systems
Type enum (of string)
Required No
Same definition as modules_items_anyOf_i1_oneOf_i0_condition_system_oneOf_i0
5.1.2.1.2.2.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system > oneOf > item 1
Type array
Required No

Description: Array of systems not to match

Array restrictions
Min items N/A
Max items N/A
Items unicity True
Additional items False
Tuple validation See below
Each item of this array must be Description
systems -
5.1.2.1.2.2.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system > oneOf > item 1 > systems
Type enum (of string)
Required No
Same definition as modules_items_anyOf_i1_oneOf_i0_condition_system_oneOf_i0
5.1.2.1.2.2.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !system > oneOf > item 2
Type null
Required No

Description: Set to null to disable this condition

5.1.2.1.2.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch
Type combining
Required No
Additional properties Any type allowed

Description: Architecture to match

One of(Option)
architectures
item 1
item 2
5.1.2.1.2.3.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch > oneOf > architectures
Type enum (of string)
Required No
Defined in #/$defs/architectures

Must be one of:

  • "x86_64"
  • "i386"
  • "ia64"
  • "aarch64"
  • "arm"
  • "mips"
  • "powerpc"
  • "riscv"
  • "s390x"
  • "loongarch"
  • "sparc"
  • "alpha"
  • "hppa"
  • "m68k"
5.1.2.1.2.3.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch > oneOf > item 1
Type array
Required No

Description: Array of architectures to match

Array restrictions
Min items N/A
Max items N/A
Items unicity True
Additional items False
Tuple validation See below
Each item of this array must be Description
architectures -
5.1.2.1.2.3.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch > oneOf > item 1 > architectures
Type enum (of string)
Required No
Same definition as modules_items_anyOf_i1_oneOf_i0_condition_arch_oneOf_i0
5.1.2.1.2.3.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > arch > oneOf > item 2
Type null
Required No

Description: Set to null to disable this condition

5.1.2.1.2.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch
Type combining
Required No
Additional properties Any type allowed

Description: Architecture not to match

One of(Option)
architectures
item 1
item 2
5.1.2.1.2.4.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch > oneOf > architectures
Type enum (of string)
Required No
Same definition as modules_items_anyOf_i1_oneOf_i0_condition_arch_oneOf_i0
5.1.2.1.2.4.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch > oneOf > item 1
Type array
Required No

Description: Array of architectures not to match

Array restrictions
Min items N/A
Max items N/A
Items unicity True
Additional items False
Tuple validation See below
Each item of this array must be Description
architectures -
5.1.2.1.2.4.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch > oneOf > item 1 > architectures
Type enum (of string)
Required No
Same definition as modules_items_anyOf_i1_oneOf_i0_condition_arch_oneOf_i0
5.1.2.1.2.4.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > !arch > oneOf > item 2
Type null
Required No

Description: Set to null to disable this condition

5.1.2.1.2.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > succeeded
Type combining
Required No
Additional properties Any type allowed

Description: Whether the module succeeded in the last run

One of(Option)
item 0
item 1
5.1.2.1.2.5.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > succeeded > oneOf > item 0
Type boolean
Required No

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

5.1.2.1.2.5.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Break > condition > succeeded > oneOf > item 1
Type null
Required No

Description: Set to null to disable this condition

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

Title: Battery

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print battery information
- temp No object No In #/$defs/temperature Whether to detect and display temperature, if supported
- percent No object No In #/$defs/percent Color thresholds for percentage output
- key No string No In #/$defs/key Module key
Use a single space (` `) to hide the key
- keyColor No object No In #/$defs/keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No In #/$defs/keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No In #/$defs/keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No In #/$defs/outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/batteryFormat Output format for the `Battery` module. See Wiki for formatting syntax
1. {manufacturer}: Battery manufacturer
2. {model-name}: Battery model name
3. {technology}: Battery technology
4. {capacity}: Battery capacity (percentage num)
5. {status}: Battery status
6. {temperature}: Battery temperature (formatted)
7. {cycle-count}: Battery cycle count
8. {serial}: Battery serial number
9. {manufacture-date}: Battery manufacture date
10. {capacity-bar}: Battery capacity (percentage bar)
11. {time-days}: Battery time remaining days
12. {time-hours}: Battery time remaining hours
13. {time-minutes}: Battery time remaining minutes
14. {time-seconds}: Battery time remaining seconds
15. {time-formatted}: Battery time remaining (formatted)
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.2.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > type
Type const
Required No

Description: Print battery information

Specific value: "battery"

5.1.2.2.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/temperature

Description: Whether to detect and display temperature, if supported

One of(Option)
item 0
item 1
5.1.2.2.2.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.2.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 1
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- green No integer No - Values in Celsius below this threshold are shown in green
- yellow No integer No - Values in Celsius between the green and yellow thresholds are shown in yellow.
Values above the yellow threshold are shown in red
5.1.2.2.2.2.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 1 > green
Type integer
Required No

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

Restrictions
Minimum ≥ 0
Maximum ≤ 100
5.1.2.2.2.2.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 1 > yellow
Type integer
Required No

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

Restrictions
Minimum ≥ 0
Maximum ≤ 100
5.1.2.2.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent
Type object
Required No
Additional properties Not allowed
Defined in #/$defs/percent

Description: Color thresholds for percentage output

Property Pattern Type Deprecated Definition Title/Description
- green No integer No - Values below this threshold are shown in green
- yellow No integer No - Values between the green and yellow thresholds are shown in yellow.
Values above the yellow threshold are shown in red
- type No object No Same as type Percentage output style
5.1.2.2.3.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent > green
Type integer
Required No

Description: Values below this threshold are shown in green

Restrictions
Minimum ≥ 0
Maximum ≤ 100
5.1.2.2.3.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent > yellow
Type integer
Required No

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

Restrictions
Minimum ≥ 0
Maximum ≤ 100
5.1.2.2.3.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent > type
Type combining
Required No
Additional properties Any type allowed
Same definition as type

Description: Percentage output style

5.1.2.2.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > key
Type string
Required No
Defined in #/$defs/key

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

Restrictions
Min length 1
5.1.2.2.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > keyColor
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/keyColor

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

5.1.2.2.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > keyIcon
Type string
Required No
Defined in #/$defs/keyIcon

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

5.1.2.2.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > keyWidth
Type integer
Required No
Defined in #/$defs/keyWidth

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

Restrictions
Minimum ≥ 1
5.1.2.2.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > outputColor
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/outputColor

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

5.1.2.2.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > format
Type string
Required No
Defined in #/$defs/batteryFormat

Description: Output format for the Battery module. See Wiki for formatting syntax 1. {manufacturer}: Battery manufacturer 2. {model-name}: Battery model name 3. {technology}: Battery technology 4. {capacity}: Battery capacity (percentage num) 5. {status}: Battery status 6. {temperature}: Battery temperature (formatted) 7. {cycle-count}: Battery cycle count 8. {serial}: Battery serial number 9. {manufacture-date}: Battery manufacture date 10. {capacity-bar}: Battery capacity (percentage bar) 11. {time-days}: Battery time remaining days 12. {time-hours}: Battery time remaining hours 13. {time-minutes}: Battery time remaining minutes 14. {time-seconds}: Battery time remaining seconds 15. {time-formatted}: Battery time remaining (formatted)

5.1.2.2.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

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

Title: BIOS

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print first-stage bootloader information (name, version, release date, etc.)
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/biosFormat Output format for the `BIOS` module. See Wiki for formatting syntax
1. {date}: BIOS date
2. {release}: BIOS release
3. {vendor}: BIOS vendor
4. {version}: BIOS version
5. {type}: Firmware type
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.3.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > type
Type const
Required No

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

Specific value: "bios"

5.1.2.3.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > key
Type string
Required No
Same definition as key

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

5.1.2.3.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.3.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.3.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.3.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.3.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > format
Type string
Required No
Defined in #/$defs/biosFormat

Description: Output format for the BIOS module. See Wiki for formatting syntax 1. {date}: BIOS date 2. {release}: BIOS release 3. {vendor}: BIOS vendor 4. {version}: BIOS version 5. {type}: Firmware type

5.1.2.3.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BIOS > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

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

Title: Bluetooth

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - List connected Bluetooth devices
- showDisconnected No boolean No - Whether to show disconnected Bluetooth devices
- percent No object No Same as percent Color thresholds for percentage output
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/bluetoothFormat Output format for the `Bluetooth` module. See Wiki for formatting syntax
1. {name}: Name
2. {address}: Address
3. {type}: Type
4. {battery-percentage}: Battery percentage number
5. {connected}: Is connected
6. {battery-percentage-bar}: Battery percentage bar
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.4.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > type
Type const
Required No

Description: List connected Bluetooth devices

Specific value: "bluetooth"

5.1.2.4.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > showDisconnected
Type boolean
Required No
Default false

Description: Whether to show disconnected Bluetooth devices

5.1.2.4.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > percent
Type object
Required No
Additional properties Not allowed
Same definition as percent

Description: Color thresholds for percentage output

5.1.2.4.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > key
Type string
Required No
Same definition as key

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

5.1.2.4.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.4.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.4.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.4.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.4.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > format
Type string
Required No
Defined in #/$defs/bluetoothFormat

Description: Output format for the Bluetooth module. See Wiki for formatting syntax 1. {name}: Name 2. {address}: Address 3. {type}: Type 4. {battery-percentage}: Battery percentage number 5. {connected}: Is connected 6. {battery-percentage-bar}: Battery percentage bar

5.1.2.4.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

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

Title: Bluetooth Radio

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - List Bluetooth radios (supported versions, vendors, etc.)
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/bluetoothradioFormat Output format for the `BluetoothRadio` module. See Wiki for formatting syntax
1. {name}: Radio name for discovering
2. {address}: Address
3. {lmp-version}: LMP version
4. {lmp-subversion}: LMP subversion
5. {version}: Bluetooth version
6. {vendor}: Vendor
7. {discoverable}: Discoverable
8. {connectable}: Connectable / Pairable
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.5.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > type
Type const
Required No

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

Specific value: "bluetoothradio"

5.1.2.5.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > key
Type string
Required No
Same definition as key

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

5.1.2.5.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.5.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.5.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.5.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.5.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > format
Type string
Required No
Defined in #/$defs/bluetoothradioFormat

Description: Output format for the BluetoothRadio module. See Wiki for formatting syntax 1. {name}: Radio name for discovering 2. {address}: Address 3. {lmp-version}: LMP version 4. {lmp-subversion}: LMP subversion 5. {version}: Bluetooth version 6. {vendor}: Vendor 7. {discoverable}: Discoverable 8. {connectable}: Connectable / Pairable

5.1.2.5.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Bluetooth Radio > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

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

Title: Board

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

Description: Print motherboard name and other information

Specific value: "board"

5.1.2.6.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > key
Type string
Required No
Same definition as key

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

5.1.2.6.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.6.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.6.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.6.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.6.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > format
Type string
Required No
Defined in #/$defs/boardFormat

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

5.1.2.6.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Board > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

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

Title: Boot Manager

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print second-stage bootloader information (name, firmware, etc.)
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/bootmgrFormat Output format for the `Bootmgr` module. See Wiki for formatting syntax
1. {name}: Name / description
2. {firmware-path}: Firmware file path
3. {firmware-name}: Firmware file name
4. {secure-boot}: Is secure boot enabled
5. {order}: Boot order
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.7.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > type
Type const
Required No

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

Specific value: "bootmgr"

5.1.2.7.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > key
Type string
Required No
Same definition as key

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

5.1.2.7.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.7.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.7.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.7.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.7.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > format
Type string
Required No
Defined in #/$defs/bootmgrFormat

Description: Output format for the Bootmgr module. See Wiki for formatting syntax 1. {name}: Name / description 2. {firmware-path}: Firmware file path 3. {firmware-name}: Firmware file name 4. {secure-boot}: Is secure boot enabled 5. {order}: Boot order

5.1.2.7.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Boot Manager > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

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

Title: Brightness

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the current brightness level of your monitors
- percent No object No Same as percent Color thresholds for percentage output
- ddcciSleep No Combination No - Sleep time in milliseconds between DDC/CI requests
Set to null to skip DDC/CI detection
See https://www.ddcutil.com/performance_options/#option-sleep-multiplier for details
- compact No boolean No - Whether to print multiple results on a single line
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/brightnessFormat Output format for the `Brightness` module. See Wiki for formatting syntax
1. {percentage}: Screen brightness (percentage num)
2. {name}: Screen name
3. {max}: Maximum brightness value
4. {min}: Minimum brightness value
5. {current}: Current brightness value
6. {percentage-bar}: Screen brightness (percentage bar)
7. {is-builtin}: Is built-in screen
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.8.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > type
Type const
Required No

Description: Print the current brightness level of your monitors

Specific value: "brightness"

5.1.2.8.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > percent
Type object
Required No
Additional properties Not allowed
Same definition as percent

Description: Color thresholds for percentage output

5.1.2.8.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > ddcciSleep
Type combining
Required No
Additional properties Any type allowed
Default 10

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

One of(Option)
item 0
item 1
5.1.2.8.3.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > ddcciSleep > oneOf > item 0
Type null
Required No

Description: Skip DDC/CI detection

5.1.2.8.3.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > ddcciSleep > oneOf > item 1
Type integer
Required No
Restrictions
Minimum ≥ 0
Maximum ≤ 400
5.1.2.8.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > compact
Type boolean
Required No
Default false

Description: Whether to print multiple results on a single line

5.1.2.8.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > key
Type string
Required No
Same definition as key

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

5.1.2.8.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.8.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.8.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.8.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.8.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > format
Type string
Required No
Defined in #/$defs/brightnessFormat

Description: Output format for the Brightness module. See Wiki for formatting syntax 1. {percentage}: Screen brightness (percentage num) 2. {name}: Screen name 3. {max}: Maximum brightness value 4. {min}: Minimum brightness value 5. {current}: Current brightness value 6. {percentage-bar}: Screen brightness (percentage bar) 7. {is-builtin}: Is built-in screen

5.1.2.8.11. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

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

Title: BTRFS

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print Linux BTRFS volumes
- percent No object No Same as percent Color thresholds for percentage output
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/btrfsFormat Output format for the `Btrfs` module. See Wiki for formatting syntax
1. {name}: Name / Label
2. {uuid}: UUID
3. {devices}: Associated devices
4. {features}: Enabled features
5. {used}: Size used
6. {allocated}: Size allocated
7. {total}: Size total
8. {used-percentage}: Used percentage num
9. {allocated-percentage}: Allocated percentage num
10. {used-percentage-bar}: Used percentage bar
11. {allocated-percentage-bar}: Allocated percentage bar
12. {node-size}: Node size
13. {sector-size}: Sector size
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.9.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > type
Type const
Required No

Description: Print Linux BTRFS volumes

Specific value: "btrfs"

5.1.2.9.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > percent
Type object
Required No
Additional properties Not allowed
Same definition as percent

Description: Color thresholds for percentage output

5.1.2.9.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > key
Type string
Required No
Same definition as key

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

5.1.2.9.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.9.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.9.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.9.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.9.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > format
Type string
Required No
Defined in #/$defs/btrfsFormat

Description: Output format for the Btrfs module. See Wiki for formatting syntax 1. {name}: Name / Label 2. {uuid}: UUID 3. {devices}: Associated devices 4. {features}: Enabled features 5. {used}: Size used 6. {allocated}: Size allocated 7. {total}: Size total 8. {used-percentage}: Used percentage num 9. {allocated-percentage}: Allocated percentage num 10. {used-percentage-bar}: Used percentage bar 11. {allocated-percentage-bar}: Allocated percentage bar 12. {node-size}: Node size 13. {sector-size}: Sector size

5.1.2.9.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > BTRFS > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

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

Title: Camera

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print available cameras
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/cameraFormat Output format for the `Camera` module. See Wiki for formatting syntax
1. {name}: Device name
2. {vendor}: Vendor
3. {colorspace}: Color space
4. {id}: Identifier
5. {width}: Width (in px)
6. {height}: Height (in px)
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.10.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > type
Type const
Required No

Description: Print available cameras

Specific value: "camera"

5.1.2.10.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > key
Type string
Required No
Same definition as key

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

5.1.2.10.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.10.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.10.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.10.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.10.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > format
Type string
Required No
Defined in #/$defs/cameraFormat

Description: Output format for the Camera module. See Wiki for formatting syntax 1. {name}: Device name 2. {vendor}: Vendor 3. {colorspace}: Color space 4. {id}: Identifier 5. {width}: Width (in px) 6. {height}: Height (in px)

5.1.2.10.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Camera > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

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

Title: Chassis

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

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

Specific value: "chassis"

5.1.2.11.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > key
Type string
Required No
Same definition as key

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

5.1.2.11.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.11.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.11.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.11.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.11.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > format
Type string
Required No
Defined in #/$defs/chassisFormat

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

5.1.2.11.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Chassis > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

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

Title: Codec

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print hardware video acceleration codec types (decode / encode)
- splitGPU No boolean No - Whether to print each GPU separately. If false, merge codecs from all GPUs
- useVulkan No boolean No - Whether to use Vulkan for codec detection instead of other platform-specific APIs
- showType No Combination No - Which types of codecs to detect and show
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/codecFormat Output format for the `Codec` module. See Wiki for formatting syntax
1. {gpu}: GPU name
2. {direction}: Decoder / Encoder
3. {types}: Compatibility alias of codec types
4. {platform-api}: Platform API used for detection
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.12.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Codec > type
Type const
Required No

Description: Print hardware video acceleration codec types (decode / encode)

Specific value: "codec"

5.1.2.12.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Codec > splitGPU
Type boolean
Required No
Default false

Description: Whether to print each GPU separately. If false, merge codecs from all GPUs

5.1.2.12.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Codec > useVulkan
Type boolean
Required No
Default false

Description: Whether to use Vulkan for codec detection instead of other platform-specific APIs

5.1.2.12.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Codec > showType
Type combining
Required No
Default "both"

Description: Which types of codecs to detect and show

One of(Option)
item 0
item 1
item 2
5.1.2.12.4.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Codec > showType > oneOf > item 0
Type const
Required No

Description: Show both decoders and encoders

Specific value: "both"

5.1.2.12.4.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Codec > showType > oneOf > item 1
Type const
Required No

Description: Show only decoders

Specific value: "decoder"

5.1.2.12.4.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Codec > showType > oneOf > item 2
Type const
Required No

Description: Show only encoders

Specific value: "encoder"

5.1.2.12.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Codec > key
Type string
Required No
Same definition as key

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

5.1.2.12.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Codec > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.12.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Codec > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.12.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Codec > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.12.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Codec > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.12.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Codec > format
Type string
Required No
Defined in #/$defs/codecFormat

Description: Output format for the Codec module. See Wiki for formatting syntax 1. {gpu}: GPU name 2. {direction}: Decoder / Encoder 3. {types}: Compatibility alias of codec types 4. {platform-api}: Platform API used for detection

5.1.2.12.11. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Codec > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

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

Title: CPU

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print CPU name, frequency, etc.
- temp No object No Same as temp Whether to detect and display temperature, if supported
- tempSensor No string No - Set the temperature sensor to use for CPU temperature detection
* Linux: `hwmon` or `thermal` path name (eg. `hwmon0`, `thermal_zone0)`
* macOS: SMC sensor key (eg. `Tp01`)
* Windows: thermal zone key (eg. `_TZ.CPUZ`)
* FreeBSD: sysctl key (eg. `dev.cpu.0.temperature`)
* NetBSD: sysmon sensor key (eg. `coretemp0`)
- showPeCoreCount No boolean No - Whether to detect and display CPU frequencies for different core types (for example, P-cores and E-cores), if supported
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/cpuFormat Output format for the `CPU` module. See Wiki for formatting syntax
1. {name}: Name
2. {vendor}: Vendor
3. {cores-physical}: Physical core count
4. {cores-logical}: Logical core count
5. {cores-online}: Online core count
6. {freq-base}: Base frequency (formatted)
7. {freq-max}: Max frequency (formatted)
8. {temperature}: Temperature (formatted)
9. {core-types}: Logical core count grouped by frequency
10. {packages}: Processor package count
11. {march}: CPU microarchitecture
12. {numa-nodes}: NUMA node count
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.13.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.13.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > temp
Type combining
Required No
Additional properties Any type allowed
Same definition as temp

Description: Whether to detect and display temperature, if supported

5.1.2.13.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > tempSensor
Type string
Required No

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

  • Linux: hwmon or thermal path name (eg. hwmon0, thermal_zone0)
  • macOS: SMC sensor key (eg. Tp01)
  • Windows: thermal zone key (eg. \_TZ.CPUZ)
  • FreeBSD: sysctl key (eg. dev.cpu.0.temperature)
  • NetBSD: sysmon sensor key (eg. coretemp0)
5.1.2.13.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > showPeCoreCount
Type boolean
Required No
Default false

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

5.1.2.13.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > key
Type string
Required No
Same definition as key

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

5.1.2.13.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.13.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.13.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.13.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.13.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > format
Type string
Required No
Defined in #/$defs/cpuFormat

Description: Output format for the CPU module. See Wiki for formatting syntax 1. {name}: Name 2. {vendor}: Vendor 3. {cores-physical}: Physical core count 4. {cores-logical}: Logical core count 5. {cores-online}: Online core count 6. {freq-base}: Base frequency (formatted) 7. {freq-max}: Max frequency (formatted) 8. {temperature}: Temperature (formatted) 9. {core-types}: Logical core count grouped by frequency 10. {packages}: Processor package count 11. {march}: CPU microarchitecture 12. {numa-nodes}: NUMA node count

5.1.2.13.11. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

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

Title: CPU Cache

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print CPU cache sizes
- percent No object No Same as percent Color thresholds for percentage output
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/cpucacheFormat Output format for the `CPUCache` module. See Wiki for formatting syntax
1. {result}: Separate result
2. {sum}: Sum result
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.14.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.14.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > percent
Type object
Required No
Additional properties Not allowed
Same definition as percent

Description: Color thresholds for percentage output

5.1.2.14.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > key
Type string
Required No
Same definition as key

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

5.1.2.14.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.14.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.14.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.14.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.14.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > format
Type string
Required No
Defined in #/$defs/cpucacheFormat

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

5.1.2.14.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

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

Title: CPU Usage

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print CPU usage. Collecting data takes some time
- percent No object No Same as percent Color thresholds for percentage output
- separate No boolean No - Show CPU usage for each logical core instead of an average
- waitTime No integer No - Wait time (in ms). CPU usage = (inUseEnd - inUseStart) / waitTime
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/cpuusageFormat Output format for the `CPUUsage` module. See Wiki for formatting syntax
1. {avg}: CPU usage (percentage num, average)
2. {max}: CPU usage (percentage num, maximum)
3. {max-index}: CPU core index of maximum usage
4. {min}: CPU usage (percentage num, minimum)
5. {min-index}: CPU core index of minimum usage
6. {avg-bar}: CPU usage (percentage bar, average)
7. {max-bar}: CPU usage (percentage bar, maximum)
8. {min-bar}: CPU usage (percentage bar, minimum)
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.15.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > type
Type const
Required No

Description: Print CPU usage. Collecting data takes some time

Specific value: "cpuusage"

5.1.2.15.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > percent
Type object
Required No
Additional properties Not allowed
Same definition as percent

Description: Color thresholds for percentage output

5.1.2.15.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > separate
Type boolean
Required No
Default false

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

5.1.2.15.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.15.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > key
Type string
Required No
Same definition as key

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

5.1.2.15.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.15.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.15.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.15.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.15.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > format
Type string
Required No
Defined in #/$defs/cpuusageFormat

Description: Output format for the CPUUsage module. See Wiki for formatting syntax 1. {avg}: CPU usage (percentage num, average) 2. {max}: CPU usage (percentage num, maximum) 3. {max-index}: CPU core index of maximum usage 4. {min}: CPU usage (percentage num, minimum) 5. {min-index}: CPU core index of minimum usage 6. {avg-bar}: CPU usage (percentage bar, average) 7. {max-bar}: CPU usage (percentage bar, maximum) 8. {min-bar}: CPU usage (percentage bar, minimum)

5.1.2.15.11. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

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

Title: Colors

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

Description: Display the terminal's 16-color palette

Specific value: "colors"

5.1.2.16.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol
Type combining
Required No
Default "background"

Description: Set the symbol to use

One of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
item 6
5.1.2.16.2.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 0
Type const
Required No

Description: ███

Specific value: "block"

5.1.2.16.2.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 1
Type const
Required No

Description: Whitespace with background color

Specific value: "background"

5.1.2.16.2.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 2
Type const
Required No

Description:

Specific value: "circle"

5.1.2.16.2.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 3
Type const
Required No

Description:

Specific value: "diamond"

5.1.2.16.2.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 4
Type const
Required No

Description:

Specific value: "triangle"

5.1.2.16.2.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 5
Type const
Required No

Description:

Specific value: "square"

5.1.2.16.2.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > symbol > oneOf > item 6
Type const
Required No

Description:

Specific value: "star"

5.1.2.16.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.16.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block
Type object
Required No
Additional properties Not allowed

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

Property Pattern Type Deprecated Definition Title/Description
- width No integer No - Set the block width in spaces
- range No array of integer No - Set the range of colors in the blocks to print
5.1.2.16.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.16.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.16.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.16.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > brightness
Type combining
Required No
Default "default"

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

One of(Option)
item 0
item 1
item 2
5.1.2.16.5.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > brightness > oneOf > item 0
Type const
Required No

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

Specific value: "default"

5.1.2.16.5.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > brightness > oneOf > item 1
Type const
Required No

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

Specific value: "light"

5.1.2.16.5.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > brightness > oneOf > item 2
Type const
Required No

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

Specific value: "normal"

5.1.2.16.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > key
Type string
Required No
Same definition as key

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

5.1.2.16.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.16.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.16.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.16.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

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

Title: Command

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

Description: Run a custom shell command

Specific value: "command"

5.1.2.17.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > shell
Type string
Required No

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

5.1.2.17.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > param
Type string
Required No

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

5.1.2.17.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > text
Type string
Required No

Description: Command text to execute

5.1.2.17.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > useStdErr
Type boolean
Required No
Default false

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

5.1.2.17.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > parallel
Type boolean
Required No
Default true

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

5.1.2.17.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > splitLines
Type boolean
Required No
Default false

Description: Whether to split command output into multiple lines

5.1.2.17.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > key
Type string
Required No
Same definition as key

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

5.1.2.17.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.17.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.17.11. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.17.12. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.17.13. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > format
Type string
Required No
Defined in #/$defs/commandFormat

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

5.1.2.17.14. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.18. 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 Color thresholds for percentage output
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/cursorFormat Output format for the `Cursor` module. See Wiki for formatting syntax
1. {theme}: Cursor theme
2. {size}: Cursor size
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.18.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.18.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: Color thresholds for percentage output

5.1.2.18.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > key
Type string
Required No
Same definition as key

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

5.1.2.18.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.18.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.18.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.18.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.18.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > format
Type string
Required No
Defined in #/$defs/cursorFormat

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

5.1.2.18.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.19. 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 to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No - Text to print
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.19.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.19.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > key
Type string
Required No

Description: Leave empty to hide the key

5.1.2.19.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.19.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.19.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.19.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.19.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.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.20. 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 the current date and time
- percent No object No Same as percent Color thresholds for percentage output
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/datetimeFormat Output format for the `DateTime` module. See Wiki 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
24. {am-pm}: AM or PM
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.20.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > type
Type const
Required No

Description: Print the current date and time

Specific value: "datetime"

5.1.2.20.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: Color thresholds for percentage output

5.1.2.20.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > key
Type string
Required No
Same definition as key

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

5.1.2.20.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.20.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.20.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.20.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.20.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 for the DateTime module. See Wiki 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 24. {am-pm}: AM or PM

5.1.2.20.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.21. 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 display resolutions, refresh rates, etc.
- compactType No Combination No - Whether to print all displays on a single line
- preciseRefreshRate No boolean No - Whether to preserve decimal refresh rates instead of rounding them to integers
- order No Combination No - Order to use when printing displays
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/displayFormat Output format for the `Display` module. See Wiki 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 (Built-in or External)
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)
25. {dpi}: DPI
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.21.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > type
Type const
Required No

Description: Print display resolutions, refresh rates, etc.

Specific value: "display"

5.1.2.21.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > compactType
Type combining
Required No
Additional properties Any type allowed
Default null

Description: Whether to print all displays on a single line

One of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
5.1.2.21.2.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > compactType > oneOf > item 0
Type const
Required No

Description: Disable compact mode

Specific value: null

5.1.2.21.2.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > compactType > oneOf > item 1
Type const
Required No

Description: Disable compact mode (kept for compatibility)

Specific value: "none"

5.1.2.21.2.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > compactType > oneOf > item 2
Type const
Required No

Description: Print original resolutions

Specific value: "original"

5.1.2.21.2.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > compactType > oneOf > item 3
Type const
Required No

Description: Print scaled resolutions

Specific value: "scaled"

5.1.2.21.2.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > compactType > oneOf > item 4
Type const
Required No

Description: Print original resolutions with refresh rates

Specific value: "original-with-refresh-rate"

5.1.2.21.2.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > compactType > oneOf > item 5
Type const
Required No

Description: Print scaled resolutions with refresh rates

Specific value: "scaled-with-refresh-rate"

5.1.2.21.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > preciseRefreshRate
Type boolean
Required No
Default false

Description: Whether to preserve decimal refresh rates instead of rounding them to integers

5.1.2.21.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > order
Type combining
Required No
Additional properties Any type allowed
Default null

Description: Order to use when printing displays

One of(Option)
item 0
item 1
item 2
item 3
5.1.2.21.4.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > order > oneOf > item 0
Type const
Required No

Description: Use the default order

Specific value: null

5.1.2.21.4.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > order > oneOf > item 1
Type const
Required No

Description: Use the detected order (kept for compatibility)

Specific value: "none"

5.1.2.21.4.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > order > oneOf > item 2
Type const
Required No

Description: Sort by display name in ascending order

Specific value: "asc"

5.1.2.21.4.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > order > oneOf > item 3
Type const
Required No

Description: Sort by display name in descending order

Specific value: "desc"

5.1.2.21.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > key
Type string
Required No
Same definition as key

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

5.1.2.21.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.21.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.21.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.21.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.21.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > format
Type string
Required No
Defined in #/$defs/displayFormat

Description: Output format for the Display module. See Wiki 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 (Built-in or External) 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) 25. {dpi}: DPI

5.1.2.21.11. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.22. 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, file system, etc.
- folders No Combination No - A list of folder paths for the disk output
Default: auto detection using mount-points
This option overrides other `show*` options
- hideFolders No Combination No - A list of folder paths (or glob patterns) to hide from the disk output
- hideFS No Combination No - A list of file systems to hide from the disk output
- showRegular No boolean No - Whether to show regular volumes
- showExternal No boolean No - Whether to show external volumes
- showHidden No boolean No - Whether to show hidden volumes
- showSubvolumes No boolean No - Whether to show subvolumes
- showReadOnly No boolean No - Whether to show read-only volumes
- showUnknown No boolean No - Whether to show unknown volumes whose sizes cannot be detected
- useAvailable No boolean No - Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes
May be required for macOS to display correct results
- percent No object No Same as percent Color thresholds for percentage output
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/diskFormat Output format for the `Disk` module. See Wiki 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. {days}: Days after creation
16. {hours}: Hours after creation
17. {minutes}: Minutes after creation
18. {seconds}: Seconds after creation
19. {milliseconds}: Milliseconds after creation
20. {mountpoint}: Mount point / drive letter
21. {mount-from}: Mount from (device path)
22. {years}: Years integer after creation
23. {days-of-year}: Days of year after creation
24. {years-fraction}: Years fraction after creation
25. {size-free}: Size free
26. {size-available}: Size available
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.22.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > type
Type const
Required No

Description: Print partitions, space usage, file system, etc.

Specific value: "disk"

5.1.2.22.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > folders
Type combining
Required No
Additional properties Any type allowed

Description: A list of folder paths for the disk output Default: auto detection using mount-points This option overrides other show* options

One of(Option)
item 0
item 1
5.1.2.22.2.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > folders > oneOf > item 0
Type string
Required No
Default "/"

Description: A colon (semicolon on Windows) separated list of folder paths to get disk usage from

5.1.2.22.2.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > folders > oneOf > item 1
Type array of string
Required No

Description: An array of folder paths to get disk usage from

Array restrictions
Min items 1
Max items N/A
Items unicity True
Additional items False
Tuple validation See below
Each item of this array must be Description
item 1 items -
5.1.2.22.2.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > folders > oneOf > item 1 > item 1 items
Type string
Required No
5.1.2.22.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > hideFolders
Type combining
Required No
Additional properties Any type allowed
Default "/efi:/boot:/boot/*"

Description: A list of folder paths (or glob patterns) to hide from the disk output

One of(Option)
item 0
item 1
5.1.2.22.3.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > hideFolders > oneOf > item 0
Type string
Required No

Description: A colon (semicolon on Windows) separated list of folder paths to hide from the disk output

5.1.2.22.3.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > hideFolders > oneOf > item 1
Type array of string
Required No

Description: An array of folder paths to hide from the disk output

Array restrictions
Min items 1
Max items N/A
Items unicity True
Additional items False
Tuple validation See below
Each item of this array must be Description
item 1 items -
5.1.2.22.3.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > hideFolders > oneOf > item 1 > item 1 items
Type string
Required No
5.1.2.22.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > hideFS
Type combining
Required No
Additional properties Any type allowed

Description: A list of file systems to hide from the disk output

One of(Option)
item 0
item 1
5.1.2.22.4.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > hideFS > oneOf > item 0
Type string
Required No

Description: A colon separated list of file systems to hide from the disk output

5.1.2.22.4.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > hideFS > oneOf > item 1
Type array of string
Required No

Description: An array of file systems to hide from the disk output

Array restrictions
Min items 1
Max items N/A
Items unicity True
Additional items False
Tuple validation See below
Each item of this array must be Description
item 1 items -
5.1.2.22.4.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > hideFS > oneOf > item 1 > item 1 items
Type string
Required No
5.1.2.22.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showRegular
Type boolean
Required No
Default true

Description: Whether to show regular volumes

5.1.2.22.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showExternal
Type boolean
Required No
Default true

Description: Whether to show external volumes

5.1.2.22.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showHidden
Type boolean
Required No
Default false

Description: Whether to show hidden volumes

5.1.2.22.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showSubvolumes
Type boolean
Required No
Default false

Description: Whether to show subvolumes

5.1.2.22.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showReadOnly
Type boolean
Required No
Default false

Description: Whether to show read-only volumes

5.1.2.22.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showUnknown
Type boolean
Required No
Default false

Description: Whether to show unknown volumes whose sizes cannot be detected

5.1.2.22.11. 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 May be required for macOS to display correct results

5.1.2.22.12. 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: Color thresholds for percentage output

5.1.2.22.13. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > key
Type string
Required No
Same definition as key

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

5.1.2.22.14. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.22.15. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.22.16. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.22.17. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.22.18. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > format
Type string
Required No
Defined in #/$defs/diskFormat

Description: Output format for the Disk module. See Wiki 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. {days}: Days after creation 16. {hours}: Hours after creation 17. {minutes}: Minutes after creation 18. {seconds}: Seconds after creation 19. {milliseconds}: Milliseconds after creation 20. {mountpoint}: Mount point / drive letter 21. {mount-from}: Mount from (device path) 22. {years}: Years integer after creation 23. {days-of-year}: Days of year after creation 24. {years-fraction}: Years fraction after creation 25. {size-free}: Size free 26. {size-available}: Size available

5.1.2.22.19. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.23. 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 only disks whose names start with this prefix
- detectTotal No boolean No - Show total bytes instead of the current rate
- waitTime No integer No - Wait time (in ms). Disk I/O = (totalBytesEnd - totalBytesStart) / waitTime
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/diskioFormat Output format for the `DiskIO` module. See Wiki 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
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.23.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.23.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > namePrefix
Type string
Required No

Description: Show only disks whose names start with this prefix

5.1.2.23.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > detectTotal
Type boolean
Required No
Default false

Description: Show total bytes instead of the current rate

5.1.2.23.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.23.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > key
Type string
Required No
Same definition as key

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

5.1.2.23.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.23.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.23.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.23.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.23.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > format
Type string
Required No
Defined in #/$defs/diskioFormat

Description: Output format for the DiskIO module. See Wiki 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.11. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.24. 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
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/deFormat Output format for the `DE` module. See Wiki for formatting syntax
1. {process-name}: DE process name
2. {pretty-name}: DE pretty name
3. {version}: DE version
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.24.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.24.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > key
Type string
Required No
Same definition as key

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

5.1.2.24.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.24.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.24.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.24.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.24.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > format
Type string
Required No
Defined in #/$defs/deFormat

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

5.1.2.24.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.25. 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 configured DNS servers
- showType No Combination No - Which DNS server types to show
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/dnsFormat Output format for the `DNS` module. See Wiki for formatting syntax
1. {result}: DNS result
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.25.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > type
Type const
Required No

Description: Print configured DNS servers

Specific value: "dns"

5.1.2.25.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > showType
Type combining
Required No
Additional properties Any type allowed
Default "both"

Description: Which DNS server types to show

One of(Option)
item 0
item 1
item 2
5.1.2.25.2.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > showType > oneOf > item 0
Type const
Required No

Description: Show IPv4 addresses only

Specific value: "ipv4"

5.1.2.25.2.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > showType > oneOf > item 1
Type const
Required No

Description: Show IPv6 addresses only

Specific value: "ipv6"

5.1.2.25.2.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > showType > oneOf > item 2
Type const
Required No

Description: Show both IPv4 and IPv6 addresses

Specific value: "both"

5.1.2.25.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > key
Type string
Required No
Same definition as key

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

5.1.2.25.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.25.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.25.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.25.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.25.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > format
Type string
Required No
Defined in #/$defs/dnsFormat

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

5.1.2.25.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DNS > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.26. 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 about the default editor (`$VISUAL` or `$EDITOR`)
- percent No object No Same as percent Color thresholds for percentage output
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/editorFormat Output format for the `Editor` module. See Wiki for formatting syntax
1. {type}: Type (Visual / Editor)
2. {name}: Name
3. {exe-name}: Exe name of real path
4. {path}: Full path of real path
5. {version}: Version
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.26.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor > type
Type const
Required No

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

Specific value: "editor"

5.1.2.26.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: Color thresholds for percentage output

5.1.2.26.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor > key
Type string
Required No
Same definition as key

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

5.1.2.26.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.26.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.26.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.26.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.26.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor > format
Type string
Required No
Defined in #/$defs/editorFormat

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

5.1.2.26.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Editor > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.27. 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 Color thresholds for percentage output
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/fontFormat Output format for the `Font` module. See Wiki 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
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.27.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.27.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: Color thresholds for percentage output

5.1.2.27.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Font > key
Type string
Required No
Same definition as key

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

5.1.2.27.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Font > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.27.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Font > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.27.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Font > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.27.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Font > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.27.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Font > format
Type string
Required No
Defined in #/$defs/fontFormat

Description: Output format for the Font module. See Wiki 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.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Font > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.28. 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
- ignores No array of string No - An array of case-insensitive device name prefixes to ignore
- percent No object No Same as percent Color thresholds for percentage output
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/gamepadFormat Output format for the `Gamepad` module. See Wiki for formatting syntax
1. {name}: Name
2. {serial}: Serial number
3. {battery-percentage}: Battery percentage num
4. {battery-percentage-bar}: Battery percentage bar
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.28.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.28.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > ignores
Type array of string
Required No

Description: An array of case-insensitive device name prefixes to ignore

Array restrictions
Min items 1
Max items N/A
Items unicity True
Additional items False
Tuple validation See below
Each item of this array must be Description
ignores items -
5.1.2.28.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > ignores > ignores items
Type string
Required No
5.1.2.28.3. 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: Color thresholds for percentage output

5.1.2.28.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > key
Type string
Required No
Same definition as key

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

5.1.2.28.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.28.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.28.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.28.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.28.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > format
Type string
Required No
Defined in #/$defs/gamepadFormat

Description: Output format for the Gamepad module. See Wiki 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.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Gamepad > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.29. 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, memory sizes, types, etc.
- temp No object No Same as temp Whether to 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)
Requires the latest GPU drivers to be installed.
- detectionMethod No Combination No - Force a specific GPU detection method
- hideType No Combination No - Hide GPUs of a specific type
- percent No object No Same as percent Color thresholds for percentage output
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/gpuFormat Output format for the `GPU` module. See Wiki for formatting syntax
1. {vendor}: GPU vendor
2. {name}: GPU name
3. {driver}: GPU driver
4. {temperature}: GPU temperature
5. {core-count}: GPU core count
6. {type}: GPU type
7. {dedicated-total}: GPU total dedicated memory
8. {dedicated-used}: GPU used dedicated memory
9. {shared-total}: GPU total shared memory
10. {shared-used}: GPU used shared memory
11. {platform-api}: The platform API used when detecting the GPU
12. {frequency}: Current frequency in GHz
13. {index}: GPU vendor specific index
14. {dedicated-percentage-num}: Dedicated memory usage percentage num
15. {dedicated-percentage-bar}: Dedicated memory usage percentage bar
16. {shared-percentage-num}: Shared memory usage percentage num
17. {shared-percentage-bar}: Shared memory usage percentage bar
18. {core-usage-num}: Core usage percentage num
19. {core-usage-bar}: Core usage percentage bar
20. {memory-type}: Memory type (Windows only)
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.29.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > type
Type const
Required No

Description: Print GPU names, memory sizes, types, etc.

Specific value: "gpu"

5.1.2.29.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > temp
Type combining
Required No
Additional properties Any type allowed
Same definition as temp

Description: Whether to detect and display temperature, if supported

5.1.2.29.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > driverSpecific
Type boolean
Required No
Default false

Description: Use driver specific method to detect more detailed GPU information (memory usage, core count, etc) Requires the latest GPU drivers to be installed.

5.1.2.29.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > detectionMethod
Type combining
Required No
Default "<varies-by-platform>"

Description: Force a specific GPU detection method

One of(Option)
item 0
item 1
item 2
item 3
item 4
5.1.2.29.4.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > detectionMethod > oneOf > item 0
Type const
Required No

Description: Query platform-specific graphics APIs. Requires proper GPU drivers to be installed. Supported on Linux, FreeBSD, Windows and macOS

Specific value: "auto"

5.1.2.29.4.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > detectionMethod > oneOf > item 1
Type const
Required No

Description: Search PCI devices, which does not require GPU drivers to be installed. Not supported on Windows and macOS

Specific value: "pci"

5.1.2.29.4.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > detectionMethod > oneOf > item 2
Type const
Required No

Description: Use Vulkan API. Slow and requires proper Vulkan drivers to be installed. Used for Android

Specific value: "vulkan"

5.1.2.29.4.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > detectionMethod > oneOf > item 3
Type const
Required No

Description: Use OpenCL API. Slow and requires proper OpenCL drivers to be installed

Specific value: "opencl"

5.1.2.29.4.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > detectionMethod > oneOf > item 4
Type const
Required No

Description: Use OpenGL API. Slow and only detects one GPU. Used for OpenBSD

Specific value: "opengl"

5.1.2.29.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > hideType
Type combining
Required No
Additional properties Any type allowed
Default null

Description: Hide GPUs of a specific type

One of(Option)
item 0
item 1
item 2
item 3
item 4
5.1.2.29.5.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > hideType > oneOf > item 0
Type const
Required No

Description: Do not hide any GPUs

Specific value: null

5.1.2.29.5.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > hideType > oneOf > item 1
Type const
Required No

Description: Do not hide any GPUs (kept for compatibility)

Specific value: "none"

5.1.2.29.5.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > hideType > oneOf > item 2
Type const
Required No

Description: Hide integrated GPUs

Specific value: "integrated"

5.1.2.29.5.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > hideType > oneOf > item 3
Type const
Required No

Description: Hide discrete GPUs

Specific value: "discrete"

5.1.2.29.5.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > hideType > oneOf > item 4
Type const
Required No

Description: Hide unknown (unrecognized) GPUs

Specific value: "unknown"

5.1.2.29.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > percent
Type object
Required No
Additional properties Not allowed
Same definition as percent

Description: Color thresholds for percentage output

5.1.2.29.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > key
Type string
Required No
Same definition as key

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

5.1.2.29.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.29.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.29.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.29.11. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.29.12. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > format
Type string
Required No
Defined in #/$defs/gpuFormat

Description: Output format for the GPU module. See Wiki for formatting syntax 1. {vendor}: GPU vendor 2. {name}: GPU name 3. {driver}: GPU driver 4. {temperature}: GPU temperature 5. {core-count}: GPU core count 6. {type}: GPU type 7. {dedicated-total}: GPU total dedicated memory 8. {dedicated-used}: GPU used dedicated memory 9. {shared-total}: GPU total shared memory 10. {shared-used}: GPU used shared memory 11. {platform-api}: The platform API used when detecting the GPU 12. {frequency}: Current frequency in GHz 13. {index}: GPU vendor specific index 14. {dedicated-percentage-num}: Dedicated memory usage percentage num 15. {dedicated-percentage-bar}: Dedicated memory usage percentage bar 16. {shared-percentage-num}: Shared memory usage percentage num 17. {shared-percentage-bar}: Shared memory usage percentage bar 18. {core-usage-num}: Core usage percentage num 19. {core-usage-bar}: Core usage percentage bar 20. {memory-type}: Memory type (Windows only)

5.1.2.29.13. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > GPU > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.30. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Host

Title: Host

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print your computer's product name
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/hostFormat Output format for the `Host` module. See Wiki for formatting syntax
1. {family}: Product family
2. {name}: Product name
3. {version}: Product version
4. {sku}: Product sku
5. {vendor}: Product vendor
6. {serial}: Product serial number
7. {uuid}: Product uuid
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.30.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Host > type
Type const
Required No

Description: Print your computer's product name

Specific value: "host"

5.1.2.30.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Host > key
Type string
Required No
Same definition as key

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

5.1.2.30.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Host > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.30.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Host > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.30.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Host > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.30.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Host > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.30.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Host > format
Type string
Required No
Defined in #/$defs/hostFormat

Description: Output format for the Host module. See Wiki for formatting syntax 1. {family}: Product family 2. {name}: Product name 3. {version}: Product version 4. {sku}: Product sku 5. {vendor}: Product vendor 6. {serial}: Product serial number 7. {uuid}: Product uuid

5.1.2.30.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Host > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.31. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Icons

Title: Icons

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print icon style name
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/iconsFormat Output format for the `Icons` module. See Wiki for formatting syntax
1. {icons1}: Icons part 1
2. {icons2}: Icons part 2
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.31.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Icons > type
Type const
Required No

Description: Print icon style name

Specific value: "icons"

5.1.2.31.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Icons > key
Type string
Required No
Same definition as key

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

5.1.2.31.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Icons > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.31.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Icons > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.31.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Icons > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.31.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Icons > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.31.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Icons > format
Type string
Required No
Defined in #/$defs/iconsFormat

Description: Output format for the Icons module. See Wiki for formatting syntax 1. {icons1}: Icons part 1 2. {icons2}: Icons part 2

5.1.2.31.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Icons > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.32. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Init System

Title: Init System

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print init system (pid 1) name and version
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/initsystemFormat Output format for the `InitSystem` module. See Wiki for formatting syntax
1. {name}: Init system name
2. {exe}: Init system exe path
3. {version}: Init system version path
4. {pid}: Init system pid
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.32.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Init System > type
Type const
Required No

Description: Print init system (pid 1) name and version

Specific value: "initsystem"

5.1.2.32.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Init System > key
Type string
Required No
Same definition as key

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

5.1.2.32.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Init System > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.32.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Init System > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.32.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Init System > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.32.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Init System > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.32.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Init System > format
Type string
Required No
Defined in #/$defs/initsystemFormat

Description: Output format for the InitSystem module. See Wiki for formatting syntax 1. {name}: Init system name 2. {exe}: Init system exe path 3. {version}: Init system version path 4. {pid}: Init system pid

5.1.2.32.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Init System > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.33. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Kernel

Title: Kernel

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print system kernel version
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/kernelFormat Output format for the `Kernel` module. See Wiki for formatting syntax
1. {sysname}: Sysname
2. {release}: Release
3. {version}: Version
4. {arch}: Architecture
5. {display-version}: Display version
6. {page-size}: Page size
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.33.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Kernel > type
Type const
Required No

Description: Print system kernel version

Specific value: "kernel"

5.1.2.33.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Kernel > key
Type string
Required No
Same definition as key

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

5.1.2.33.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Kernel > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.33.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Kernel > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.33.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Kernel > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.33.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Kernel > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.33.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Kernel > format
Type string
Required No
Defined in #/$defs/kernelFormat

Description: Output format for the Kernel module. See Wiki for formatting syntax 1. {sysname}: Sysname 2. {release}: Release 3. {version}: Version 4. {arch}: Architecture 5. {display-version}: Display version 6. {page-size}: Page size

5.1.2.33.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Kernel > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.34. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Keyboard

Title: Keyboard

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - List connected keyboards
- ignores No array of string No - An array of case-insensitive device name prefixes to ignore
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/keyboardFormat Output format for the `Keyboard` module. See Wiki for formatting syntax
1. {name}: Name
2. {serial}: Serial number
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.34.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Keyboard > type
Type const
Required No

Description: List connected keyboards

Specific value: "keyboard"

5.1.2.34.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Keyboard > ignores
Type array of string
Required No

Description: An array of case-insensitive device name prefixes to ignore

Array restrictions
Min items 1
Max items N/A
Items unicity True
Additional items False
Tuple validation See below
Each item of this array must be Description
ignores items -
5.1.2.34.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Keyboard > ignores > ignores items
Type string
Required No
5.1.2.34.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Keyboard > key
Type string
Required No
Same definition as key

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

5.1.2.34.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Keyboard > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.34.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Keyboard > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.34.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Keyboard > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.34.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Keyboard > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.34.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Keyboard > format
Type string
Required No
Defined in #/$defs/keyboardFormat

Description: Output format for the Keyboard module. See Wiki for formatting syntax 1. {name}: Name 2. {serial}: Serial number

5.1.2.34.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Keyboard > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.35. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Login Manager

Title: Login Manager

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print login manager (desktop manager) name and version
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/lmFormat Output format for the `LM` module. See Wiki for formatting syntax
1. {service}: LM service
2. {type}: LM type
3. {version}: LM version
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.35.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Login Manager > type
Type const
Required No

Description: Print login manager (desktop manager) name and version

Specific value: "lm"

5.1.2.35.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Login Manager > key
Type string
Required No
Same definition as key

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

5.1.2.35.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Login Manager > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.35.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Login Manager > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.35.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Login Manager > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.35.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Login Manager > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.35.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Login Manager > format
Type string
Required No
Defined in #/$defs/lmFormat

Description: Output format for the LM module. See Wiki for formatting syntax 1. {service}: LM service 2. {type}: LM type 3. {version}: LM version

5.1.2.35.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Login Manager > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.36. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP

Title: Local IP

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - List local IP addresses (IPv4 or IPv6), MAC addresses, etc.
- showIpv4 No boolean No - Show IPv4 addresses
- showIpv6 No Combination No - Show IPv6 addresses
- showSpeed No boolean No - Show Ethernet RX speed
- showMtu No boolean No - Show MTU
- showMac No boolean No - Show MAC addresses
- showLoop No boolean No - Show loop back addresses (127.0.0.1)
- showPrefixLen No boolean No - Show network prefix length (/N)
- showAllIps No boolean No - Show all IPs bound to the same interface
By default, only the first detected IP is shown
- showFlags No boolean No - Show the interface's flags
- compact No boolean No - Show all IPs in one line
- namePrefix No string No - Show IPs with given name prefix only
- defaultRouteOnly No boolean No - Show only IPs used for the default route
Does not work on Android
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/localipFormat Output format for the `LocalIp` module. See Wiki for formatting syntax
1. {ipv4}: IPv4 address
2. {ipv6}: IPv6 address
3. {mac}: MAC address
4. {ifname}: Interface name
5. {is-default-route}: Is default route
6. {mtu}: MTU size in bytes
7. {speed}: Link speed (formatted)
8. {flags}: Interface flags
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.36.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > type
Type const
Required No

Description: List local IP addresses (IPv4 or IPv6), MAC addresses, etc.

Specific value: "localip"

5.1.2.36.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > showIpv4
Type boolean
Required No
Default true

Description: Show IPv4 addresses

5.1.2.36.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > showIpv6
Type combining
Required No
Additional properties Any type allowed
Default false

Description: Show IPv6 addresses

One of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
5.1.2.36.3.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > showIpv6 > oneOf > item 0
Type const
Required No

Description: Show the most useful IPv6 addresses

Specific value: true

5.1.2.36.3.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > showIpv6 > oneOf > item 1
Type const
Required No

Description: Do not show IPv6 addresses

Specific value: false

5.1.2.36.3.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > showIpv6 > oneOf > item 2
Type const
Required No

Description: Show only global unicast IPv6 addresses (2000::/3)

Specific value: "gua"

5.1.2.36.3.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > showIpv6 > oneOf > item 3
Type const
Required No

Description: Show only unique local IPv6 addresses (fc00::/7)

Specific value: "ula"

5.1.2.36.3.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > showIpv6 > oneOf > item 4
Type const
Required No

Description: Show only link-local IPv6 addresses (fe80::/10)

Specific value: "lla"

5.1.2.36.3.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > showIpv6 > oneOf > item 5
Type const
Required No

Description: Show only IPv6 addresses that are not gua, ula or lla

Specific value: "unknown"

5.1.2.36.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > showSpeed
Type boolean
Required No
Default false

Description: Show Ethernet RX speed

5.1.2.36.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > showMtu
Type boolean
Required No
Default false

Description: Show MTU

5.1.2.36.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > showMac
Type boolean
Required No
Default false

Description: Show MAC addresses

5.1.2.36.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > showLoop
Type boolean
Required No
Default false

Description: Show loop back addresses (127.0.0.1)

5.1.2.36.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > showPrefixLen
Type boolean
Required No
Default true

Description: Show network prefix length (/N)

5.1.2.36.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > showAllIps
Type boolean
Required No
Default false

Description: Show all IPs bound to the same interface By default, only the first detected IP is shown

5.1.2.36.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > showFlags
Type boolean
Required No
Default false

Description: Show the interface's flags

5.1.2.36.11. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > compact
Type boolean
Required No
Default false

Description: Show all IPs in one line

5.1.2.36.12. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > namePrefix
Type string
Required No

Description: Show IPs with given name prefix only

5.1.2.36.13. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > defaultRouteOnly
Type boolean
Required No
Default true

Description: Show only IPs used for the default route Does not work on Android

5.1.2.36.14. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > key
Type string
Required No
Same definition as key

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

5.1.2.36.15. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.36.16. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.36.17. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.36.18. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.36.19. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > format
Type string
Required No
Defined in #/$defs/localipFormat

Description: Output format for the LocalIp module. See Wiki for formatting syntax 1. {ipv4}: IPv4 address 2. {ipv6}: IPv6 address 3. {mac}: MAC address 4. {ifname}: Interface name 5. {is-default-route}: Is default route 6. {mtu}: MTU size in bytes 7. {speed}: Link speed (formatted) 8. {flags}: Interface flags

5.1.2.36.20. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Local IP > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.37. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Loadavg

Title: Loadavg

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print system load averages
- ndigits No integer No - Set the number of digits to keep after the decimal point
- compact No boolean No - Show values in one line
- percent No object No Same as percent Color thresholds for percentage output
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/loadavgFormat Output format for the `Loadavg` module. See Wiki for formatting syntax
1. {loadavg1}: Load average over 1min
2. {loadavg2}: Load average over 5min
3. {loadavg3}: Load average over 15min
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.37.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Loadavg > type
Type const
Required No

Description: Print system load averages

Specific value: "loadavg"

5.1.2.37.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Loadavg > ndigits
Type integer
Required No
Default 2

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

Restrictions
Minimum ≥ 0
Maximum ≤ 9
5.1.2.37.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Loadavg > compact
Type boolean
Required No
Default true

Description: Show values in one line

5.1.2.37.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Loadavg > percent
Type object
Required No
Additional properties Not allowed
Same definition as percent

Description: Color thresholds for percentage output

5.1.2.37.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Loadavg > key
Type string
Required No
Same definition as key

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

5.1.2.37.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Loadavg > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.37.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Loadavg > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.37.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Loadavg > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.37.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Loadavg > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.37.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Loadavg > format
Type string
Required No
Defined in #/$defs/loadavgFormat

Description: Output format for the Loadavg module. See Wiki for formatting syntax 1. {loadavg1}: Load average over 1min 2. {loadavg2}: Load average over 5min 3. {loadavg3}: Load average over 15min

5.1.2.37.11. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Loadavg > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.38. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Locale

Title: Locale

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print system locale name
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/localeFormat Output format for the `Locale` module. See Wiki for formatting syntax
1. {result}: Locale code
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.38.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Locale > type
Type const
Required No

Description: Print system locale name

Specific value: "locale"

5.1.2.38.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Locale > key
Type string
Required No
Same definition as key

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

5.1.2.38.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Locale > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.38.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Locale > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.38.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Locale > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.38.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Locale > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.38.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Locale > format
Type string
Required No
Defined in #/$defs/localeFormat

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

5.1.2.38.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Locale > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

Title: Logo

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Query built-in logo for JSON output
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.39.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Logo > type
Type const
Required No

Description: Query built-in logo for JSON output

Specific value: "logo"

5.1.2.39.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Logo > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.40. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Media

Title: Media

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the name of the currently playing song
- percent No object No Same as percent Color thresholds for percentage output
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/mediaFormat Output format for the `Media` module. See Wiki for formatting syntax
1. {combined}: Pretty media name
2. {title}: Media name
3. {artist}: Artist name
4. {album}: Album name
5. {status}: Status
6. {progress}: Progress in text
7. {progress-num}: Progress in percentage (number)
8. {progress-bar}: Progress in percentage (bar)
9. {player-name}: Player name
10. {player-id}: Player ID
11. {url}: URL
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.40.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Media > type
Type const
Required No

Description: Print the name of the currently playing song

Specific value: "media"

5.1.2.40.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Media > percent
Type object
Required No
Additional properties Not allowed
Same definition as percent

Description: Color thresholds for percentage output

5.1.2.40.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Media > key
Type string
Required No
Same definition as key

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

5.1.2.40.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Media > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.40.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Media > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.40.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Media > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.40.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Media > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.40.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Media > format
Type string
Required No
Defined in #/$defs/mediaFormat

Description: Output format for the Media module. See Wiki for formatting syntax 1. {combined}: Pretty media name 2. {title}: Media name 3. {artist}: Artist name 4. {album}: Album name 5. {status}: Status 6. {progress}: Progress in text 7. {progress-num}: Progress in percentage (number) 8. {progress-bar}: Progress in percentage (bar) 9. {player-name}: Player name 10. {player-id}: Player ID 11. {url}: URL

5.1.2.40.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Media > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.41. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Memory

Title: Memory

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print system memory usage information
- percent No object No Same as percent Color thresholds for percentage output
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/memoryFormat Output format for the `Memory` module. See Wiki for formatting syntax
1. {used}: Used size
2. {total}: Total size
3. {percentage}: Percentage used (num)
4. {percentage-bar}: Percentage used (bar)
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.41.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Memory > type
Type const
Required No

Description: Print system memory usage information

Specific value: "memory"

5.1.2.41.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Memory > percent
Type object
Required No
Additional properties Not allowed
Same definition as percent

Description: Color thresholds for percentage output

5.1.2.41.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Memory > key
Type string
Required No
Same definition as key

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

5.1.2.41.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Memory > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.41.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Memory > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.41.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Memory > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.41.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Memory > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.41.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Memory > format
Type string
Required No
Defined in #/$defs/memoryFormat

Description: Output format for the Memory module. See Wiki for formatting syntax 1. {used}: Used size 2. {total}: Total size 3. {percentage}: Percentage used (num) 4. {percentage-bar}: Percentage used (bar)

5.1.2.41.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Memory > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.42. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Mouse

Title: Mouse

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - List connected mice
- ignores No array of string No - An array of case-insensitive device name prefixes to ignore
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/mouseFormat Output format for the `Mouse` module. See Wiki for formatting syntax
1. {name}: Mouse name
2. {serial}: Mouse serial number
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.42.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Mouse > type
Type const
Required No

Description: List connected mice

Specific value: "mouse"

5.1.2.42.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Mouse > ignores
Type array of string
Required No

Description: An array of case-insensitive device name prefixes to ignore

Array restrictions
Min items 1
Max items N/A
Items unicity True
Additional items False
Tuple validation See below
Each item of this array must be Description
ignores items -
5.1.2.42.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Mouse > ignores > ignores items
Type string
Required No
5.1.2.42.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Mouse > key
Type string
Required No
Same definition as key

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

5.1.2.42.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Mouse > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.42.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Mouse > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.42.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Mouse > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.42.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Mouse > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.42.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Mouse > format
Type string
Required No
Defined in #/$defs/mouseFormat

Description: Output format for the Mouse module. See Wiki for formatting syntax 1. {name}: Mouse name 2. {serial}: Mouse serial number

5.1.2.42.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Mouse > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.43. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Monitor

Title: Monitor

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Same as Display module, but with a different default output format
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/monitorFormat Output format for the `Monitor` module. See Wiki for formatting syntax
1. {name}: Display name
2. {width}: Native resolution width in pixels
3. {height}: Native resolution height in pixels
4. {physical-width}: Physical width in millimeters
5. {physical-height}: Physical height in millimeters
6. {inch}: Physical diagonal length in inches
7. {ppi}: Pixels per inch (PPI)
8. {manufacture-year}: Year of manufacturing
9. {manufacture-week}: Nth week of manufacturing in the year
10. {serial}: Serial number
11. {refresh-rate}: Maximum refresh rate in Hz
12. {hdr-compatible}: True if the display is HDR compatible
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.43.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Monitor > type
Type const
Required No

Description: Same as Display module, but with a different default output format

Specific value: "monitor"

5.1.2.43.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Monitor > key
Type string
Required No
Same definition as key

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

5.1.2.43.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Monitor > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.43.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Monitor > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.43.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Monitor > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.43.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Monitor > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.43.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Monitor > format
Type string
Required No
Defined in #/$defs/monitorFormat

Description: Output format for the Monitor module. See Wiki for formatting syntax 1. {name}: Display name 2. {width}: Native resolution width in pixels 3. {height}: Native resolution height in pixels 4. {physical-width}: Physical width in millimeters 5. {physical-height}: Physical height in millimeters 6. {inch}: Physical diagonal length in inches 7. {ppi}: Pixels per inch (PPI) 8. {manufacture-year}: Year of manufacturing 9. {manufacture-week}: Nth week of manufacturing in the year 10. {serial}: Serial number 11. {refresh-rate}: Maximum refresh rate in Hz 12. {hdr-compatible}: True if the display is HDR compatible

5.1.2.43.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Monitor > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.44. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > NetIO

Title: NetIO

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print network I/O throughput
- namePrefix No string No - Show only interfaces whose names start with this prefix
- defaultRouteOnly No boolean No - Show only interfaces used for the default route
Does not work on Android
- detectTotal No boolean No - Detect total bytes instead of current rate
- waitTime No integer No - Wait time (in ms). Net I/O = (totalBytesEnd - totalBytesStart) / waitTime
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/netioFormat Output format for the `NetIO` module. See Wiki for formatting syntax
1. {rx-size}: Size of data received [per second] (formatted)
2. {tx-size}: Size of data sent [per second] (formatted)
3. {ifname}: Interface name
4. {is-default-route}: Is default route
5. {rx-bytes}: Size of data received [per second] (in bytes)
6. {tx-bytes}: Size of data sent [per second] (in bytes)
7. {rx-packets}: Number of packets received [per second]
8. {tx-packets}: Number of packets sent [per second]
9. {rx-errors}: Number of errors received [per second]
10. {tx-errors}: Number of errors sent [per second]
11. {rx-drops}: Number of packets dropped when receiving [per second]
12. {tx-drops}: Number of packets dropped when sending [per second]
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.44.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > NetIO > type
Type const
Required No

Description: Print network I/O throughput

Specific value: "netio"

5.1.2.44.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > NetIO > namePrefix
Type string
Required No

Description: Show only interfaces whose names start with this prefix

5.1.2.44.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > NetIO > defaultRouteOnly
Type boolean
Required No
Default true

Description: Show only interfaces used for the default route Does not work on Android

5.1.2.44.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > NetIO > detectTotal
Type boolean
Required No
Default false

Description: Detect total bytes instead of current rate

5.1.2.44.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > NetIO > waitTime
Type integer
Required No
Default 200

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

Restrictions
Minimum ≥ 1
5.1.2.44.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > NetIO > key
Type string
Required No
Same definition as key

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

5.1.2.44.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > NetIO > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.44.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > NetIO > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.44.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > NetIO > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.44.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > NetIO > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.44.11. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > NetIO > format
Type string
Required No
Defined in #/$defs/netioFormat

Description: Output format for the NetIO module. See Wiki for formatting syntax 1. {rx-size}: Size of data received [per second] (formatted) 2. {tx-size}: Size of data sent [per second] (formatted) 3. {ifname}: Interface name 4. {is-default-route}: Is default route 5. {rx-bytes}: Size of data received [per second] (in bytes) 6. {tx-bytes}: Size of data sent [per second] (in bytes) 7. {rx-packets}: Number of packets received [per second] 8. {tx-packets}: Number of packets sent [per second] 9. {rx-errors}: Number of errors received [per second] 10. {tx-errors}: Number of errors sent [per second] 11. {rx-drops}: Number of packets dropped when receiving [per second] 12. {tx-drops}: Number of packets dropped when sending [per second]

5.1.2.44.12. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > NetIO > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.45. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenCL

Title: OpenCL

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the highest OpenCL version supported by the GPU
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/openclFormat Output format for the `OpenCL` module. See Wiki for formatting syntax
1. {version}: Platform version
2. {name}: Platform name
3. {vendor}: Platform vendor
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.45.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenCL > type
Type const
Required No

Description: Print the highest OpenCL version supported by the GPU

Specific value: "opencl"

5.1.2.45.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenCL > key
Type string
Required No
Same definition as key

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

5.1.2.45.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenCL > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.45.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenCL > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.45.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenCL > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.45.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenCL > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.45.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenCL > format
Type string
Required No
Defined in #/$defs/openclFormat

Description: Output format for the OpenCL module. See Wiki for formatting syntax 1. {version}: Platform version 2. {name}: Platform name 3. {vendor}: Platform vendor

5.1.2.45.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenCL > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.46. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenGL

Title: OpenGL

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the highest OpenGL version supported by the GPU
- library No Combination No - Set the OpenGL context creation library to use
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/openglFormat Output format for the `OpenGL` module. See Wiki for formatting syntax
1. {version}: OpenGL version
2. {renderer}: OpenGL renderer
3. {vendor}: OpenGL vendor
4. {slv}: OpenGL shading language version
5. {library}: OpenGL library used
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.46.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenGL > type
Type const
Required No

Description: Print the highest OpenGL version supported by the GPU

Specific value: "opengl"

5.1.2.46.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenGL > library
Type combining
Required No
Additional properties Any type allowed
Default "auto"

Description: Set the OpenGL context creation library to use

One of(Option)
item 0
item 1
item 2
5.1.2.46.2.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenGL > library > oneOf > item 0
Type const
Required No

Description: Prefer EGL on *nix; prefer platform-specific implementation on others

Specific value: "auto"

5.1.2.46.2.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenGL > library > oneOf > item 1
Type const
Required No

Description: Use EGL, which works on TTY

Specific value: "egl"

5.1.2.46.2.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenGL > library > oneOf > item 2
Type const
Required No

Description: Use GLX, requires X session (*nix only)

Specific value: "glx"

5.1.2.46.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenGL > key
Type string
Required No
Same definition as key

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

5.1.2.46.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenGL > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.46.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenGL > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.46.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenGL > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.46.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenGL > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.46.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenGL > format
Type string
Required No
Defined in #/$defs/openglFormat

Description: Output format for the OpenGL module. See Wiki for formatting syntax 1. {version}: OpenGL version 2. {renderer}: OpenGL renderer 3. {vendor}: OpenGL vendor 4. {slv}: OpenGL shading language version 5. {library}: OpenGL library used

5.1.2.46.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > OpenGL > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.47. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Operating System

Title: Operating System

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the OS or Linux distribution name and version
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/osFormat Output format for the `OS` module. See Wiki for formatting syntax
1. {sysname}: Name of the kernel
2. {name}: Name of the OS
3. {pretty-name}: Pretty name of the OS, if available
4. {id}: ID of the OS
5. {id-like}: ID like of the OS
6. {variant}: Variant of the OS
7. {variant-id}: Variant ID of the OS
8. {version}: Version of the OS
9. {version-id}: Version ID of the OS
10. {codename}: Version codename of the OS
11. {build-id}: Build ID of the OS
12. {arch}: Architecture of the OS
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.47.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Operating System > type
Type const
Required No

Description: Print the OS or Linux distribution name and version

Specific value: "os"

5.1.2.47.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Operating System > key
Type string
Required No
Same definition as key

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

5.1.2.47.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Operating System > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.47.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Operating System > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.47.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Operating System > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.47.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Operating System > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.47.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Operating System > format
Type string
Required No
Defined in #/$defs/osFormat

Description: Output format for the OS module. See Wiki for formatting syntax 1. {sysname}: Name of the kernel 2. {name}: Name of the OS 3. {pretty-name}: Pretty name of the OS, if available 4. {id}: ID of the OS 5. {id-like}: ID like of the OS 6. {variant}: Variant of the OS 7. {variant-id}: Variant ID of the OS 8. {version}: Version of the OS 9. {version-id}: Version ID of the OS 10. {codename}: Version codename of the OS 11. {build-id}: Build ID of the OS 12. {arch}: Architecture of the OS

5.1.2.47.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Operating System > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.48. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Packages

Title: Packages

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - List installed package managers and count of installed packages
- disabled No Combination No - -
- combined No boolean No - Whether to combine related package managers into single counts (e.g., nix-system + nix-user = nix)
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/packagesFormat Output format for the `Packages` module. See Wiki for formatting syntax
1. {all}: Number of all packages
2. {am-system}: Number of am-system packages
3. {am-user}: Number of am-user (aka appman) packages
4. {appimage}: Number of appimage packages
5. {apk}: Number of apk packages
6. {brew}: Number of brew packages
7. {brew-all}: Total number of all brew packages
8. {brew-cask}: Number of brew-cask packages
9. {cards}: Number of cards packages
10. {choco}: Number of choco packages
11. {dpkg}: Number of dpkg packages
12. {emerge}: Number of emerge packages
13. {eopkg}: Number of eopkg packages
14. {flatpak-all}: Total number of all flatpak app packages
15. {flatpak-system}: Number of flatpak-system app packages
16. {flatpak-user}: Number of flatpak-user app packages
17. {guix-all}: Total number of all guix packages
18. {guix-home}: Number of guix-home packages
19. {guix-system}: Number of guix-system packages
20. {guix-user}: Number of guix-user packages
21. {hpkg-all}: Total number of all hpkg packages
22. {hpkg-system}: Number of hpkg-system packages
23. {hpkg-user}: Number of hpkg-user packages
24. {kiss}: Number of kiss packages
25. {linglong}: Number of linglong packages
26. {lpkg}: Number of lpkg packages
27. {lpkgbuild}: Number of lpkgbuild packages
28. {macports}: Number of macports packages
29. {mport}: Number of mport packages
30. {moss}: Number of moss packages
31. {nix-all}: Total number of all nix packages
32. {nix-default}: Number of nix-default packages
33. {nix-system}: Number of nix-system packages
34. {nix-user}: Number of nix-user packages
35. {opkg}: Number of opkg packages
36. {pacman}: Number of pacman packages
37. {pacman-branch}: Pacman branch on manjaro
38. {pacstall}: Number of pacstall packages
39. {paludis}: Number of paludis packages
40. {pisi}: Number of pisi packages
41. {pkg}: Number of pkg packages
42. {pkgsrc}: Number of pkgsrc packages
43. {pkgtool}: Number of pkgtool packages
44. {rpm}: Number of rpm packages
45. {scoop-global}: Number of scoop-global packages
46. {scoop-user}: Number of scoop-user packages
47. {snap}: Number of snap packages
48. {soar}: Number of soar packages
49. {sorcery}: Number of sorcery packages
50. {winget}: Number of winget packages
51. {xbps}: Number of xbps packages
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.48.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Packages > type
Type const
Required No

Description: List installed package managers and count of installed packages

Specific value: "packages"

5.1.2.48.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Packages > disabled
Type combining
Required No
Additional properties Any type allowed
Default ["winget"]
One of(Option)
item 0
item 1
5.1.2.48.2.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Packages > disabled > oneOf > item 0
Type array of enum (of string)
Required No

Description: Package managers to disable during detection Warning: Some detection methods can be very slow.

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 0 items -
5.1.2.48.2.1.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Packages > disabled > oneOf > item 0 > item 0 items
Type enum (of string)
Required No

Must be one of:

  • "am"
  • "apk"
  • "brew"
  • "choco"
  • "dpkg"
  • "emerge"
  • "eopkg"
  • "flatpak"
  • "guix"
  • "hpkg"
  • "linglong"
  • "lpkg"
  • "lpkgbuild"
  • "macports"
  • "mport"
  • "nix"
  • "opkg"
  • "pacman"
  • "pacstall"
  • "paludis"
  • "pisi"
  • "pkg"
  • "pkgtool"
  • "rpm"
  • "scoop"
  • "snap"
  • "sorcery"
  • "winget"
  • "xbps"
5.1.2.48.2.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Packages > disabled > oneOf > item 1
Type null
Required No

Description: Enable all package managers

5.1.2.48.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Packages > combined
Type boolean
Required No
Default false

Description: Whether to combine related package managers into single counts (e.g., nix-system + nix-user = nix)

5.1.2.48.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Packages > key
Type string
Required No
Same definition as key

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

5.1.2.48.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Packages > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.48.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Packages > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.48.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Packages > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.48.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Packages > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.48.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Packages > format
Type string
Required No
Defined in #/$defs/packagesFormat

Description: Output format for the Packages module. See Wiki for formatting syntax 1. {all}: Number of all packages 2. {am-system}: Number of am-system packages 3. {am-user}: Number of am-user (aka appman) packages 4. {appimage}: Number of appimage packages 5. {apk}: Number of apk packages 6. {brew}: Number of brew packages 7. {brew-all}: Total number of all brew packages 8. {brew-cask}: Number of brew-cask packages 9. {cards}: Number of cards packages 10. {choco}: Number of choco packages 11. {dpkg}: Number of dpkg packages 12. {emerge}: Number of emerge packages 13. {eopkg}: Number of eopkg packages 14. {flatpak-all}: Total number of all flatpak app packages 15. {flatpak-system}: Number of flatpak-system app packages 16. {flatpak-user}: Number of flatpak-user app packages 17. {guix-all}: Total number of all guix packages 18. {guix-home}: Number of guix-home packages 19. {guix-system}: Number of guix-system packages 20. {guix-user}: Number of guix-user packages 21. {hpkg-all}: Total number of all hpkg packages 22. {hpkg-system}: Number of hpkg-system packages 23. {hpkg-user}: Number of hpkg-user packages 24. {kiss}: Number of kiss packages 25. {linglong}: Number of linglong packages 26. {lpkg}: Number of lpkg packages 27. {lpkgbuild}: Number of lpkgbuild packages 28. {macports}: Number of macports packages 29. {mport}: Number of mport packages 30. {moss}: Number of moss packages 31. {nix-all}: Total number of all nix packages 32. {nix-default}: Number of nix-default packages 33. {nix-system}: Number of nix-system packages 34. {nix-user}: Number of nix-user packages 35. {opkg}: Number of opkg packages 36. {pacman}: Number of pacman packages 37. {pacman-branch}: Pacman branch on manjaro 38. {pacstall}: Number of pacstall packages 39. {paludis}: Number of paludis packages 40. {pisi}: Number of pisi packages 41. {pkg}: Number of pkg packages 42. {pkgsrc}: Number of pkgsrc packages 43. {pkgtool}: Number of pkgtool packages 44. {rpm}: Number of rpm packages 45. {scoop-global}: Number of scoop-global packages 46. {scoop-user}: Number of scoop-user packages 47. {snap}: Number of snap packages 48. {soar}: Number of soar packages 49. {sorcery}: Number of sorcery packages 50. {winget}: Number of winget packages 51. {xbps}: Number of xbps packages

5.1.2.48.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Packages > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.49. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Disk

Title: Physical Disk

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print physical disk information
- namePrefix No string No - Show disks with given name prefix only
- hideVirtual No boolean No - Hide virtual disks (e.g. loop, RAM or file baked disks)
- hideUnused No boolean No - Hide disks with `size == 0` (likely unused/unconnected)
- temp No object No Same as temp Whether to detect and display temperature, if supported
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/physicaldiskFormat Output format for the `PhysicalDisk` module. See Wiki for formatting syntax
1. {size}: Device size (formatted)
2. {name}: Device name
3. {interconnect}: Device interconnect type
4. {dev-path}: Device raw file path
5. {serial}: Serial number
6. {physical-type}: Device kind (SSD or HDD)
7. {removable-type}: Device kind (Removable or Fixed)
8. {readonly-type}: Device kind (Read-only or Read-write)
9. {revision}: Product revision
10. {temperature}: Device temperature (formatted)
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.49.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Disk > type
Type const
Required No

Description: Print physical disk information

Specific value: "physicaldisk"

5.1.2.49.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Disk > namePrefix
Type string
Required No

Description: Show disks with given name prefix only

5.1.2.49.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Disk > hideVirtual
Type boolean
Required No
Default false

Description: Hide virtual disks (e.g. loop, RAM or file baked disks)

5.1.2.49.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Disk > hideUnused
Type boolean
Required No
Default true

Description: Hide disks with size == 0 (likely unused/unconnected)

5.1.2.49.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Disk > temp
Type combining
Required No
Additional properties Any type allowed
Same definition as temp

Description: Whether to detect and display temperature, if supported

5.1.2.49.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Disk > key
Type string
Required No
Same definition as key

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

5.1.2.49.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Disk > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.49.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Disk > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.49.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Disk > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.49.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Disk > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.49.11. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Disk > format
Type string
Required No
Defined in #/$defs/physicaldiskFormat

Description: Output format for the PhysicalDisk module. See Wiki for formatting syntax 1. {size}: Device size (formatted) 2. {name}: Device name 3. {interconnect}: Device interconnect type 4. {dev-path}: Device raw file path 5. {serial}: Serial number 6. {physical-type}: Device kind (SSD or HDD) 7. {removable-type}: Device kind (Removable or Fixed) 8. {readonly-type}: Device kind (Read-only or Read-write) 9. {revision}: Product revision 10. {temperature}: Device temperature (formatted)

5.1.2.49.12. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Disk > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.50. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Memory

Title: Physical Memory

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print system physical memory devices
- showEmptySlots No boolean No - Whether to show uninstalled memory slots
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/physicalmemoryFormat Output format for the `PhysicalMemory` module. See Wiki for formatting syntax
1. {bytes}: Size (in bytes)
2. {size}: Size formatted
3. {max-speed}: Max speed (in MT/s)
4. {running-speed}: Running speed (in MT/s)
5. {type}: Type (DDR4, DDR5, etc.)
6. {form-factor}: Form factor (SODIMM, DIMM, etc.)
7. {locator}: Bank/Device Locator (BANK0/SIMM0, BANK0/SIMM1, etc.)
8. {vendor}: Vendor
9. {serial}: Serial number
10. {part-number}: Part number
11. {is-ecc-enabled}: True if ECC enabled
12. {is-installed}: True if a memory module is installed in the slot
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.50.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Memory > type
Type const
Required No

Description: Print system physical memory devices

Specific value: "physicalmemory"

5.1.2.50.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Memory > showEmptySlots
Type boolean
Required No
Default false

Description: Whether to show uninstalled memory slots

5.1.2.50.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Memory > key
Type string
Required No
Same definition as key

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

5.1.2.50.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Memory > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.50.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Memory > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.50.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Memory > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.50.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Memory > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.50.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Memory > format
Type string
Required No
Defined in #/$defs/physicalmemoryFormat

Description: Output format for the PhysicalMemory module. See Wiki for formatting syntax 1. {bytes}: Size (in bytes) 2. {size}: Size formatted 3. {max-speed}: Max speed (in MT/s) 4. {running-speed}: Running speed (in MT/s) 5. {type}: Type (DDR4, DDR5, etc.) 6. {form-factor}: Form factor (SODIMM, DIMM, etc.) 7. {locator}: Bank/Device Locator (BANK0/SIMM0, BANK0/SIMM1, etc.) 8. {vendor}: Vendor 9. {serial}: Serial number 10. {part-number}: Part number 11. {is-ecc-enabled}: True if ECC enabled 12. {is-installed}: True if a memory module is installed in the slot

5.1.2.50.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Physical Memory > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.51. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Player

Title: Player

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the music player name that is currently active
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/playerFormat Output format for the `Player` module. See Wiki for formatting syntax
1. {player}: Pretty player name
2. {name}: Player name
3. {id}: Player Identifier
4. {url}: URL name
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.51.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Player > type
Type const
Required No

Description: Print the music player name that is currently active

Specific value: "player"

5.1.2.51.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Player > key
Type string
Required No
Same definition as key

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

5.1.2.51.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Player > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.51.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Player > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.51.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Player > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.51.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Player > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.51.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Player > format
Type string
Required No
Defined in #/$defs/playerFormat

Description: Output format for the Player module. See Wiki for formatting syntax 1. {player}: Pretty player name 2. {name}: Player name 3. {id}: Player Identifier 4. {url}: URL name

5.1.2.51.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Player > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.52. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Power Adapter

Title: Power Adapter

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print power adapter name and charging watts
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/poweradapterFormat Output format for the `PowerAdapter` module. See Wiki for formatting syntax
1. {watts}: Power adapter watts
2. {name}: Power adapter name
3. {manufacturer}: Power adapter manufacturer
4. {model}: Power adapter model
5. {description}: Power adapter description
6. {serial}: Power adapter serial number
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.52.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Power Adapter > type
Type const
Required No

Description: Print power adapter name and charging watts

Specific value: "poweradapter"

5.1.2.52.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Power Adapter > key
Type string
Required No
Same definition as key

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

5.1.2.52.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Power Adapter > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.52.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Power Adapter > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.52.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Power Adapter > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.52.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Power Adapter > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.52.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Power Adapter > format
Type string
Required No
Defined in #/$defs/poweradapterFormat

Description: Output format for the PowerAdapter module. See Wiki for formatting syntax 1. {watts}: Power adapter watts 2. {name}: Power adapter name 3. {manufacturer}: Power adapter manufacturer 4. {model}: Power adapter model 5. {description}: Power adapter description 6. {serial}: Power adapter serial number

5.1.2.52.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Power Adapter > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.53. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Processes

Title: Processes

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the number of running processes
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/processesFormat Output format for the `Processes` module. See Wiki for formatting syntax
1. {result}: Process count
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.53.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Processes > type
Type const
Required No

Description: Print the number of running processes

Specific value: "processes"

5.1.2.53.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Processes > key
Type string
Required No
Same definition as key

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

5.1.2.53.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Processes > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.53.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Processes > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.53.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Processes > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.53.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Processes > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.53.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Processes > format
Type string
Required No
Defined in #/$defs/processesFormat

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

5.1.2.53.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Processes > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.54. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Public IP

Title: Public IP

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print your public IP address and related information
- url No string No - URL of the public IP detection server to use. Only HTTP is supported
- timeout No integer No - Time in milliseconds to wait for the public IP server to respond
Set to 0 to disable the timeout
- ipv6 No boolean No - Whether to use IPv6 for the public IP detection server
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/publicipFormat Output format for the `PublicIp` module. See Wiki for formatting syntax
1. {ip}: Public IP address
2. {location}: Location
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.54.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Public IP > type
Type const
Required No

Description: Print your public IP address and related information

Specific value: "publicip"

5.1.2.54.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Public IP > url
Type string
Required No
Format url
Default "http://ipinfo.io/ip"

Description: URL of the public IP detection server to use. Only HTTP is supported

5.1.2.54.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Public IP > timeout
Type integer
Required No
Default 0

Description: Time in milliseconds to wait for the public IP server to respond Set to 0 to disable the timeout

Restrictions
Minimum ≥ 0
5.1.2.54.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Public IP > ipv6
Type boolean
Required No
Default false

Description: Whether to use IPv6 for the public IP detection server

5.1.2.54.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Public IP > key
Type string
Required No
Same definition as key

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

5.1.2.54.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Public IP > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.54.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Public IP > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.54.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Public IP > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.54.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Public IP > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.54.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Public IP > format
Type string
Required No
Defined in #/$defs/publicipFormat

Description: Output format for the PublicIp module. See Wiki for formatting syntax 1. {ip}: Public IP address 2. {location}: Location

5.1.2.54.11. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Public IP > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.55. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Separator

Title: Separator

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print a separator line
- string No string No - String to print for the separator line
- outputColor No object No Same as outputColor Color of the separator line
- times No integer No - Number of times to repeat the separator string, or 0 to auto-detect
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.55.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Separator > type
Type const
Required No

Description: Print a separator line

Specific value: "separator"

5.1.2.55.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Separator > string
Type string
Required No
Default "-"

Description: String to print for the separator line

5.1.2.55.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Separator > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

Description: Color of the separator line

5.1.2.55.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Separator > times
Type integer
Required No
Default 0

Description: Number of times to repeat the separator string, or 0 to auto-detect

Restrictions
Minimum ≥ 0
5.1.2.55.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Separator > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.56. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Shell

Title: Shell

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the current shell name and version
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/shellFormat Output format for the `Shell` module. See Wiki for formatting syntax
1. {process-name}: Shell process name
2. {exe}: The first argument of the command line when running the shell
3. {exe-name}: Shell base name of arg0
4. {version}: Shell version
5. {pid}: Shell pid
6. {pretty-name}: Shell pretty name
7. {exe-path}: Shell full exe path
8. {tty}: Shell tty used
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.56.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Shell > type
Type const
Required No

Description: Print the current shell name and version

Specific value: "shell"

5.1.2.56.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Shell > key
Type string
Required No
Same definition as key

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

5.1.2.56.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Shell > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.56.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Shell > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.56.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Shell > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.56.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Shell > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.56.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Shell > format
Type string
Required No
Defined in #/$defs/shellFormat

Description: Output format for the Shell module. See Wiki for formatting syntax 1. {process-name}: Shell process name 2. {exe}: The first argument of the command line when running the shell 3. {exe-name}: Shell base name of arg0 4. {version}: Shell version 5. {pid}: Shell pid 6. {pretty-name}: Shell pretty name 7. {exe-path}: Shell full exe path 8. {tty}: Shell tty used

5.1.2.56.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Shell > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.57. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Sound

Title: Sound

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print sound devices, volume levels, etc.
- soundType No Combination No - Which sound devices to print
- percent No object No Same as percent Color thresholds for percentage output
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/soundFormat Output format for the `Sound` module. See Wiki for formatting syntax
1. {is-main}: Is main sound device
2. {is-active}: Is active sound device
3. {name}: Device name
4. {volume-percentage}: Volume (in percentage num)
5. {identifier}: Identifier
6. {volume-percentage-bar}: Volume (in percentage bar)
7. {platform-api}: Platform API used
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.57.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Sound > type
Type const
Required No

Description: Print sound devices, volume levels, etc.

Specific value: "sound"

5.1.2.57.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Sound > soundType
Type combining
Required No
Default "main"

Description: Which sound devices to print

One of(Option)
item 0
item 1
item 2
5.1.2.57.2.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Sound > soundType > oneOf > item 0
Type const
Required No

Description: Print only main sound devices

Specific value: "main"

5.1.2.57.2.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Sound > soundType > oneOf > item 1
Type const
Required No

Description: Print only active sound devices

Specific value: "active"

5.1.2.57.2.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Sound > soundType > oneOf > item 2
Type const
Required No

Description: Print all sound devices

Specific value: "all"

5.1.2.57.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Sound > percent
Type object
Required No
Additional properties Not allowed
Same definition as percent

Description: Color thresholds for percentage output

5.1.2.57.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Sound > key
Type string
Required No
Same definition as key

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

5.1.2.57.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Sound > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.57.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Sound > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.57.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Sound > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.57.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Sound > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.57.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Sound > format
Type string
Required No
Defined in #/$defs/soundFormat

Description: Output format for the Sound module. See Wiki for formatting syntax 1. {is-main}: Is main sound device 2. {is-active}: Is active sound device 3. {name}: Device name 4. {volume-percentage}: Volume (in percentage num) 5. {identifier}: Identifier 6. {volume-percentage-bar}: Volume (in percentage bar) 7. {platform-api}: Platform API used

5.1.2.57.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Sound > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.58. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Swap

Title: Swap

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print swap (paging file) space usage
- separate No boolean No - Whether to report individual swap devices on separate lines instead of showing a summary
- percent No object No Same as percent Color thresholds for percentage output
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/swapFormat Output format for the `Swap` module. See Wiki for formatting syntax
1. {used}: Used size
2. {total}: Total size
3. {percentage}: Percentage used (num)
4. {percentage-bar}: Percentage used (bar)
5. {name}: Name
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.58.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Swap > type
Type const
Required No

Description: Print swap (paging file) space usage

Specific value: "swap"

5.1.2.58.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Swap > separate
Type boolean
Required No
Default false

Description: Whether to report individual swap devices on separate lines instead of showing a summary

5.1.2.58.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Swap > percent
Type object
Required No
Additional properties Not allowed
Same definition as percent

Description: Color thresholds for percentage output

5.1.2.58.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Swap > key
Type string
Required No
Same definition as key

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

5.1.2.58.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Swap > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.58.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Swap > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.58.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Swap > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.58.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Swap > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.58.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Swap > format
Type string
Required No
Defined in #/$defs/swapFormat

Description: Output format for the Swap module. See Wiki for formatting syntax 1. {used}: Used size 2. {total}: Total size 3. {percentage}: Percentage used (num) 4. {percentage-bar}: Percentage used (bar) 5. {name}: Name

5.1.2.58.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Swap > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.59. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal

Title: Terminal

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the current terminal name and version
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/terminalFormat Output format for the `Terminal` module. See Wiki for formatting syntax
1. {process-name}: Terminal process name
2. {exe}: The first argument of the command line when running the terminal
3. {exe-name}: Terminal base name of arg0
4. {pid}: Terminal pid
5. {pretty-name}: Terminal pretty name
6. {version}: Terminal version
7. {exe-path}: Terminal full exe path
8. {tty}: Terminal tty / pts used
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.59.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal > type
Type const
Required No

Description: Print the current terminal name and version

Specific value: "terminal"

5.1.2.59.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal > key
Type string
Required No
Same definition as key

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

5.1.2.59.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.59.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.59.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.59.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.59.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal > format
Type string
Required No
Defined in #/$defs/terminalFormat

Description: Output format for the Terminal module. See Wiki for formatting syntax 1. {process-name}: Terminal process name 2. {exe}: The first argument of the command line when running the terminal 3. {exe-name}: Terminal base name of arg0 4. {pid}: Terminal pid 5. {pretty-name}: Terminal pretty name 6. {version}: Terminal version 7. {exe-path}: Terminal full exe path 8. {tty}: Terminal tty / pts used

5.1.2.59.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.60. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Font

Title: Terminal Font

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the font name and size used by the current terminal
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/terminalfontFormat Output format for the `TerminalFont` module. See Wiki for formatting syntax
1. {combined}: Terminal font combined
2. {name}: Terminal font name
3. {size}: Terminal font size
4. {styles}: Terminal font styles
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.60.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Font > type
Type const
Required No

Description: Print the font name and size used by the current terminal

Specific value: "terminalfont"

5.1.2.60.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Font > key
Type string
Required No
Same definition as key

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

5.1.2.60.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Font > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.60.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Font > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.60.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Font > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.60.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Font > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.60.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Font > format
Type string
Required No
Defined in #/$defs/terminalfontFormat

Description: Output format for the TerminalFont module. See Wiki for formatting syntax 1. {combined}: Terminal font combined 2. {name}: Terminal font name 3. {size}: Terminal font size 4. {styles}: Terminal font styles

5.1.2.60.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Font > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.61. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Size

Title: Terminal Size

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the current terminal size
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/terminalsizeFormat Output format for the `TerminalSize` module. See Wiki for formatting syntax
1. {rows}: Terminal rows
2. {columns}: Terminal columns
3. {width}: Terminal width (in pixels)
4. {height}: Terminal height (in pixels)
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.61.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Size > type
Type const
Required No

Description: Print the current terminal size

Specific value: "terminalsize"

5.1.2.61.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Size > key
Type string
Required No
Same definition as key

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

5.1.2.61.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Size > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.61.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Size > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.61.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Size > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.61.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Size > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.61.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Size > format
Type string
Required No
Defined in #/$defs/terminalsizeFormat

Description: Output format for the TerminalSize module. See Wiki for formatting syntax 1. {rows}: Terminal rows 2. {columns}: Terminal columns 3. {width}: Terminal width (in pixels) 4. {height}: Terminal height (in pixels)

5.1.2.61.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Size > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.62. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Theme

Title: Terminal Theme

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the current terminal theme (foreground and background colors)
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/terminalthemeFormat Output format for the `TerminalTheme` module. See Wiki for formatting syntax
1. {fg-color}: Terminal foreground color
2. {fg-type}: Terminal foreground type (Dark / Light)
3. {bg-color}: Terminal background color
4. {bg-type}: Terminal background type (Dark / Light)
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.62.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Theme > type
Type const
Required No

Description: Print the current terminal theme (foreground and background colors)

Specific value: "terminaltheme"

5.1.2.62.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Theme > key
Type string
Required No
Same definition as key

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

5.1.2.62.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Theme > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.62.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Theme > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.62.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Theme > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.62.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Theme > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.62.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Theme > format
Type string
Required No
Defined in #/$defs/terminalthemeFormat

Description: Output format for the TerminalTheme module. See Wiki for formatting syntax 1. {fg-color}: Terminal foreground color 2. {fg-type}: Terminal foreground type (Dark / Light) 3. {bg-color}: Terminal background color 4. {bg-type}: Terminal background type (Dark / Light)

5.1.2.62.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Terminal Theme > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.63. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Theme

Title: Theme

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the current desktop environment theme
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/themeFormat Output format for the `Theme` module. See Wiki for formatting syntax
1. {theme1}: Theme part 1
2. {theme2}: Theme part 2
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.63.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Theme > type
Type const
Required No

Description: Print the current desktop environment theme

Specific value: "theme"

5.1.2.63.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Theme > key
Type string
Required No
Same definition as key

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

5.1.2.63.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Theme > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.63.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Theme > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.63.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Theme > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.63.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Theme > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.63.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Theme > format
Type string
Required No
Defined in #/$defs/themeFormat

Description: Output format for the Theme module. See Wiki for formatting syntax 1. {theme1}: Theme part 1 2. {theme2}: Theme part 2

5.1.2.63.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Theme > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.64. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Title

Title: Title

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the title, including your username and hostname
- fqdn No boolean No - Whether to use the fully qualified domain name in the title
- color No object No - Colors for the different parts of the title
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/titleFormat Output format for the `Title` module. See Wiki for formatting syntax
1. {user-name}: User name
2. {host-name}: Host name
3. {home-dir}: Home directory
4. {exe-path}: Executable path of current process
5. {user-shell}: User's default shell
6. {user-name-colored}: User name (colored)
7. {at-symbol-colored}: @ symbol (colored)
8. {host-name-colored}: Host name (colored)
9. {full-user-name}: Full user name
10. {user-id}: UID (*nix) / SID (Windows)
11. {pid}: PID of current process
12. {cwd}: CWD with home dir replaced by `~`
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.64.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Title > type
Type const
Required No

Description: Print the title, including your username and hostname

Specific value: "title"

5.1.2.64.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Title > fqdn
Type boolean
Required No
Default false

Description: Whether to use the fully qualified domain name in the title

5.1.2.64.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Title > color
Type object
Required No
Additional properties Not allowed

Description: Colors for the different parts of the title

Property Pattern Type Deprecated Definition Title/Description
- user No object No Same as 1 Color of the username (left part)
- at No object No Same as 1 Color of the @ symbol (middle part)
- host No object No Same as 1 Color of the hostname (right part)
5.1.2.64.3.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Title > color > user
Type combining
Required No
Additional properties Any type allowed
Same definition as 1

Description: Color of the username (left part)

5.1.2.64.3.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Title > color > at
Type combining
Required No
Additional properties Any type allowed
Same definition as 1

Description: Color of the @ symbol (middle part)

5.1.2.64.3.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Title > color > host
Type combining
Required No
Additional properties Any type allowed
Same definition as 1

Description: Color of the hostname (right part)

5.1.2.64.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Title > key
Type string
Required No
Same definition as key

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

5.1.2.64.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Title > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.64.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Title > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.64.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Title > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.64.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Title > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.64.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Title > format
Type string
Required No
Defined in #/$defs/titleFormat

Description: Output format for the Title module. See Wiki for formatting syntax 1. {user-name}: User name 2. {host-name}: Host name 3. {home-dir}: Home directory 4. {exe-path}: Executable path of current process 5. {user-shell}: User's default shell 6. {user-name-colored}: User name (colored) 7. {at-symbol-colored}: @ symbol (colored) 8. {host-name-colored}: Host name (colored) 9. {full-user-name}: Full user name 10. {user-id}: UID (*nix) / SID (Windows) 11. {pid}: PID of current process 12. {cwd}: CWD with home dir replaced by ~

5.1.2.64.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Title > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.65. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > TPM

Title: TPM

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print information about the Trusted Platform Module (TPM) security device
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/tpmFormat Output format for the `TPM` module. See Wiki for formatting syntax
1. {version}: TPM device version
2. {description}: TPM general description
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.65.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > TPM > type
Type const
Required No

Description: Print information about the Trusted Platform Module (TPM) security device

Specific value: "tpm"

5.1.2.65.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > TPM > key
Type string
Required No
Same definition as key

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

5.1.2.65.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > TPM > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.65.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > TPM > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.65.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > TPM > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.65.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > TPM > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.65.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > TPM > format
Type string
Required No
Defined in #/$defs/tpmFormat

Description: Output format for the TPM module. See Wiki for formatting syntax 1. {version}: TPM device version 2. {description}: TPM general description

5.1.2.65.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > TPM > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.66. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Users

Title: Users

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print users who are currently logged in
- compact No boolean No - Show all active users in one line
- myselfOnly No boolean No - Show only the current user
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/usersFormat Output format for the `Users` module. See Wiki for formatting syntax
1. {name}: User name
2. {host-name}: Host name
3. {session-name}: Session name
4. {client-ip}: Client IP
5. {login-time}: Login Time in local timezone
6. {days}: Days after login
7. {hours}: Hours after login
8. {minutes}: Minutes after login
9. {seconds}: Seconds after login
10. {milliseconds}: Milliseconds after login
11. {years}: Years integer after login
12. {days-of-year}: Days of year after login
13. {years-fraction}: Years fraction after login
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.66.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Users > type
Type const
Required No

Description: Print users who are currently logged in

Specific value: "users"

5.1.2.66.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Users > compact
Type boolean
Required No
Default false

Description: Show all active users in one line

5.1.2.66.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Users > myselfOnly
Type boolean
Required No
Default false

Description: Show only the current user

5.1.2.66.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Users > key
Type string
Required No
Same definition as key

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

5.1.2.66.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Users > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.66.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Users > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.66.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Users > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.66.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Users > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.66.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Users > format
Type string
Required No
Defined in #/$defs/usersFormat

Description: Output format for the Users module. See Wiki for formatting syntax 1. {name}: User name 2. {host-name}: Host name 3. {session-name}: Session name 4. {client-ip}: Client IP 5. {login-time}: Login Time in local timezone 6. {days}: Days after login 7. {hours}: Hours after login 8. {minutes}: Minutes after login 9. {seconds}: Seconds after login 10. {milliseconds}: Milliseconds after login 11. {years}: Years integer after login 12. {days-of-year}: Days of year after login 13. {years-fraction}: Years fraction after login

5.1.2.66.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Users > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.67. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Uptime

Title: Uptime

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print how long the system has been running
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/uptimeFormat Output format for the `Uptime` module. See Wiki for formatting syntax
1. {days}: Days after boot
2. {hours}: Hours after boot
3. {minutes}: Minutes after boot
4. {seconds}: Seconds after boot
5. {milliseconds}: Milliseconds after boot
6. {boot-time}: Boot time in local timezone
7. {years}: Years integer after boot
8. {days-of-year}: Days of year after boot
9. {years-fraction}: Years fraction after boot
10. {formatted}: Formatted uptime
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.67.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Uptime > type
Type const
Required No

Description: Print how long the system has been running

Specific value: "uptime"

5.1.2.67.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Uptime > key
Type string
Required No
Same definition as key

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

5.1.2.67.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Uptime > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.67.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Uptime > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.67.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Uptime > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.67.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Uptime > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.67.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Uptime > format
Type string
Required No
Defined in #/$defs/uptimeFormat

Description: Output format for the Uptime module. See Wiki for formatting syntax 1. {days}: Days after boot 2. {hours}: Hours after boot 3. {minutes}: Minutes after boot 4. {seconds}: Seconds after boot 5. {milliseconds}: Milliseconds after boot 6. {boot-time}: Boot time in local timezone 7. {years}: Years integer after boot 8. {days-of-year}: Days of year after boot 9. {years-fraction}: Years fraction after boot 10. {formatted}: Formatted uptime

5.1.2.67.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Uptime > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.68. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Version

Title: Version

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the Fastfetch version and build information
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/versionFormat Output format for the `Version` module. See Wiki for formatting syntax
1. {project-name}: Project name
2. {version}: Version
3. {version-tweak}: Version tweak
4. {build-type}: Build type (debug or release)
5. {sysname}: System name
6. {arch}: Architecture
7. {cmake-built-type}: CMake build type when compiling (Debug, Release, RelWithDebInfo, MinSizeRel)
8. {compile-time}: Date time when compiling
9. {compiler}: Compiler used when compiling
10. {libc}: Libc used when compiling
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.68.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Version > type
Type const
Required No

Description: Print the Fastfetch version and build information

Specific value: "version"

5.1.2.68.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Version > key
Type string
Required No
Same definition as key

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

5.1.2.68.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Version > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.68.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Version > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.68.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Version > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.68.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Version > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.68.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Version > format
Type string
Required No
Defined in #/$defs/versionFormat

Description: Output format for the Version module. See Wiki for formatting syntax 1. {project-name}: Project name 2. {version}: Version 3. {version-tweak}: Version tweak 4. {build-type}: Build type (debug or release) 5. {sysname}: System name 6. {arch}: Architecture 7. {cmake-built-type}: CMake build type when compiling (Debug, Release, RelWithDebInfo, MinSizeRel) 8. {compile-time}: Date time when compiling 9. {compiler}: Compiler used when compiling 10. {libc}: Libc used when compiling

5.1.2.68.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Version > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.69. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Vulkan

Title: Vulkan

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the highest Vulkan version supported by the GPU
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/vulkanFormat Output format for the `Vulkan` module. See Wiki for formatting syntax
1. {driver}: Driver name
2. {api-version}: API version
3. {conformance-version}: Conformance version
4. {instance-version}: Instance version
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.69.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Vulkan > type
Type const
Required No

Description: Print the highest Vulkan version supported by the GPU

Specific value: "vulkan"

5.1.2.69.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Vulkan > key
Type string
Required No
Same definition as key

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

5.1.2.69.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Vulkan > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.69.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Vulkan > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.69.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Vulkan > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.69.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Vulkan > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.69.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Vulkan > format
Type string
Required No
Defined in #/$defs/vulkanFormat

Description: Output format for the Vulkan module. See Wiki for formatting syntax 1. {driver}: Driver name 2. {api-version}: API version 3. {conformance-version}: Conformance version 4. {instance-version}: Instance version

5.1.2.69.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Vulkan > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.70. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wallpaper

Title: Wallpaper

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the file path of the current wallpaper
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/wallpaperFormat Output format for the `Wallpaper` module. See Wiki for formatting syntax
1. {file-name}: File name
2. {full-path}: Full path
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.70.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wallpaper > type
Type const
Required No

Description: Print the file path of the current wallpaper

Specific value: "wallpaper"

5.1.2.70.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wallpaper > key
Type string
Required No
Same definition as key

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

5.1.2.70.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wallpaper > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.70.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wallpaper > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.70.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wallpaper > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.70.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wallpaper > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.70.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wallpaper > format
Type string
Required No
Defined in #/$defs/wallpaperFormat

Description: Output format for the Wallpaper module. See Wiki for formatting syntax 1. {file-name}: File name 2. {full-path}: Full path

5.1.2.70.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wallpaper > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.71. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Weather

Title: Weather

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print weather information
- location No string No - Location to display
Must be URI-encoded (for example, spaces must be encoded as `+`)
- timeout No integer No - Time in milliseconds to wait for the weather server to respond.
0 to disable timeout
- outputFormat No string No - Weather output format to use (must be URI-encoded)
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/weatherFormat Output format for the `Weather` module. See Wiki for formatting syntax
1. {result}: Weather result
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.71.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Weather > type
Type const
Required No

Description: Print weather information

Specific value: "weather"

5.1.2.71.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Weather > location
Type string
Required No

Description: Location to display Must be URI-encoded (for example, spaces must be encoded as +)

5.1.2.71.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Weather > timeout
Type integer
Required No
Default 0

Description: Time in milliseconds to wait for the weather server to respond. 0 to disable timeout

Restrictions
Minimum ≥ 0
5.1.2.71.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Weather > outputFormat
Type string
Required No
Default "%t+-+%C+(%l)"

Description: Weather output format to use (must be URI-encoded)

5.1.2.71.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Weather > key
Type string
Required No
Same definition as key

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

5.1.2.71.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Weather > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.71.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Weather > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.71.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Weather > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.71.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Weather > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.71.10. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Weather > format
Type string
Required No
Defined in #/$defs/weatherFormat

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

5.1.2.71.11. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Weather > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.72. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wi-Fi

Title: Wi-Fi

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print connected Wi-Fi info (SSID, connection and security protocol)
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/wifiFormat Output format for the `Wifi` module. See Wiki for formatting syntax
1. {inf-desc}: Interface description
2. {inf-status}: Interface status
3. {status}: Connection status
4. {ssid}: Connection SSID
5. {bssid}: Connection BSSID
6. {protocol}: Connection protocol
7. {signal-quality}: Connection signal quality (percentage num)
8. {rx-rate}: Connection RX rate
9. {tx-rate}: Connection TX rate
10. {security}: Connection Security algorithm
11. {signal-quality-bar}: Connection signal quality (percentage bar)
12. {channel}: Connection channel number
13. {band}: Connection channel band in GHz
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.72.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wi-Fi > type
Type const
Required No

Description: Print connected Wi-Fi info (SSID, connection and security protocol)

Specific value: "wifi"

5.1.2.72.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wi-Fi > key
Type string
Required No
Same definition as key

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

5.1.2.72.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wi-Fi > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.72.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wi-Fi > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.72.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wi-Fi > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.72.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wi-Fi > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.72.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wi-Fi > format
Type string
Required No
Defined in #/$defs/wifiFormat

Description: Output format for the Wifi module. See Wiki for formatting syntax 1. {inf-desc}: Interface description 2. {inf-status}: Interface status 3. {status}: Connection status 4. {ssid}: Connection SSID 5. {bssid}: Connection BSSID 6. {protocol}: Connection protocol 7. {signal-quality}: Connection signal quality (percentage num) 8. {rx-rate}: Connection RX rate 9. {tx-rate}: Connection TX rate 10. {security}: Connection Security algorithm 11. {signal-quality-bar}: Connection signal quality (percentage bar) 12. {channel}: Connection channel number 13. {band}: Connection channel band in GHz

5.1.2.72.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Wi-Fi > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.73. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Window Manager

Title: Window Manager

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the window manager name and version
- detectPlugin No boolean No - Whether to detect the window manager plugin on supported platforms
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/wmFormat Output format for the `WM` module. See Wiki for formatting syntax
1. {process-name}: WM process name
2. {pretty-name}: WM pretty name
3. {protocol-name}: WM protocol name
4. {plugin-name}: WM plugin name
5. {version}: WM version
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.73.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Window Manager > type
Type const
Required No

Description: Print the window manager name and version

Specific value: "wm"

5.1.2.73.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Window Manager > detectPlugin
Type boolean
Required No
Default true

Description: Whether to detect the window manager plugin on supported platforms

5.1.2.73.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Window Manager > key
Type string
Required No
Same definition as key

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

5.1.2.73.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Window Manager > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.73.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Window Manager > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.73.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Window Manager > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.73.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Window Manager > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.73.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Window Manager > format
Type string
Required No
Defined in #/$defs/wmFormat

Description: Output format for the WM module. See Wiki for formatting syntax 1. {process-name}: WM process name 2. {pretty-name}: WM pretty name 3. {protocol-name}: WM protocol name 4. {plugin-name}: WM plugin name 5. {version}: WM version

5.1.2.73.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Window Manager > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.74. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > WM Theme

Title: WM Theme

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print the current window manager theme
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/wmthemeFormat Output format for the `WMTheme` module. See Wiki for formatting syntax
1. {result}: WM theme
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.74.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > WM Theme > type
Type const
Required No

Description: Print the current window manager theme

Specific value: "wmtheme"

5.1.2.74.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > WM Theme > key
Type string
Required No
Same definition as key

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

5.1.2.74.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > WM Theme > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.74.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > WM Theme > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.74.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > WM Theme > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.74.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > WM Theme > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.74.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > WM Theme > format
Type string
Required No
Defined in #/$defs/wmthemeFormat

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

5.1.2.74.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > WM Theme > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.75. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Zpool

Title: Zpool

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print ZFS storage pools
- percent No object No Same as percent Color thresholds for percentage output
- key No string No Same as key Module key
Use a single space (` `) to hide the key
- keyColor No object No Same as keyColor Color of the module key. Overrides `display.color.key`
- keyIcon No string No Same as keyIcon Icon to display when `display.key.type` is set to `icon`
- keyWidth No integer No Same as keyWidth Width of the module key. Overrides `display.keyWidth`
- outputColor No object No Same as outputColor Color of the module output. Overrides `display.color.output`
- format No string No In #/$defs/zpoolFormat Output format for the `Zpool` module. See Wiki for formatting syntax
1. {name}: Zpool name
2. {guid}: Zpool guid
3. {state}: Zpool state
4. {size-used}: Size used
5. {size-allocated}: Size allocated
6. {size-total}: Size total
7. {used-percentage}: Size used percentage num
8. {allocated-percentage}: Size allocated percentage num
9. {frag-percentage}: Fragmentation percentage num
10. {used-percentage-bar}: Size used percentage bar
11. {allocated-percentage-bar}: Size allocated percentage bar
12. {frag-percentage-bar}: Fragmentation percentage bar
13. {is-readonly}: Is read-only
- condition No object No Same as condition Show the module only if these conditions are met
5.1.2.75.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Zpool > type
Type const
Required No

Description: Print ZFS storage pools

Specific value: "zpool"

5.1.2.75.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Zpool > percent
Type object
Required No
Additional properties Not allowed
Same definition as percent

Description: Color thresholds for percentage output

5.1.2.75.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Zpool > key
Type string
Required No
Same definition as key

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

5.1.2.75.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Zpool > keyColor
Type object
Required No
Additional properties Any type allowed
Same definition as keyColor

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

5.1.2.75.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Zpool > keyIcon
Type string
Required No
Same definition as keyIcon

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

5.1.2.75.6. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Zpool > keyWidth
Type integer
Required No
Same definition as keyWidth

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

5.1.2.75.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Zpool > outputColor
Type object
Required No
Additional properties Any type allowed
Same definition as outputColor

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

5.1.2.75.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Zpool > format
Type string
Required No
Defined in #/$defs/zpoolFormat

Description: Output format for the Zpool module. See Wiki for formatting syntax 1. {name}: Zpool name 2. {guid}: Zpool guid 3. {state}: Zpool state 4. {size-used}: Size used 5. {size-allocated}: Size allocated 6. {size-total}: Size total 7. {used-percentage}: Size used percentage num 8. {allocated-percentage}: Size allocated percentage num 9. {frag-percentage}: Fragmentation percentage num 10. {used-percentage-bar}: Size used percentage bar 11. {allocated-percentage-bar}: Size allocated percentage bar 12. {frag-percentage-bar}: Fragmentation percentage bar 13. {is-readonly}: Is read-only

5.1.2.75.9. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Zpool > condition
Type object
Required No
Additional properties Not allowed
Same definition as condition

Description: Show the module only if these conditions are met

5.1.2.76. Property JSON config > modules > modules items > anyOf > item 1 > type
Type string
Required Yes

Generated using json-schema-for-humans on 2026-06-03 at 16:09:36 +0800