Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

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

Provide feedback

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

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Json Schema modules

李通洲 edited this pageOct 11, 2025 ·1 revision

5. PropertyJSON config > modules

Typearray
RequiredNo

Description: Fastfetch modules to run

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

5.1. JSON config > modules > modules items

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

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

Typeenum (of string)
RequiredNo

Description: Run module with default configurations

Must be one of:

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

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

Typecombining
RequiredNo
Additional propertiesAny type allowed

Description: Run module with custom configurations

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

Title: Break

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

Description: Print a empty line

Specific value:"break"

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

Description: Only show the module if conditions are met

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

Description: System name to match

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

Must be one of:

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

Description: Array of system names to match

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

Description: Null to disable this condition

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

Description: System name to not match

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

Description: Array of system names to not match

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

Description: Null to disable this condition

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

Description: Architecture to match

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

Must be one of:

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

Description: Array of architectures to match

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

Description: Null to disable this condition

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

Description: Architecture to not match

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

Description: Array of architectures to not match

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

Description: Null to disable this condition

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

Description: Whether the module succeeded in the last run

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

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

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

Description: Null to disable this condition

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

Title: Battery

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

Description: Print battery capacity, status, etc

Specific value:"battery"

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

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

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

Description: Detect and display temperature if supported

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

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

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

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

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

Description: Thresholds for percentage colors

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

Description: Values less than green will be shown in green

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

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

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

Description: Set the percentage output type

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: BIOS

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

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

Specific value:"bios"

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: Bluetooth

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

Description: List (connected) bluetooth devices

Specific value:"bluetooth"

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

Description: Set if disconnected bluetooth devices should be printed

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

Description: Thresholds for percentage colors

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: Bluetooth Radio

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

Description: List bluetooth radios width supported version and vendor

Specific value:"bluetoothradio"

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: Board

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

Description: Print motherboard name and other info

Specific value:"board"

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: Boot Manager

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

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

Specific value:"bootmgr"

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: Brightness

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

Description: Print current brightness level of your monitors

Specific value:"brightness"

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

Description: Thresholds for percentage colors

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: BTRFS

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

Description: Print Linux BTRFS volumes

Specific value:"btrfs"

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

Description: Thresholds for percentage colors

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: Camera

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

Description: Print available cameras

Specific value:"camera"

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: Chassis

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

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

Specific value:"chassis"

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: CPU

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

Description: Print CPU name, frequency, etc

Specific value:"cpu"

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

Description: Detect and display temperature if supported

5.1.2.12.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > CPU > showPeCoreCount
Typeboolean
RequiredNo
Defaultfalse

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: CPU Cache

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

Description: Print CPU cache sizes

Specific value:"cpucache"

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

Description: Thresholds for percentage colors

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: CPU Usage

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

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

Specific value:"cpuusage"

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

Description: Thresholds for percentage colors

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: Colors

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

Description: Print some colored blocks

Specific value:"colors"

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

Description: Set the symbol to use

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

Description: ███

Specific value:"block"

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

Description: (whitespaces with background)

Specific value:"background"

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

Description:

Specific value:"circle"

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

Description:

Specific value:"diamond"

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

Description:

Specific value:"triangle"

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

Description:

Specific value:"square"

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

Description:

Specific value:"star"

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

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

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

Description: Set behavior of block printing

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

Description: Set the block width in spaces

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: Command

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

Description: Running custom shell scripts

Specific value:"command"

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

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

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

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

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

Description: Set the command text to be executed

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

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

Title: Cursor

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

Description: Print cursor style name

Specific value:"cursor"

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

Description: Thresholds for percentage colors

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

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

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

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

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

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

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

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

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

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

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

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

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

Description: Only show the module if conditions are met

5.1.2.18. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Custom

Title: Custom

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print a custom string, with or without key
-keyNostringNo-Leave empty not to print the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNo-Text to print
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.18.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > type
Typeconst
RequiredNo

Description: Print a custom string, with or without key

Specific value:"custom"

5.1.2.18.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > key
Typestring
RequiredNo

Description: Leave empty not to print the key

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

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

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

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

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

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

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

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

5.1.2.18.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Custom > format
Typestring
RequiredNo

Description: Text to print

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

