Skip to content

Json Schema modules

李通洲 edited this page Oct 11, 2025 · 1 revision

5. Property JSON config > modules

Type array
Required No

Description: Fastfetch modules to run

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

5.1. JSON config > modules > modules items

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

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

Type enum (of string)
Required No

Description: Run module with default configurations

Must be one of:

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

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

Title: Break

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print a empty line
- condition No object No In #/$defs/conditions Only show the module if 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 a 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: Only show the module if conditions are met

Property Pattern Type Deprecated Definition Title/Description
- system No Combination No - System name to match
- !system No Combination No - System name to not match
- arch No Combination No - Architecture to match
- !arch No Combination No - Architecture to not 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 name 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 system names 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: 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 name to not 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 system names to not 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: 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: 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 to not 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 to not 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: 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 only show the module if it succeeded, false to only show it 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: 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 capacity, status, etc
- useSetupApi No boolean No - Set if `SetupAPI` should be used on Windows to detect battery info, which supports multi batteries, but slower. Windows only
- temp No object No In #/$defs/temperature Detect and display temperature if supported
- percent No object No In #/$defs/percent Thresholds for percentage colors
- key No string No In #/$defs/key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No In #/$defs/keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No In #/$defs/keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No In #/$defs/keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No In #/$defs/outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/batteryFormat Output format of the module `Battery`. See Wiki for formatting syntax
1. {manufacturer}: Battery manufacturer
2. {model-name}: Battery model name
3. {technology}: Battery technology
4. {capacity}: Battery capacity (percentage num)
5. {status}: Battery status
6. {temperature}: Battery temperature (formatted)
7. {cycle-count}: Battery cycle count
8. {serial}: Battery serial number
9. {manufacture-date}: Battery manufactor date
10. {capacity-bar}: Battery capacity (percentage bar)
11. {time-days}: Battery time remaining days
12. {time-hours}: Battery time remaining hours
13. {time-minutes}: Battery time remaining minutes
14. {time-seconds}: Battery time remaining seconds
15. {time-formatted}: Battery time remaining (formatted)
- condition No object No Same as condition Only show the module if 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 capacity, status, etc

Specific value: "battery"

5.1.2.2.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > useSetupApi
Type boolean
Required No
Default false

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

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

Description: Detect and display temperature if supported

One of(Option)
item 0
item 1
5.1.2.2.3.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 0
Type boolean
Required No
Default false
5.1.2.2.3.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 1
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- green No integer No - Values (in celsius) less than green will be shown in green
- yellow No integer No - Values (in celsius) greater than green and less than yellow will be shown in yellow.
Values greater than yellow will be shown in red
5.1.2.2.3.2.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > temp > oneOf > item 1 > green
Type integer
Required No

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

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

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

Restrictions
Minimum ≥ 0
Maximum ≤ 100
5.1.2.2.4. 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: Thresholds for percentage colors

Property Pattern Type Deprecated Definition Title/Description
- green No integer No - Values less than green will be shown in green
- yellow No integer No - Values greater than green and less than yellow will be shown in yellow.
Values greater than yellow will be shown in red
- type No object No Same as type Set the percentage output type
5.1.2.2.4.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Battery > percent > green
Type integer
Required No

Description: Values less than green will be shown in green

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

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

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

Description: Set the percentage output type

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if 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 information of 1st-stage bootloader (name, version, release date, etc)
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/biosFormat Output format of the module `BIOS`. See Wiki for formatting syntax
1. {date}: Bios date
2. {release}: Bios release
3. {vendor}: Bios vendor
4. {version}: Bios version
5. {type}: Firmware type
- condition No object No Same as condition Only show the module if 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 information of 1st-stage bootloader (name, version, release date, etc)

Specific value: "bios"

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

Description: Key of the module One whitespace character ( ) can be used 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 to override the global setting 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: Set the icon to be displayed by display.keyType: "icon"

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

Description: Width of the module key to override the global setting 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: Output color of the module to override the global setting display.color.output

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

Description: Output format of the module BIOS. See 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: Only show the module if 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 - Set if disconnected bluetooth devices should be printed
- percent No object No Same as percent Thresholds for percentage colors
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/bluetoothFormat Output format of the module `Bluetooth`. See Wiki for formatting syntax
1. {name}: Name
2. {address}: Address
3. {type}: Type
4. {battery-percentage}: Battery percentage number
5. {connected}: Is connected
6. {battery-percentage-bar}: Battery percentage bar
- condition No object No Same as condition Only show the module if 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: Set if disconnected bluetooth devices should be printed

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

Description: Thresholds for percentage colors

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

Description: Key of the module One whitespace character ( ) can be used 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 to override the global setting 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: Set the icon to be displayed by display.keyType: "icon"

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

Description: Width of the module key to override the global setting 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: Output color of the module to override the global setting display.color.output

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

Description: Output format of the module Bluetooth. See 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: Only show the module if 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 width supported version and vendor
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/bluetoothradioFormat Output format of the module `BluetoothRadio`. See Wiki for formatting syntax
1. {name}: Radio name for discovering
2. {address}: Address
3. {lmp-version}: LMP version
4. {lmp-subversion}: LMP subversion
5. {version}: Bluetooth version
6. {vendor}: Vendor
7. {discoverable}: Discoverable
8. {connectable}: Connectable / Pairable
- condition No object No Same as condition Only show the module if 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 width supported version and vendor

Specific value: "bluetoothradio"

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

Description: Key of the module One whitespace character ( ) can be used 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 to override the global setting 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: Set the icon to be displayed by display.keyType: "icon"

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

Description: Width of the module key to override the global setting 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: Output color of the module to override the global setting display.color.output

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

Description: Output format of the module BluetoothRadio. See 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: Only show the module if 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 info
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/boardFormat Output format of the module `Board`. See Wiki for formatting syntax
1. {name}: Board name
2. {vendor}: Board vendor
3. {version}: Board version
4. {serial}: Board serial number
- condition No object No Same as condition Only show the module if 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 info

Specific value: "board"

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

Description: Key of the module One whitespace character ( ) can be used 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 to override the global setting 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: Set the icon to be displayed by display.keyType: "icon"

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

Description: Width of the module key to override the global setting 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: Output color of the module to override the global setting display.color.output

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

Description: Output format of the module Board. See 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: Only show the module if 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 information of 2nd-stage bootloader (name, firmware, etc)
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/bootmgrFormat Output format of the module `Bootmgr`. See Wiki for formatting syntax
1. {name}: Name / description
2. {firmware-path}: Firmware file path
3. {firmware-name}: Firmware file name
4. {secure-boot}: Is secure boot enabled
5. {order}: Boot order
- condition No object No Same as condition Only show the module if 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 information of 2nd-stage bootloader (name, firmware, etc)

Specific value: "bootmgr"

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

Description: Key of the module One whitespace character ( ) can be used 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 to override the global setting 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: Set the icon to be displayed by display.keyType: "icon"

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

Description: Width of the module key to override the global setting 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: Output color of the module to override the global setting display.color.output

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

Description: Output format of the module Bootmgr. See 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: Only show the module if 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 current brightness level of your monitors
- percent No object No Same as percent Thresholds for percentage colors
- ddcciSleep No integer No - Set the sleep times (in ms) when sending DDC/CI requests.
See https://www.ddcutil.com/performance_options/#option-sleep-multiplier for detail
- compact No boolean No - Set if multiple results should be printed in one line
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/brightnessFormat Output format of the module `Brightness`. See Wiki for formatting syntax
1. {percentage}: Screen brightness (percentage num)
2. {name}: Screen name
3. {max}: Maximum brightness value
4. {min}: Minimum brightness value
5. {current}: Current brightness value
6. {percentage-bar}: Screen brightness (percentage bar)
7. {is-builtin}: Is built-in screen
- condition No object No Same as condition Only show the module if 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 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: Thresholds for percentage colors