Description: Only show the module if conditions are met

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

Title: Date Time

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print current date and time
-percentNoobjectNoSame aspercentThresholds for percentage colors
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/datetimeFormatOutput 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
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.19.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > type
Typeconst
RequiredNo

Description: Print current date and time

Specific value:"datetime"

5.1.2.19.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > percent
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition aspercent

Description: Thresholds for percentage colors

5.1.2.19.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > key
Typestring
RequiredNo
Same definition askey

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

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

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

5.1.2.19.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

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

5.1.2.19.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

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

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

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

5.1.2.19.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > format
Typestring
RequiredNo
Defined in#/$defs/datetimeFormat

Description: Output format of the moduleDateTime. See Wiki for formatting syntax1. {year}: Year2. {year-short}: Last two digits of year3. {month}: Month4. {month-pretty}: Month with leading zero5. {month-name}: Month name6. {month-name-short}: Month name short7. {week}: Week number on year8. {weekday}: Weekday9. {weekday-short}: Weekday short10. {day-in-year}: Day in year11. {day-in-month}: Day in month12. {day-in-week}: Day in week13. {hour}: Hour14. {hour-pretty}: Hour with leading zero15. {hour-12}: Hour 12h format16. {hour-12-pretty}: Hour 12h format with leading zero17. {minute}: Minute18. {minute-pretty}: Minute with leading zero19. {second}: Second20. {second-pretty}: Second with leading zero21. {offset-from-utc}: Offset from UTC in the ISO 8601 format22. {timezone-name}: Locale-dependent timezone name or abbreviation23. {day-pretty}: Day in month with leading zero

5.1.2.19.9. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Date Time > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.20. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display

Title: Display

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print resolutions, refresh rates, etc
-compactTypeNoCombinationNo-Set if all displays should be printed in one line
-preciseRefreshRateNobooleanNo-Set if decimal refresh rates should not be rounded into integers when printing
-orderNoCombinationNo-Set the order should be used when printing
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/displayFormatOutput 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)
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.20.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display > type
Typeconst
RequiredNo

Description: Print resolutions, refresh rates, etc

Specific value:"display"

5.1.2.20.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display > compactType
Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

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. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display > compactType > oneOf > item 0
Typeconst
RequiredNo

Description: Disable compact mode

Specific value:null

5.1.2.20.2.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display > compactType > oneOf > item 1
Typeconst
RequiredNo

Description: Disable compact mode (kept for compatibility)

Specific value:"none"

5.1.2.20.2.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display > compactType > oneOf > item 2
Typeconst
RequiredNo

Description: Print original resolutions

Specific value:"original"

5.1.2.20.2.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display > compactType > oneOf > item 3
Typeconst
RequiredNo

Description: Print scaled resolutions

Specific value:"scaled"

5.1.2.20.2.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display > compactType > oneOf > item 4
Typeconst
RequiredNo

Description: Print original resolutions with refresh rates

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

5.1.2.20.2.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display > compactType > oneOf > item 5
Typeconst
RequiredNo

Description: Print scaled resolutions with refresh rates

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

5.1.2.20.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display > preciseRefreshRate
Typeboolean
RequiredNo
Defaultfalse

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

5.1.2.20.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display > order
Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

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. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display > order > oneOf > item 0
Typeconst
RequiredNo

Description: Use the default order

Specific value:null

5.1.2.20.4.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display > order > oneOf > item 1
Typeconst
RequiredNo

Description: Use the detected order (kept for compatibility)

Specific value:"none"

5.1.2.20.4.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display > order > oneOf > item 2
Typeconst
RequiredNo

Description: Sort by display name in ascending order

Specific value:"asc"

5.1.2.20.4.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display > order > oneOf > item 3
Typeconst
RequiredNo

Description: Sort by display name in descending order

Specific value:"desc"

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

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

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

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

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

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

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

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

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

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

5.1.2.20.10. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display > format
Typestring
RequiredNo
Defined in#/$defs/displayFormat