5.1.2.8.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Brightness > ddcciSleep
Type integer
Required No
Default 10

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

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

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

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

Description: Key of the module One whitespace character ( ) can be used 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 to override the global setting 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: Set the icon to be displayed by display.keyType: "icon"

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

Description: Width of the module key to override the global setting 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: Output color of the module to override the global setting display.color.output

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

Description: Output format of the module Brightness. See 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: Only show the module if 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 Thresholds for percentage colors
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/btrfsFormat Output format of the module `Btrfs`. See Wiki for formatting syntax
1. {name}: Name / Label
2. {uuid}: UUID
3. {devices}: Associated devices
4. {features}: Enabled features
5. {used}: Size used
6. {allocated}: Size allocated
7. {total}: Size total
8. {used-percentage}: Used percentage num
9. {allocated-percentage}: Allocated percentage num
10. {used-percentage-bar}: Used percentage bar
11. {allocated-percentage-bar}: Allocated percentage bar
12. {node-size}: Node size
13. {sector-size}: Sector size
- condition No object No Same as condition Only show the module if 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: Thresholds for percentage colors

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

Description: Key of the module One whitespace character ( ) can be used 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 to override the global setting 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: Set the icon to be displayed by display.keyType: "icon"

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

Description: Width of the module key to override the global setting 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: Output color of the module to override the global setting display.color.output

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

Description: Output format of the module Btrfs. See 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: Only show the module if 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 Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/cameraFormat Output format of the module `Camera`. See Wiki for formatting syntax
1. {name}: Device name
2. {vendor}: Vendor
3. {colorspace}: Color space
4. {id}: Identifier
5. {width}: Width (in px)
6. {height}: Height (in px)
- condition No object No Same as condition Only show the module if 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: Key of the module One whitespace character ( ) can be used 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 to override the global setting 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: Set the icon to be displayed by display.keyType: "icon"

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

Description: Width of the module key to override the global setting 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: Output color of the module to override the global setting display.color.output

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

Description: Output format of the module Camera. See 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: Only show the module if 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 (desktop, laptop, etc)
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/chassisFormat Output format of the module `Chassis`. See Wiki for formatting syntax
1. {type}: Chassis type
2. {vendor}: Chassis vendor
3. {version}: Chassis version
4. {serial}: Chassis serial number
- condition No object No Same as condition Only show the module if 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 (desktop, laptop, etc)

Specific value: "chassis"

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

Description: Key of the module One whitespace character ( ) can be used 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 to override the global setting 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: Set the icon to be displayed by display.keyType: "icon"

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

Description: Width of the module key to override the global setting 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: Output color of the module to override the global setting display.color.output

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

Description: Output format of the module Chassis. See 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: Only show the module if conditions are met

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

Title: CPU

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print CPU name, frequency, etc
- temp No object No Same as temp Detect and display temperature if supported
- showPeCoreCount No boolean No - Detect and display CPU frequency of different core types (eg. Pcore and Ecore) if supported
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/cpuFormat Output format of the module `CPU`. See Wiki for formatting syntax
1. {name}: Name
2. {vendor}: Vendor
3. {cores-physical}: Physical core count
4. {cores-logical}: Logical core count
5. {cores-online}: Online core count
6. {freq-base}: Base frequency (formatted)
7. {freq-max}: Max frequency (formatted)
8. {temperature}: Temperature (formatted)
9. {core-types}: Logical core count grouped by frequency
10. {packages}: Processor package count
11. {march}: X86-64 CPU microarchitecture
- condition No object No Same as condition Only show the module if conditions are met
5.1.2.12.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > type
Type const
Required No

Description: Print CPU name, frequency, etc

Specific value: "cpu"

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

Description: Detect and display temperature if supported

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

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

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

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

5.1.2.12.5. 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 to override the global setting display.color.key

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

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

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

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

5.1.2.12.8. 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: Output color of the module to override the global setting display.color.output

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

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

5.1.2.12.10. 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: Only show the module if conditions are met

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

Title: CPU Cache

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print CPU cache sizes
- percent No object No Same as percent Thresholds for percentage colors
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/cpucacheFormat Output format of the module `CPUCache`. See Wiki for formatting syntax
1. {result}: Separate result
2. {sum}: Sum result
- condition No object No Same as condition Only show the module if conditions are met
5.1.2.13.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Cache > type
Type const
Required No

Description: Print CPU cache sizes

Specific value: "cpucache"

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

Description: Thresholds for percentage colors

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: CPU Usage

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print CPU usage. Costs some time to collect data
- percent No object No Same as percent Thresholds for percentage colors
- separate No boolean No - Display CPU usage per CPU logical core, instead of an average result
- waitTime No integer No - Wait time (in ms). CPU usage = (inUseEnd - inUseStart) / waitTime
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/cpuusageFormat Output format of the module `CPUUsage`. See Wiki for formatting syntax
1. {avg}: CPU usage (percentage num, average)
2. {max}: CPU usage (percentage num, maximum)
3. {max-index}: CPU core index of maximum usage
4. {min}: CPU usage (percentage num, minimum)
5. {min-index}: CPU core index of minimum usage
6. {avg-bar}: CPU usage (percentage bar, average)
7. {max-bar}: CPU usage (percentage bar, maximum)
8. {min-bar}: CPU usage (percentage bar, minimum)
- condition No object No Same as condition Only show the module if conditions are met
5.1.2.14.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > type
Type const
Required No

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

Specific value: "cpuusage"

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

Description: Thresholds for percentage colors

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

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

5.1.2.14.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > waitTime
Type integer
Required No
Default 200

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

Restrictions
Minimum ≥ 1
5.1.2.14.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > CPU Usage > key
Type string
Required No
Same definition as key

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: Colors

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print some colored blocks
- 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
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- condition No object No Same as condition Only show the module if conditions are met
5.1.2.15.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > type
Type const
Required No

Description: Print some colored blocks

Specific value: "colors"

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

Description: Set the symbol to use

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

Description: ███

Specific value: "block"

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

Description: (whitespaces with background)

Specific value: "background"

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

Description:

Specific value: "circle"

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

Description:

Specific value: "diamond"

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

Description:

Specific value: "triangle"

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

Description:

Specific value: "square"

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

Description:

Specific value: "star"

5.1.2.15.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > paddingLeft
Type integer
Required No
Default 0

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

Restrictions
Minimum ≥ 0
5.1.2.15.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block
Type object
Required No
Additional properties Not allowed

Description: Set behavior of block printing

Property Pattern Type Deprecated Definition Title/Description
- width No integer No - Set the block width in spaces
- range No array of integer No - Set the range of colors in the blocks to print
5.1.2.15.4.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block > width
Type integer
Required No
Default 3

Description: Set the block width in spaces

Restrictions
Minimum ≥ 1
5.1.2.15.4.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block > range
Type array of integer
Required No

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

Array restrictions
Min items 2
Max items 2
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
range items -
5.1.2.15.4.2.1. JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > block > range > range items
Type integer
Required No
Restrictions
Minimum ≥ 0
Maximum ≤ 15
5.1.2.15.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Colors > key
Type string
Required No
Same definition as key

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

5.1.2.15.6. 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 to override the global setting display.color.key

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

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

5.1.2.15.8. 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 to override the global setting display.keyWidth

5.1.2.15.9. 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: Only show the module if conditions are met

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

Title: Command

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Running custom shell scripts
- shell No string No - Set the shell program to execute the command text
Default: cmd for Windows, /bin/sh for *nix
- param No string No - Set the parameter used when starting the shell
If set to an empty string, it will be ignored
Default: /c for Windows, -c for *nix
- text No string No - Set the command text to be executed
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/commandFormat Output format of the module `Command`. See Wiki for formatting syntax
1. {result}: Command result
- condition No object No Same as condition Only show the module if conditions are met
5.1.2.16.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Command > type
Type const
Required No