Description: Output format of the moduleDisplay. See Wiki for formatting syntax1. {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 name7. {type}: Screen type (Built-in or External)8. {rotation}: Screen rotation (in degrees)9. {is-primary}: True if being the primary screen10. {physical-width}: Screen physical width (in millimeters)11. {physical-height}: Screen physical height (in millimeters)12. {inch}: Physical diagonal length in inches13. {ppi}: Pixels per inch (PPI)14. {bit-depth}: Bits per color channel15. {hdr-enabled}: True if high dynamic range (HDR) mode is enabled16. {manufacture-year}: Year of manufacturing17. {manufacture-week}: Nth week of manufacturing in the year18. {serial}: Serial number19. {platform-api}: The platform API used when detecting the display20. {hdr-compatible}: True if the display is HDR compatible21. {scale-factor}: HiDPI scale factor22. {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. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Display > condition
Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition ascondition

Description: Only show the module if conditions are met

5.1.2.21. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk

Title: Disk

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print partitions, space usage, disk type, etc
-foldersNoCombinationNo-A list of folder paths for the disk output
Default: auto detection using mount-points
This option overrides other `show*` options
-hideFoldersNoCombinationNo-A list of folder paths to hide from the disk output
-hideFSNoCombinationNo-A list of file systems to hide from the disk output
-showRegularNobooleanNo-Set if regular volume should be printed
-showExternalNobooleanNo-Set if external volume should be printed
-showHiddenNobooleanNo-Set if hidden volumes should be printed
-showSubvolumesNobooleanNo-Set if subvolumes should be printed
-showReadOnlyNobooleanNo-Set if read only volumes should be printed
-showUnknownNobooleanNo-Set if unknown (unable to detect sizes) volumes should be printed
-useAvailableNobooleanNo-Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes
May be required for macOS to display correct results
-percentNoobjectNoSame aspercentThresholds for percentage colors
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/diskFormatOutput 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
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.21.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > type
Typeconst
RequiredNo

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

Specific value:"disk"

5.1.2.21.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > folders
Typecombining
RequiredNo
Additional propertiesAny type allowed

Description: A list of folder paths for the disk outputDefault: auto detection using mount-pointsThis option overrides othershow* options

One of(Option)
item 0
item 1
5.1.2.21.2.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > folders > oneOf > item 0
Typestring
RequiredNo
Default"/"

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

5.1.2.21.2.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > folders > oneOf > item 1
Typearray of string
RequiredNo

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

Array restrictions
Min items1
Max itemsN/A
Items unicityTrue
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
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
Typestring
RequiredNo
5.1.2.21.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > hideFolders
Typecombining
RequiredNo
Additional propertiesAny 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. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > hideFolders > oneOf > item 0
Typestring
RequiredNo

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

5.1.2.21.3.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > hideFolders > oneOf > item 1
Typearray of string
RequiredNo

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

Array restrictions
Min items1
Max itemsN/A
Items unicityTrue
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
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
Typestring
RequiredNo
5.1.2.21.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > hideFS
Typecombining
RequiredNo
Additional propertiesAny 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. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > hideFS > oneOf > item 0
Typestring
RequiredNo

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

5.1.2.21.4.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > hideFS > oneOf > item 1
Typearray of string
RequiredNo

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

Array restrictions
Min items1
Max itemsN/A
Items unicityTrue
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
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
Typestring
RequiredNo
5.1.2.21.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showRegular
Typeboolean
RequiredNo
Defaulttrue

Description: Set if regular volume should be printed

5.1.2.21.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showExternal
Typeboolean
RequiredNo
Defaulttrue

Description: Set if external volume should be printed

5.1.2.21.7. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showHidden
Typeboolean
RequiredNo
Defaultfalse

Description: Set if hidden volumes should be printed

5.1.2.21.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showSubvolumes
Typeboolean
RequiredNo
Defaultfalse

Description: Set if subvolumes should be printed

5.1.2.21.9. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showReadOnly
Typeboolean
RequiredNo
Defaultfalse

Description: Set if read only volumes should be printed

5.1.2.21.10. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > showUnknown
Typeboolean
RequiredNo
Defaultfalse

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

5.1.2.21.11. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > useAvailable
Typeboolean
RequiredNo
Defaultfalse

Description: Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytesMay be required for macOS to display correct results

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

Description: Thresholds for percentage colors

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

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

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

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

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

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

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

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

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

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

5.1.2.21.18. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Disk > format
Typestring
RequiredNo
Defined in#/$defs/diskFormat

Description: Output format of the moduleDisk. See Wiki for formatting syntax1. {size-used}: Size used2. {size-total}: Size total3. {size-percentage}: Size percentage num4. {files-used}: Files used5. {files-total}: Files total6. {files-percentage}: Files percentage num7. {is-external}: True if external volume8. {is-hidden}: True if hidden volume9. {filesystem}: Filesystem10. {name}: Label / name11. {is-readonly}: True if read-only12. {create-time}: Create time in local timezone13. {size-percentage-bar}: Size percentage bar14. {files-percentage-bar}: Files percentage bar15. {days}: Days after creation16. {hours}: Hours after creation17. {minutes}: Minutes after creation18. {seconds}: Seconds after creation19. {milliseconds}: Milliseconds after creation20. {mountpoint}: Mount point / drive letter21. {mount-from}: Mount from (device path)22. {years}: Years integer after creation23. {days-of-year}: Days of year after creation24. {years-fraction}: Years fraction after creation25. {size-free}: Size free26. {size-available}: Size available

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

Description: Only show the module if conditions are met

5.1.2.22. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO

Title: DiskIO

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print physical disk I/O throughput
-namePrefixNostringNo-Show disks with given name prefix only
-detectTotalNobooleanNo-Detect total bytes instead of current rate
-waitTimeNointegerNo-Wait time (in ms). Disk I/O = (totalBytesEnd - totalBytesStart) / waitTime
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/diskioFormatOutput 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
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.22.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > type
Typeconst
RequiredNo

Description: Print physical disk I/O throughput

Specific value:"diskio"

5.1.2.22.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > namePrefix
Typestring
RequiredNo

Description: Show disks with given name prefix only

5.1.2.22.3. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > detectTotal
Typeboolean
RequiredNo
Defaultfalse

Description: Detect total bytes instead of current rate

5.1.2.22.4. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > waitTime
Typeinteger
RequiredNo
Default200

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

Restrictions
Minimum≥ 1
5.1.2.22.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > key
Typestring
RequiredNo
Same definition askey

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

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

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

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

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

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

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

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

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

5.1.2.22.10. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > DiskIO > format
Typestring
RequiredNo
Defined in#/$defs/diskioFormat

Description: Output format of the moduleDiskIO. See Wiki for formatting syntax1. {size-read}: Size of data read [per second] (formatted)2. {size-written}: Size of data written [per second] (formatted)3. {name}: Device name4. {dev-path}: Device raw file path5. {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 reads8. {write-count}: Number of writes

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

Description: Only show the module if conditions are met

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

Title: Desktop Environment

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
-typeNoconstNo-Print desktop environment name
-slowVersionDetectionNobooleanNo-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.
-keyNostringNoSame askeyKey of the module
One whitespace character (` `) can be used to hide the key
-keyColorNoobjectNoSame askeyColorColor of the module key to override the global setting `display.color.key`
-keyIconNostringNoSame askeyIconSet the icon to be displayed by `display.keyType: "icon"`
-keyWidthNointegerNoSame askeyWidthWidth of the module key to override the global setting `display.keyWidth`
-outputColorNoobjectNoSame asoutputColorOutput color of the module to override the global setting `display.color.output`
-formatNostringNoIn #/$defs/deFormatOutput 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
-conditionNoobjectNoSame asconditionOnly show the module if conditions are met
5.1.2.23.1. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > type
Typeconst
RequiredNo

Description: Print desktop environment name

Specific value:"de"

5.1.2.23.2. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > slowVersionDetection
Typeboolean
RequiredNo
Defaultfalse

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. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > key
Typestring
RequiredNo
Same definition askey

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

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

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

5.1.2.23.5. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > keyIcon
Typestring
RequiredNo
Same definition askeyIcon

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

5.1.2.23.6. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > keyWidth
Typeinteger
RequiredNo
Same definition askeyWidth

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

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

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

5.1.2.23.8. PropertyJSON config > modules > modules items > anyOf > item 1 > oneOf > Desktop Environment > format
Typestring
RequiredNo
Defined in#/$defs/deFormat

Description: Output format of t

Clone this wiki locally


[8]ページ先頭

©2009-2025 Movatter.jp