Description: Running custom shell scripts

Specific value: "command"

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

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

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

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

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

Description: Set the command text to be executed

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

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

5.1.2.16.6. 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 to override the global setting display.color.key

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

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

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

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

5.1.2.16.9. 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: Output color of the module to override the global setting display.color.output

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

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

5.1.2.16.11. 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: Only show the module if conditions are met

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

Title: Cursor

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print cursor style name
- percent No object No Same as percent Thresholds for percentage colors
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/cursorFormat Output format of the module `Cursor`. See Wiki for formatting syntax
1. {theme}: Cursor theme
2. {size}: Cursor size
- condition No object No Same as condition Only show the module if conditions are met
5.1.2.17.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Cursor > type
Type const
Required No

Description: Print cursor style name

Specific value: "cursor"

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

Description: Thresholds for percentage colors

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

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

5.1.2.17.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 to override the global setting display.color.key

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

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

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

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

5.1.2.17.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: Output color of the module to override the global setting display.color.output

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

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

5.1.2.17.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: Only show the module if conditions are met

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

Title: Custom

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print a custom string, with or without key
- key No string No - Leave empty not to print the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No - Text to print
- condition No object No Same as condition Only show the module if conditions are met
5.1.2.18.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > type
Type const
Required No

Description: Print a custom string, with or without key

Specific value: "custom"

5.1.2.18.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > key
Type string
Required No

Description: Leave empty not to print the key

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

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

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

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

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

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

5.1.2.18.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: Output color of the module to override the global setting display.color.output

5.1.2.18.7. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > format
Type string
Required No

Description: Text to print

5.1.2.18.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: Only show the module if conditions are met

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

Title: Date Time

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print current date and time
- percent No object No Same as percent Thresholds for percentage colors
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/datetimeFormat Output format of the module `DateTime`. 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
- condition No object No Same as condition Only show the module if conditions are met
5.1.2.19.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > type
Type const
Required No

Description: Print current date and time

Specific value: "datetime"

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

Description: Thresholds for percentage colors

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

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

5.1.2.19.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 to override the global setting display.color.key

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

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

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

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

5.1.2.19.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: Output color of the module to override the global setting display.color.output

5.1.2.19.8. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > format
Type string
Required No
Defined in #/$defs/datetimeFormat

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

5.1.2.19.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: Only show the module if conditions are met

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

Title: Display

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print resolutions, refresh rates, etc
- compactType No Combination No - Set if all displays should be printed in one line
- preciseRefreshRate No boolean No - Set if decimal refresh rates should not be rounded into integers when printing
- order No Combination No - Set the order should be used when printing
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/displayFormat Output format of the module `Display`. 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)
- condition No object No Same as condition Only show the module if conditions are met
5.1.2.20.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > type
Type const
Required No

Description: Print resolutions, refresh rates, etc

Specific value: "display"

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

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

One of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
5.1.2.20.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.20.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.20.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.20.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.20.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.20.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.20.3. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > preciseRefreshRate
Type boolean
Required No
Default false

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

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

Description: Set the order should be used when printing

One of(Option)
item 0
item 1
item 2
item 3
5.1.2.20.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.20.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.20.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.20.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.20.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Display > key
Type string
Required No
Same definition as key

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

5.1.2.20.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 to override the global setting display.color.key

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

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

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

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

5.1.2.20.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: Output color of the module to override the global setting display.color.output

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

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

5.1.2.20.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: Only show the module if conditions are met

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

Title: Disk

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print partitions, space usage, disk type, etc
- folders No 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 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 - Set if regular volume should be printed
- showExternal No boolean No - Set if external volume should be printed
- showHidden No boolean No - Set if hidden volumes should be printed
- showSubvolumes No boolean No - Set if subvolumes should be printed
- showReadOnly No boolean No - Set if read only volumes should be printed
- showUnknown No boolean No - Set if unknown (unable to detect sizes) volumes should be printed
- useAvailable No boolean No - Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes
May be required for macOS to display correct results
- percent No object No Same as percent Thresholds for percentage colors
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/diskFormat Output format of the module `Disk`. 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 Only show the module if conditions are met
5.1.2.21.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > type
Type const
Required No

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

Specific value: "disk"

5.1.2.21.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > folders
Type 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.21.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.21.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.21.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.21.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/efi:/boot/firmware"

Description: A list of folder paths to hide from the disk output

One of(Option)
item 0
item 1
5.1.2.21.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.21.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.21.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.21.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.21.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.21.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.21.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.21.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showRegular
Type boolean
Required No
Default true

Description: Set if regular volume should be printed

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

Description: Set if external volume should be printed

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

Description: Set if hidden volumes should be printed

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

Description: Set if subvolumes should be printed

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

Description: Set if read only volumes should be printed

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

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

5.1.2.21.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.21.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: Thresholds for percentage colors

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

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

5.1.2.21.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 to override the global setting display.color.key

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

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

5.1.2.21.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 to override the global setting display.keyWidth

5.1.2.21.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: Output color of the module to override the global setting display.color.output

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

Description: Output format of the module Disk. See 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.21.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: Only show the module if conditions are met

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

Title: DiskIO

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print physical disk I/O throughput
- namePrefix No string No - Show disks with given name prefix only
- detectTotal No boolean No - Detect total bytes instead of current rate
- waitTime No integer No - Wait time (in ms). Disk I/O = (totalBytesEnd - totalBytesStart) / waitTime
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/diskioFormat Output format of the module `DiskIO`. 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 Only show the module if conditions are met
5.1.2.22.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > type
Type const
Required No

Description: Print physical disk I/O throughput

Specific value: "diskio"

5.1.2.22.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > namePrefix
Type string
Required No

Description: Show disks with given name prefix only

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

Description: Detect total bytes instead of current rate

5.1.2.22.4. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > waitTime
Type integer
Required No
Default 200

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

Restrictions
Minimum ≥ 1
5.1.2.22.5. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > key
Type string
Required No
Same definition as key

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

5.1.2.22.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 to override the global setting display.color.key

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

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

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

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

5.1.2.22.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: Output color of the module to override the global setting display.color.output

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

Description: Output format of the module DiskIO. See 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.22.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: Only show the module if conditions are met

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

Title: Desktop Environment

Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print desktop environment name
- slowVersionDetection No boolean No - Set if DE version should be detected with slow operations.
Should be unnecessary for most cases.
This is only used as a fallback method. Please file a bug report if you encounter any issues.
- key No string No Same as key Key of the module
One whitespace character (` `) can be used to hide the key
- keyColor No object No Same as keyColor Color of the module key to override the global setting `display.color.key`
- keyIcon No string No Same as keyIcon Set the icon to be displayed by `display.keyType: "icon"`
- keyWidth No integer No Same as keyWidth Width of the module key to override the global setting `display.keyWidth`
- outputColor No object No Same as outputColor Output color of the module to override the global setting `display.color.output`
- format No string No In #/$defs/deFormat Output format of the module `DE`. 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 Only show the module if conditions are met
5.1.2.23.1. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > type
Type const
Required No

Description: Print desktop environment name

Specific value: "de"

5.1.2.23.2. Property JSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > slowVersionDetection
Type boolean
Required No
Default false

Description: Set if DE version should be detected with slow operations. Should be unnecessary for most cases. This is only used as a fallback method. Please file a bug report if you encounter any issues.

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

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

5.1.2.23.4. 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 to override the global setting display.color.key

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

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

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

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

5.1.2.23.7. 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: Output color of the module to override the global setting display.color.output

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

Description: Output format of t

Clone this wiki locally