-
-
Notifications
You must be signed in to change notification settings - Fork 349
Json Schema
- 1. Property
JSON config > $schema
-
2. Property
JSON config > logo
- 2.1. Property
JSON config > logo > oneOf > Disable logo
- 2.2. Property
JSON config > logo > oneOf > Set the source file of the logo
-
2.3. Property
JSON config > logo > oneOf > Fastfetch logo configurations
- 2.3.1. Property
JSON config > logo > oneOf > Fastfetch logo configurations > type
- 2.3.2. Property
JSON config > logo > oneOf > Fastfetch logo configurations > source
-
2.3.3. Property
JSON config > logo > oneOf > Fastfetch logo configurations > color
- 2.3.3.1. Property
JSON config > logo > oneOf > Fastfetch logo configurations > color > 1
- 2.3.3.2. Property
JSON config > logo > oneOf > Fastfetch logo configurations > color > 2
- 2.3.3.3. Property
JSON config > logo > oneOf > Fastfetch logo configurations > color > 3
- 2.3.3.4. Property
JSON config > logo > oneOf > Fastfetch logo configurations > color > 4
- 2.3.3.5. Property
JSON config > logo > oneOf > Fastfetch logo configurations > color > 5
- 2.3.3.6. Property
JSON config > logo > oneOf > Fastfetch logo configurations > color > 6
- 2.3.3.7. Property
JSON config > logo > oneOf > Fastfetch logo configurations > color > 7
- 2.3.3.8. Property
JSON config > logo > oneOf > Fastfetch logo configurations > color > 8
- 2.3.3.9. Property
JSON config > logo > oneOf > Fastfetch logo configurations > color > 9
- 2.3.3.1. Property
- 2.3.4. Property
JSON config > logo > oneOf > Fastfetch logo configurations > width
- 2.3.5. Property
JSON config > logo > oneOf > Fastfetch logo configurations > height
-
2.3.6. Property
JSON config > logo > oneOf > Fastfetch logo configurations > padding
- 2.3.7. Property
JSON config > logo > oneOf > Fastfetch logo configurations > printRemaining
- 2.3.8. Property
JSON config > logo > oneOf > Fastfetch logo configurations > preserveAspectRadio
-
2.3.9. Property
JSON config > logo > oneOf > Fastfetch logo configurations > chafa
- 2.3.9.1. Property
JSON config > logo > oneOf > Fastfetch logo configurations > chafa > fgOnly
- 2.3.9.2. Property
JSON config > logo > oneOf > Fastfetch logo configurations > chafa > symbols
- 2.3.9.3. Property
JSON config > logo > oneOf > Fastfetch logo configurations > chafa > canvasMode
- 2.3.9.4. Property
JSON config > logo > oneOf > Fastfetch logo configurations > chafa > colorSpace
- 2.3.9.5. Property
JSON config > logo > oneOf > Fastfetch logo configurations > chafa > ditherMode
- 2.3.9.1. Property
- 2.3.1. Property
- 2.1. Property
-
3. Property
JSON config > general
- 3.1. Property
JSON config > general > allowSlowOperations
- 3.2. Property
JSON config > general > multithreading
- 3.3. Property
JSON config > general > stat
- 3.4. Property
JSON config > general > escapeBedrock
- 3.5. Property
JSON config > general > pipe
- 3.6. Property
JSON config > general > playerName
- 3.7. Property
JSON config > general > osFile
- 3.8. Property
JSON config > general > wmiTimeout
- 3.1. Property
-
4. Property
JSON config > display
- 4.1. Property
JSON config > display > showErrors
- 4.2. Property
JSON config > display > disableLinewrap
- 4.3. Property
JSON config > display > hideCursor
- 4.4. Property
JSON config > display > separator
-
4.5. Property
JSON config > display > color
- 4.6. Property
JSON config > display > binaryPrefix
- 4.7. Property
JSON config > display > sizeNdigits
- 4.8. Property
JSON config > display > sizeMaxPrefix
- 4.9. Property
JSON config > display > percentType
- 4.10. Property
JSON config > display > noBuffer
- 4.1. Property
-
5. Property
JSON config > library
- 5.1. Property
JSON config > library > pci
- 5.2. Property
JSON config > library > vulkan
- 5.3. Property
JSON config > library > freetype
- 5.4. Property
JSON config > library > wayland
- 5.5. Property
JSON config > library > xcbRandr
- 5.6. Property
JSON config > library > xcb
- 5.7. Property
JSON config > library > xrandr
- 5.8. Property
JSON config > library > x11
- 5.9. Property
JSON config > library > gio
- 5.10. Property
JSON config > library > dconf
- 5.11. Property
JSON config > library > dbus
- 5.12. Property
JSON config > library > xfconf
- 5.13. Property
JSON config > library > sqlite3
- 5.14. Property
JSON config > library > rpm
- 5.15. Property
JSON config > library > imagemagick
- 5.16. Property
JSON config > library > z
- 5.17. Property
JSON config > library > chafa
- 5.18. Property
JSON config > library > egl
- 5.19. Property
JSON config > library > glx
- 5.20. Property
JSON config > library > osmesa
- 5.21. Property
JSON config > library > opencl
- 5.22. Property
JSON config > library > pulse
- 5.23. Property
JSON config > library > nm
- 5.24. Property
JSON config > library > ddcutil
- 5.1. Property
-
6. Property
JSON config > modules
-
6.1. JSON config > modules > modules items
- 6.1.1. Property
JSON config > modules > modules items > anyOf > Run module with default configurations
-
6.1.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations
-
6.1.2.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Break
-
6.1.2.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties
- 6.1.2.2.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type
- 6.1.2.2.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > key
- 6.1.2.2.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > keyColor
- 6.1.2.2.4. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > format
- 6.1.2.2.1. Property
-
6.1.2.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Battery
- 6.1.2.3.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Battery > type
- 6.1.2.3.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Battery > dir
- 6.1.2.3.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Battery > temp
- 6.1.2.3.4. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Battery > key
- 6.1.2.3.5. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Battery > keyColor
- 6.1.2.3.6. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Battery > format
- 6.1.2.3.1. Property
-
6.1.2.4. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Bluetooth
- 6.1.2.4.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Bluetooth > type
- 6.1.2.4.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Bluetooth > showDisconnected
- 6.1.2.4.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Bluetooth > key
- 6.1.2.4.4. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Bluetooth > keyColor
- 6.1.2.4.5. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Bluetooth > format
- 6.1.2.4.1. Property
-
6.1.2.5. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > CPU
- 6.1.2.5.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > CPU > type
- 6.1.2.5.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > CPU > temp
- 6.1.2.5.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > CPU > key
- 6.1.2.5.4. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > CPU > keyColor
- 6.1.2.5.5. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > CPU > format
- 6.1.2.5.1. Property
-
6.1.2.6. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Colors
- 6.1.2.6.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Colors > type
- 6.1.2.6.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Colors > symbol
- 6.1.2.6.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Colors > paddingLeft
- 6.1.2.6.1. Property
-
6.1.2.7. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Command
- 6.1.2.7.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Command > type
- 6.1.2.7.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Command > shell
- 6.1.2.7.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Command > text
- 6.1.2.7.4. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Command > key
- 6.1.2.7.5. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Command > keyColor
- 6.1.2.7.6. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Command > format
- 6.1.2.7.1. Property
-
6.1.2.8. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Custom
- 6.1.2.8.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Custom > type
- 6.1.2.8.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Custom > key
- 6.1.2.8.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Custom > keyColor
- 6.1.2.8.4. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Custom > format
- 6.1.2.8.1. Property
-
6.1.2.9. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Display
- 6.1.2.9.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Display > type
- 6.1.2.9.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Display > compactType
- 6.1.2.9.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Display > preciseRefreshRate
- 6.1.2.9.4. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Display > key
- 6.1.2.9.5. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Display > keyColor
- 6.1.2.9.6. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Display > format
- 6.1.2.9.1. Property
-
6.1.2.10. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk
- 6.1.2.10.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > type
- 6.1.2.10.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > folders
- 6.1.2.10.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > showExternal
- 6.1.2.10.4. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > showHidden
- 6.1.2.10.5. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > showSubvolumes
- 6.1.2.10.6. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > showUnknown
- 6.1.2.10.7. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > key
- 6.1.2.10.8. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > keyColor
- 6.1.2.10.9. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > format
- 6.1.2.10.1. Property
-
6.1.2.11. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU
- 6.1.2.11.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU > type
- 6.1.2.11.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU > temp
- 6.1.2.11.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU > forceVulkan
- 6.1.2.11.4. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU > hideType
- 6.1.2.11.5. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU > key
- 6.1.2.11.6. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU > keyColor
- 6.1.2.11.7. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU > format
- 6.1.2.11.1. Property
-
6.1.2.12. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP
- 6.1.2.12.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > type
- 6.1.2.12.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > showIpv4
- 6.1.2.12.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > showIpv6
- 6.1.2.12.4. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > showMac
- 6.1.2.12.5. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > showLoop
- 6.1.2.12.6. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > compact
- 6.1.2.12.7. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > namePrefix
- 6.1.2.12.8. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > showDefaultRouteOnly
- 6.1.2.12.9. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > key
- 6.1.2.12.10. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > keyColor
- 6.1.2.12.11. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > format
- 6.1.2.12.1. Property
-
6.1.2.13. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > OpenGL
- 6.1.2.13.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > OpenGL > type
- 6.1.2.13.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > OpenGL > library
- 6.1.2.13.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > OpenGL > key
- 6.1.2.13.4. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > OpenGL > keyColor
- 6.1.2.13.5. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > OpenGL > format
- 6.1.2.13.1. Property
-
6.1.2.14. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Public IP
- 6.1.2.14.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Public IP > type
- 6.1.2.14.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Public IP > url
- 6.1.2.14.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Public IP > timeout
- 6.1.2.14.4. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Public IP > key
- 6.1.2.14.5. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Public IP > keyColor
- 6.1.2.14.6. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Public IP > format
- 6.1.2.14.1. Property
-
6.1.2.15. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Separator
-
6.1.2.16. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Sound
- 6.1.2.16.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Sound > type
- 6.1.2.16.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Sound > soundType
- 6.1.2.16.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Sound > key
- 6.1.2.16.4. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Sound > keyColor
- 6.1.2.16.5. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Sound > format
- 6.1.2.16.1. Property
-
6.1.2.17. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title
- 6.1.2.17.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > type
- 6.1.2.17.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > fqdn
-
6.1.2.17.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > color
- 6.1.2.17.3.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > color > user
- 6.1.2.17.3.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > color > at
- 6.1.2.17.3.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > color > host
- 6.1.2.17.3.1. Property
- 6.1.2.17.4. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > key
- 6.1.2.17.5. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > keyColor
- 6.1.2.17.6. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > format
- 6.1.2.17.1. Property
-
6.1.2.18. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather
- 6.1.2.18.1. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather > type
- 6.1.2.18.2. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather > location
- 6.1.2.18.3. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather > timeout
- 6.1.2.18.4. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather > outputFormat
- 6.1.2.18.5. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather > key
- 6.1.2.18.6. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather > keyColor
- 6.1.2.18.7. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather > format
- 6.1.2.18.1. Property
- 6.1.2.19. Property
JSON config > modules > modules items > anyOf > Run module with custom configurations > type
-
6.1.2.1. Property
- 6.1.1. Property
-
6.1. JSON config > modules > modules items
Title: JSON config
Type | object |
Required | No |
Additional properties | [Not allowed] |
Description: JSON config file for fastfetch. Usually be ~/.config/fastfetch.jsonc
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- $schema | No | string | No | - | JSON schema URL, for JSON validation and IDE intelligence |
- logo | No | Combination | No | - | - |
- general | No | object | No | - | Fastfetch general configurations |
- display | No | object | No | - | Configure how things to be displayed |
- library | No | object | No | - | Set the path of a library to load |
- modules | No | array | No | - | Fastfetch modules to run |
Title: JSON schema URL, for JSON validation and IDE intelligence
Type | string |
Required | No |
Format | uri |
Default | "https://github.com/fastfetch-cli/fastfetch/raw/dev/doc/json_schema.json" |
Type | combining |
Required | No |
Additional properties | [Any type: allowed] |
One of(Option) |
---|
Disable logo |
Set the source file of the logo |
Fastfetch logo configurations |
Title: Disable logo
Type | null |
Required | No |
Title: Set the source file of the logo
Type | string |
Required | No |
Title: Fastfetch logo configurations
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | enum (of string) | No | - | Set the type of the logo given |
- source | No | string | No | - | Set the source file of the logo |
- color | No | object | No | - | Overwrite a color in the logo |
- width | No | integer | No | - | Set the width of the logo (in characters). Required for iTerm image protocol |
- height | No | integer | No | - | Set the height of the logo (in characters). Required for iTerm image protocol |
- padding | No | object | No | - | Set the padding of the logo |
- printRemaining | No | boolean | No | - | Whether to print the remaining logo, if it has more lines than modules to display |
- preserveAspectRadio | No | boolean | No | - | Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol |
- chafa | No | object | No | - | Chafa configuration. See chafa document for details |
Title: Set the type of the logo given
Type | enum (of string) |
Required | No |
Default | "auto" |
Must be one of:
- "auto"
- "builtin"
- "small"
- "file"
- "file-raw"
- "data"
- "data-raw"
- "sixel"
- "kitty"
- "kitty-direct"
- "iterm"
- "chafa"
- "raw"
- "none"
Title: Set the source file of the logo
Type | string |
Required | No |
Title: Overwrite a color in the logo
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- 1 | No | enum (of string) | No | Same as defs_keyColor | Color 1 |
- 2 | No | enum (of string) | No | Same as defs_keyColor | Color 2 |
- 3 | No | enum (of string) | No | Same as defs_keyColor | Color 3 |
- 4 | No | enum (of string) | No | Same as defs_keyColor | Color 4 |
- 5 | No | enum (of string) | No | Same as defs_keyColor | Color 5 |
- 6 | No | enum (of string) | No | Same as defs_keyColor | Color 6 |
- 7 | No | enum (of string) | No | Same as defs_keyColor | Color 7 |
- 8 | No | enum (of string) | No | Same as defs_keyColor | Color 8 |
- 9 | No | enum (of string) | No | Same as defs_keyColor | Color 9 |
Title: Color 1
Type | enum (of string) |
Required | No |
Same definition as | defs_keyColor |
Title: Color 2
Type | enum (of string) |
Required | No |
Same definition as | defs_keyColor |
Title: Color 3
Type | enum (of string) |
Required | No |
Same definition as | defs_keyColor |
Title: Color 4
Type | enum (of string) |
Required | No |
Same definition as | defs_keyColor |
Title: Color 5
Type | enum (of string) |
Required | No |
Same definition as | defs_keyColor |
Title: Color 6
Type | enum (of string) |
Required | No |
Same definition as | defs_keyColor |
Title: Color 7
Type | enum (of string) |
Required | No |
Same definition as | defs_keyColor |
Title: Color 8
Type | enum (of string) |
Required | No |
Same definition as | defs_keyColor |
Title: Color 9
Type | enum (of string) |
Required | No |
Same definition as | defs_keyColor |
Title: Set the width of the logo (in characters). Required for iTerm image protocol
Type | integer |
Required | No |
Restrictions | |
---|---|
Minimum | ≥ 1 |
Title: Set the height of the logo (in characters). Required for iTerm image protocol
Type | integer |
Required | No |
Restrictions | |
---|---|
Minimum | ≥ 1 |
Title: Set the padding of the logo
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- top | No | integer | No | - | Set the top padding of the logo |
- left | No | integer | No | - | Set the left padding of the logo |
- right | No | integer | No | - | Set the right padding of the logo |
Title: Set the top padding of the logo
Type | integer |
Required | No |
Restrictions | |
---|---|
Minimum | ≥ 0 |
Title: Set the left padding of the logo
Type | integer |
Required | No |
Restrictions | |
---|---|
Minimum | ≥ 0 |
Title: Set the right padding of the logo
Type | integer |
Required | No |
Restrictions | |
---|---|
Minimum | ≥ 0 |
Title: Whether to print the remaining logo, if it has more lines than modules to display
Type | boolean |
Required | No |
Default | false |
Title: Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol
Type | boolean |
Required | No |
Default | false |
Title: Chafa configuration. See chafa document for details
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- fgOnly | No | boolean | No | - | Produce character-cell output using foreground colors only |
- symbols | No | string | No | - | Specify character symbols to employ in final output |
- canvasMode | No | enum (of string) | No | - | Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode. |
- colorSpace | No | enum (of string) | No | - | Set color space used for quantization. This value maps the value of enum ChafaColorSpace. |
- ditherMode | No | enum (of string) | No | - | Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode. |
Title: Produce character-cell output using foreground colors only
Type | boolean |
Required | No |
Default | false |
Title: Specify character symbols to employ in final output
Type | string |
Required | No |
Title: Determine how colors are used in the output. This value maps the value of enum ChafaCanvasMode.
Type | enum (of string) |
Required | No |
Must be one of:
- "TRUECOLOR"
- "INDEXED_256"
- "INDEXED_240"
- "INDEXED_16"
- "FGBG_BGFG"
- "FGBG"
- "INDEXED_8"
- "INDEXED_16_8"
Title: Set color space used for quantization. This value maps the value of enum ChafaColorSpace.
Type | enum (of string) |
Required | No |
Must be one of:
- "RGB"
- "DIN99D"
Title: Set output dither mode (No effect with 24-bit color). This value maps the value of enum ChafaDitherMode.
Type | enum (of string) |
Required | No |
Must be one of:
- "NONE"
- "ORDERED"
- "DIFFUSION"
Title: Fastfetch general configurations
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- allowSlowOperations | No | boolean | No | - | Allow operations that can be very slow for more detailed output |
- multithreading | No | boolean | No | - | Use multiple threads to detect values |
- stat | No | boolean | No | - | Show time usage (in ms) for individual modules |
- escapeBedrock | No | boolean | No | - | On Bedrock Linux, whether to escape the bedrock jail |
- pipe | No | boolean | No | - | Whether to enable pipe mode (disable logo and all escape sequences) |
- playerName | No | string | No | - | The name of the player to use for module Media and Player. Linux only |
- osFile | No | string | No | - | Set the path to the file containing OS information. Linux only |
- wmiTimeout | No | integer | No | - | Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only |
Title: Allow operations that can be very slow for more detailed output
Type | boolean |
Required | No |
Default | false |
Title: Use multiple threads to detect values
Type | boolean |
Required | No |
Default | true |
Title: Show time usage (in ms) for individual modules
Type | boolean |
Required | No |
Default | false |
Title: On Bedrock Linux, whether to escape the bedrock jail
Type | boolean |
Required | No |
Default | true |
Title: Whether to enable pipe mode (disable logo and all escape sequences)
Type | boolean |
Required | No |
Default | false |
Title: The name of the player to use for module Media and Player. Linux only
Type | string |
Required | No |
Title: Set the path to the file containing OS information. Linux only
Type | string |
Required | No |
Title: Set the timeout (ms) for WMI queries, -1
for no timeout. Windows only
Type | integer |
Required | No |
Title: Configure how things to be displayed
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- showErrors | No | boolean | No | - | Print occurring errors to the console. False to ignore errored modules |
- disableLinewrap | No | boolean | No | - | Whether to disable line wrap during the run |
- hideCursor | No | boolean | No | - | Whether to hide the cursor during the run |
- separator | No | string | No | - | Set the separator between key and value |
- color | No | Combination | No | - | Set the color of the keys and title |
- binaryPrefix | No | enum (of string) | No | - | Set the binary prefix to used when printing bytes |
- sizeNdigits | No | integer | No | - | Set the number of digits to keep after the decimal point when formatting sizes |
- sizeMaxPrefix | No | enum (of string) | No | - | Set the largest binary prefix to use when formatting sizes |
- percentType | No | number | No | - | Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number |
- noBuffer | No | boolean | No | - | Whether to disable the stdout application buffer |
Title: Print occurring errors to the console. False to ignore errored modules
Type | boolean |
Required | No |
Default | false |
Title: Whether to disable line wrap during the run
Type | boolean |
Required | No |
Default | true |
Title: Whether to hide the cursor during the run
Type | boolean |
Required | No |
Default | true |
Title: Set the separator between key and value
Type | string |
Required | No |
Default | ": " |
Title: Set the color of the keys and title
Type | combining |
Required | No |
Additional properties | [Any type: allowed] |
One of(Option) |
---|
Set the both color of the keys and title |
item 1 |
Title: Set the both color of the keys and title
Type | enum (of string) |
Required | No |
Same definition as | defs_keyColor |
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- keys | No | enum (of string) | No | Same as defs_keyColor | Set the color of the keys |
- title | No | enum (of string) | No | Same as defs_keyColor | Set the color of the title |
Title: Set the color of the keys
Type | enum (of string) |
Required | No |
Same definition as | defs_keyColor |
Title: Set the color of the title
Type | enum (of string) |
Required | No |
Same definition as | defs_keyColor |
Title: Set the binary prefix to used when printing bytes
Type | enum (of string) |
Required | No |
Must be one of:
- "iec"
- "si"
- "jedec"
Title: Set the number of digits to keep after the decimal point when formatting sizes
Type | integer |
Required | No |
Default | 2 |
Title: Set the largest binary prefix to use when formatting sizes
Type | enum (of string) |
Required | No |
Default | "YB" |
Must be one of:
- "B"
- "kB"
- "MB"
- "GB"
- "TB"
- "PB"
- "EB"
- "ZB"
- "YB"
Title: Set the percentage output type. 1 for percentage number, 2 for bar, 3 for both, 6 for bar only, 9 for colored number
Type | number |
Required | No |
Default | 1 |
Restrictions | |
---|---|
Minimum | ≥ 0 |
Maximum | ≤ 9 |
Title: Whether to disable the stdout application buffer
Type | boolean |
Required | No |
Default | false |
Title: Set the path of a library to load
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- pci | No | string | No | - | GPU output (Linux and FreeBSD) |
- vulkan | No | string | No | - | Vulkan module & fallback for GPU output |
- freetype | No | string | No | - | Used for Termux font detection (Android) |
- wayland | No | string | No | - | Better display performance and output in wayland sessions. Supports different refresh rates per monitor. (Linux) |
- xcbRandr | No | string | No | - | - |
- xcb | No | string | No | - | X11 sessions for better display detection and faster WM detection. The randr ones provide multi monitor support The libxcb ones usually have better performance. (Linux, FreeBSD) |
- xrandr | No | string | No | - | X11 sessions for better display detection and faster WM detection. The randr ones provide multi monitor support The libxcb ones usually have better performance. (Linux, FreeBSD) |
- x11 | No | string | No | - | X11 sessions for better display detection and faster WM detection. The randr ones provide multi monitor support The libxcb ones usually have better performance. (Linux, FreeBSD) |
- gio | No | string | No | - | Needed for values that are only stored GSettings (Linux, FreeBSD) |
- dconf | No | string | No | - | Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD) |
- dbus | No | string | No | - | Bluetooth, Player & Media detection (Linux, FreeBSD) |
- xfconf | No | string | No | - | Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD) |
- sqlite3 | No | string | No | - | Needed for pkg & rpm package count (Linux, FreeBSD) |
- rpm | No | string | No | - | Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux) |
- imagemagick | No | string | No | - | Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS) |
- z | No | string | No | - | Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS) |
- chafa | No | string | No | - | Image output as ascii art (Linux, FreeBSD, macOS) |
- egl | No | string | No | - | Needed by the OpenGL module for gl context creation (Linux, FreeBSD) |
- glx | No | string | No | - | Needed by the OpenGL module for gl context creation (Linux, FreeBSD) |
- osmesa | No | string | No | - | Needed by the OpenGL module for gl context creation (Linux, FreeBSD) |
- opencl | No | string | No | - | OpenCL module (Linux, FreeBSD, Windows) |
- pulse | No | string | No | - | Pulseaudio. Used for Sound detection (Linux, FreeBSD) |
- nm | No | string | No | - | NetworkManager. Used for Wifi detection (Linux) |
- ddcutil | No | string | No | - | Used for brightness detection of external displays (Linux) |
Title: GPU output (Linux and FreeBSD)
Type | string |
Required | No |
Title: Vulkan module & fallback for GPU output
Type | string |
Required | No |
Title: Used for Termux font detection (Android)
Type | string |
Required | No |
Title: Better display performance and output in wayland sessions. Supports different refresh rates per monitor. (Linux)
Type | string |
Required | No |
Type | string |
Required | No |
Title: X11 sessions for better display detection and faster WM detection. The randr ones provide multi monitor support The libxcb ones usually have better performance. (Linux, FreeBSD)
Type | string |
Required | No |
Title: X11 sessions for better display detection and faster WM detection. The randr ones provide multi monitor support The libxcb ones usually have better performance. (Linux, FreeBSD)
Type | string |
Required | No |
Title: X11 sessions for better display detection and faster WM detection. The randr ones provide multi monitor support The libxcb ones usually have better performance. (Linux, FreeBSD)
Type | string |
Required | No |
Title: Needed for values that are only stored GSettings (Linux, FreeBSD)
Type | string |
Required | No |
Title: Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)
Type | string |
Required | No |
Title: Bluetooth, Player & Media detection (Linux, FreeBSD)
Type | string |
Required | No |
Title: Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)
Type | string |
Required | No |
Title: Needed for pkg & rpm package count (Linux, FreeBSD)
Type | string |
Required | No |
Title: Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)
Type | string |
Required | No |
Title: Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)
Type | string |
Required | No |
Title: Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)
Type | string |
Required | No |
Title: Image output as ascii art (Linux, FreeBSD, macOS)
Type | string |
Required | No |
Title: Needed by the OpenGL module for gl context creation (Linux, FreeBSD)
Type | string |
Required | No |
Title: Needed by the OpenGL module for gl context creation (Linux, FreeBSD)
Type | string |
Required | No |
Title: Needed by the OpenGL module for gl context creation (Linux, FreeBSD)
Type | string |
Required | No |
Title: OpenCL module (Linux, FreeBSD, Windows)
Type | string |
Required | No |
Title: Pulseaudio. Used for Sound detection (Linux, FreeBSD)
Type | string |
Required | No |
Title: NetworkManager. Used for Wifi detection (Linux)
Type | string |
Required | No |
Title: Used for brightness detection of external displays (Linux)
Type | string |
Required | No |
Title: Fastfetch modules to run
Type | array |
Required | No |
Array restrictions | |
---|---|
Min items | N/A |
Max items | N/A |
Items unicity | False |
Additional items | False |
Tuple validation | See below |
Each item of this array must be | Description |
---|---|
modules items | - |
Type | combining |
Required | No |
Additional properties | [Any type: allowed] |
Any of(Option) |
---|
Run module with default configurations |
Run module with custom configurations |
6.1.1. Property JSON config > modules > modules items > anyOf > Run module with default configurations
Title: Run module with default configurations
Type | enum (of string) |
Required | No |
Must be one of:
- "battery"
- "bios"
- "bluetooth"
- "board"
- "break"
- "brightness"
- "chassis"
- "cpu"
- "cpuusage"
- "command"
- "colors"
- "cursor"
- "datetime"
- "display"
- "disk"
- "de"
- "font"
- "gamepad"
- "gpu"
- "host"
- "icons"
- "kernel"
- "lm"
- "locale"
- "localip"
- "media"
- "memory"
- "opencl"
- "opengl"
- "os"
- "packages"
- "player"
- "poweradapter"
- "processes"
- "publicip"
- "separator"
- "shell"
- "sound"
- "swap"
- "terminal"
- "terminalfont"
- "title"
- "theme"
- "uptime"
- "users"
- "vulkan"
- "wallpaper"
- "weather"
- "wm"
- "wifi"
- "wmtheme"
6.1.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations
Title: Run module with custom configurations
Type | combining |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
+ type | No | string | No | - | Module type |
One of(Option) |
---|
Break |
No additional properties |
Battery |
Bluetooth |
CPU |
Colors |
Command |
Custom |
Display |
Disk |
GPU |
Local IP |
OpenGL |
Public IP |
Separator |
Sound |
Title |
Weather |
6.1.2.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Break
Title: Break
Type | object |
Required | No |
Additional properties | [Not allowed] |
Description: Print a empty line
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
6.1.2.1.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Break > type
Type | const |
Required | No |
Specific value: "break"
6.1.2.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties
Title: No additional properties
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | enum (of string) | No | - | - |
- key | No | string | No | In #/$defs/key | - |
- keyColor | No | enum (of string) | No | In #/$defs/keyColor | - |
- format | No | string | No | In #/$defs/format | - |
6.1.2.2.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type
Type | enum (of string) |
Required | No |
Must be one of:
- "bios"
- "board"
- "brightness"
- "chassis"
- "cpuusage"
- "cursor"
- "datetime"
- "de"
- "font"
- "gamepad"
- "host"
- "icons"
- "kernel"
- "lm"
- "locale"
- "media"
- "memory"
- "opencl"
- "os"
- "packages"
- "player"
- "poweradapter"
- "processes"
- "shell"
- "swap"
- "terminal"
- "terminalfont"
- "theme"
- "uptime"
- "users"
- "vulkan"
- "wallpaper"
- "wm"
- "wifi"
- "wmtheme"
6.1.2.2.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > key
Type | string |
Required | No |
Defined in | #/$defs/key |
6.1.2.2.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > keyColor
Type | enum (of string) |
Required | No |
Defined in | #/$defs/keyColor |
6.1.2.2.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > format
Type | string |
Required | No |
Defined in | #/$defs/format |
6.1.2.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Battery
Title: Battery
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
- dir | No | string | No | - | The directory where the battery folders are. Standard: `/sys/class/power_supply/`. Linux only |
- temp | No | boolean | No | - | Detect and display Battery temperature if supported |
- key | No | string | No | Same as key | - |
- keyColor | No | enum (of string) | No | Same as keyColor | - |
- format | No | string | No | Same as format | - |
6.1.2.3.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Battery > type
Type | const |
Required | No |
Specific value: "battery"
6.1.2.3.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Battery > dir
Title: The directory where the battery folders are. Standard: /sys/class/power_supply/
. Linux only
Type | string |
Required | No |
6.1.2.3.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Battery > temp
Title: Detect and display Battery temperature if supported
Type | boolean |
Required | No |
Default | false |
6.1.2.3.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Battery > key
Type | string |
Required | No |
Same definition as | key |
6.1.2.3.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Battery > keyColor
Type | enum (of string) |
Required | No |
Same definition as | keyColor |
6.1.2.3.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Battery > format
Type | string |
Required | No |
Same definition as | format |
6.1.2.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Bluetooth
Title: Bluetooth
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
- showDisconnected | No | boolean | No | - | Set if disconnected bluetooth devices should be printed |
- key | No | string | No | Same as key | - |
- keyColor | No | enum (of string) | No | Same as keyColor | - |
- format | No | string | No | Same as format | - |
6.1.2.4.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Bluetooth > type
Type | const |
Required | No |
Specific value: "bluetooth"
6.1.2.4.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Bluetooth > showDisconnected
Title: Set if disconnected bluetooth devices should be printed
Type | boolean |
Required | No |
Default | false |
6.1.2.4.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Bluetooth > key
Type | string |
Required | No |
Same definition as | key |
6.1.2.4.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Bluetooth > keyColor
Type | enum (of string) |
Required | No |
Same definition as | keyColor |
6.1.2.4.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Bluetooth > format
Type | string |
Required | No |
Same definition as | format |
6.1.2.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > CPU
Title: CPU
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
- temp | No | boolean | No | - | Detect and display CPU temperature if supported |
- key | No | string | No | Same as key | - |
- keyColor | No | enum (of string) | No | Same as keyColor | - |
- format | No | string | No | Same as format | - |
6.1.2.5.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > CPU > type
Type | const |
Required | No |
Specific value: "cpu"
6.1.2.5.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > CPU > temp
Title: Detect and display CPU temperature if supported
Type | boolean |
Required | No |
Default | false |
6.1.2.5.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > CPU > key
Type | string |
Required | No |
Same definition as | key |
6.1.2.5.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > CPU > keyColor
Type | enum (of string) |
Required | No |
Same definition as | keyColor |
6.1.2.5.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > CPU > format
Type | string |
Required | No |
Same definition as | format |
6.1.2.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Colors
Title: Colors
Type | object |
Required | No |
Additional properties | [Any type: allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
- symbol | No | enum (of string) | No | - | Set the symbol to use |
- paddingLeft | No | integer | No | - | Set the number of white spaces to print before the symbol |
6.1.2.6.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Colors > type
Type | const |
Required | No |
Specific value: "colors"
6.1.2.6.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Colors > symbol
Title: Set the symbol to use
Type | enum (of string) |
Required | No |
Default | "block" |
Must be one of:
- "block"
- "circle"
- "diamond"
- "triangle"
- "square"
- "star"
6.1.2.6.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Colors > paddingLeft
Title: Set the number of white spaces to print before the symbol
Type | integer |
Required | No |
Default | 0 |
Restrictions | |
---|---|
Minimum | ≥ 0 |
6.1.2.7. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Command
Title: Command
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
- shell | No | string | No | - | Set the shell program to execute the command text Default: cmd for Windows, csh for FreeBSD, bash for others |
- text | No | string | No | - | Set the command text to be executed |
- key | No | string | No | Same as key | - |
- keyColor | No | enum (of string) | No | Same as keyColor | - |
- format | No | string | No | Same as format | - |
6.1.2.7.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Command > type
Type | const |
Required | No |
Specific value: "command"
6.1.2.7.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Command > shell
Title: Set the shell program to execute the command text Default: cmd for Windows, csh for FreeBSD, bash for others
Type | string |
Required | No |
6.1.2.7.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Command > text
Title: Set the command text to be executed
Type | string |
Required | No |
6.1.2.7.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Command > key
Type | string |
Required | No |
Same definition as | key |
6.1.2.7.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Command > keyColor
Type | enum (of string) |
Required | No |
Same definition as | keyColor |
6.1.2.7.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Command > format
Type | string |
Required | No |
Same definition as | format |
6.1.2.8. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Custom
Title: Custom
Type | object |
Required | No |
Additional properties | [Not allowed] |
Description: Print a custom string, with or without key
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
- key | No | string | No | - | Leave empty not to print the key |
- keyColor | No | enum (of string) | No | Same as keyColor | - |
+ format | No | string | No | - | Text to print |
6.1.2.8.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Custom > type
Type | const |
Required | No |
Specific value: "custom"
6.1.2.8.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Custom > key
Title: Leave empty not to print the key
Type | string |
Required | No |
6.1.2.8.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Custom > keyColor
Type | enum (of string) |
Required | No |
Same definition as | keyColor |
6.1.2.8.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Custom > format
Title: Text to print
Type | string |
Required | Yes |
6.1.2.9. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Display
Title: Display
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
- compactType | No | enum (of string) | No | - | Set if all displays should be printed in one line |
- preciseRefreshRate | No | boolean | No | - | Set if decimal refresh rates should not be rounded into integers when printing |
- key | No | string | No | Same as key | - |
- keyColor | No | enum (of string) | No | Same as keyColor | - |
- format | No | string | No | Same as format | - |
6.1.2.9.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Display > type
Type | const |
Required | No |
Specific value: "display"
6.1.2.9.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Display > compactType
Title: Set if all displays should be printed in one line
Type | enum (of string) |
Required | No |
Default | "none" |
Must be one of:
- "none"
- "original"
- "scaled"
6.1.2.9.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Display > preciseRefreshRate
Title: Set if decimal refresh rates should not be rounded into integers when printing
Type | boolean |
Required | No |
Default | true |
6.1.2.9.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Display > key
Type | string |
Required | No |
Same definition as | key |
6.1.2.9.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Display > keyColor
Type | enum (of string) |
Required | No |
Same definition as | keyColor |
6.1.2.9.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Display > format
Type | string |
Required | No |
Same definition as | format |
6.1.2.10. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk
Title: Disk
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
- folders | No | string | No | - | A colon (semicolon on Windows) separated list of folder paths for the disk output Default: "/:/home" ("C:\;D:\ ..." on Windows) |
- showExternal | No | boolean | No | - | Set if external volume should be printed |
- showHidden | No | boolean | No | - | Set if hidden volumes should be printed |
- showSubvolumes | No | boolean | No | - | Set if subvolumes should be printed |
- showUnknown | No | boolean | No | - | Set if unknown (unable to detect sizes) volumes should be printed |
- key | No | string | No | Same as key | - |
- keyColor | No | enum (of string) | No | Same as keyColor | - |
- format | No | string | No | Same as format | - |
6.1.2.10.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > type
Type | const |
Required | No |
Specific value: "disk"
6.1.2.10.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > folders
Title: A colon (semicolon on Windows) separated list of folder paths for the disk output Default: "/:/home" ("C:\;D:\ ..." on Windows)
Type | string |
Required | No |
6.1.2.10.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > showExternal
Title: Set if external volume should be printed
Type | boolean |
Required | No |
Default | true |
6.1.2.10.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > showHidden
Title: Set if hidden volumes should be printed
Type | boolean |
Required | No |
Default | false |
6.1.2.10.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > showSubvolumes
Title: Set if subvolumes should be printed
Type | boolean |
Required | No |
Default | false |
6.1.2.10.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > showUnknown
Title: Set if unknown (unable to detect sizes) volumes should be printed
Type | boolean |
Required | No |
Default | false |
6.1.2.10.7. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > key
Type | string |
Required | No |
Same definition as | key |
6.1.2.10.8. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > keyColor
Type | enum (of string) |
Required | No |
Same definition as | keyColor |
6.1.2.10.9. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > format
Type | string |
Required | No |
Same definition as | format |
6.1.2.11. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU
Title: GPU
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
- temp | No | boolean | No | - | Detect and display GPU temperature if supported |
- forceVulkan | No | boolean | No | - | Force using vulkan to detect GPUs, which support video memory usage detection with `--allow-slow-operations` |
- hideType | No | enum (of string) | No | - | Specify the type of GPUs should not be printed |
- key | No | string | No | Same as key | - |
- keyColor | No | enum (of string) | No | Same as keyColor | - |
- format | No | string | No | Same as format | - |
6.1.2.11.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU > type
Type | const |
Required | No |
Specific value: "gpu"
6.1.2.11.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU > temp
Title: Detect and display GPU temperature if supported
Type | boolean |
Required | No |
Default | false |
6.1.2.11.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU > forceVulkan
Title: Force using vulkan to detect GPUs, which support video memory usage detection with --allow-slow-operations
Type | boolean |
Required | No |
Default | false |
6.1.2.11.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU > hideType
Title: Specify the type of GPUs should not be printed
Type | enum (of string) |
Required | No |
Default | "none" |
Must be one of:
- "integrated"
- "discrete"
- "none"
6.1.2.11.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU > key
Type | string |
Required | No |
Same definition as | key |
6.1.2.11.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU > keyColor
Type | enum (of string) |
Required | No |
Same definition as | keyColor |
6.1.2.11.7. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU > format
Type | string |
Required | No |
Same definition as | format |
6.1.2.12. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP
Title: Local IP
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
- showIpv4 | No | boolean | No | - | Show IPv4 addresses |
- showIpv6 | No | boolean | No | - | Show IPv6 addresses |
- showMac | No | boolean | No | - | Show MAC addresses |
- showLoop | No | boolean | No | - | Show loop back addresses (127.0.0.1) |
- compact | No | boolean | No | - | Show all IPs in one line |
- namePrefix | No | string | No | - | Show IPs with given name prefix only |
- showDefaultRouteOnly | No | boolean | No | - | Show ips that are used for default routing only |
- key | No | string | No | Same as key | - |
- keyColor | No | enum (of string) | No | Same as keyColor | - |
- format | No | string | No | Same as format | - |
6.1.2.12.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > type
Type | const |
Required | No |
Specific value: "localip"
6.1.2.12.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > showIpv4
Title: Show IPv4 addresses
Type | boolean |
Required | No |
Default | true |
6.1.2.12.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > showIpv6
Title: Show IPv6 addresses
Type | boolean |
Required | No |
Default | false |
6.1.2.12.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > showMac
Title: Show MAC addresses
Type | boolean |
Required | No |
Default | false |
6.1.2.12.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > showLoop
Title: Show loop back addresses (127.0.0.1)
Type | boolean |
Required | No |
Default | false |
6.1.2.12.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > compact
Title: Show all IPs in one line
Type | boolean |
Required | No |
Default | false |
6.1.2.12.7. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > namePrefix
Title: Show IPs with given name prefix only
Type | string |
Required | No |
6.1.2.12.8. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > showDefaultRouteOnly
Title: Show ips that are used for default routing only
Type | boolean |
Required | No |
Default | false |
6.1.2.12.9. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > key
Type | string |
Required | No |
Same definition as | key |
6.1.2.12.10. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > keyColor
Type | enum (of string) |
Required | No |
Same definition as | keyColor |
6.1.2.12.11. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > format
Type | string |
Required | No |
Same definition as | format |
6.1.2.13. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > OpenGL
Title: OpenGL
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
- library | No | enum (of string) | No | - | Set the OpenGL context creation library to use. Linux only |
- key | No | string | No | Same as key | - |
- keyColor | No | enum (of string) | No | Same as keyColor | - |
- format | No | string | No | Same as format | - |
6.1.2.13.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > OpenGL > type
Type | const |
Required | No |
Specific value: "opengl"
6.1.2.13.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > OpenGL > library
Title: Set the OpenGL context creation library to use. Linux only
Type | enum (of string) |
Required | No |
Default | "auto" |
Must be one of:
- "auto"
- "egl"
- "glx"
- "osmesa"
6.1.2.13.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > OpenGL > key
Type | string |
Required | No |
Same definition as | key |
6.1.2.13.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > OpenGL > keyColor
Type | enum (of string) |
Required | No |
Same definition as | keyColor |
6.1.2.13.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > OpenGL > format
Type | string |
Required | No |
Same definition as | format |
6.1.2.14. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Public IP
Title: Public IP
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
- url | No | string | No | - | The URL of public IP detection server to be used. Only HTTP protocol is supported |
- timeout | No | integer | No | - | Time in milliseconds to wait for the public ip server to respond |
- key | No | string | No | Same as key | - |
- keyColor | No | enum (of string) | No | Same as keyColor | - |
- format | No | string | No | Same as format | - |
6.1.2.14.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Public IP > type
Type | const |
Required | No |
Specific value: "publicip"
6.1.2.14.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Public IP > url
Title: The URL of public IP detection server to be used. Only HTTP protocol is supported
Type | string |
Required | No |
Format | url |
Default | "http://ipinfo.io/ip" |
6.1.2.14.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Public IP > timeout
Title: Time in milliseconds to wait for the public ip server to respond
Type | integer |
Required | No |
Default | "disabled (0)" |
Restrictions | |
---|---|
Minimum | ≥ 0 |
6.1.2.14.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Public IP > key
Type | string |
Required | No |
Same definition as | key |
6.1.2.14.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Public IP > keyColor
Type | enum (of string) |
Required | No |
Same definition as | keyColor |
6.1.2.14.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Public IP > format
Type | string |
Required | No |
Same definition as | format |
6.1.2.15. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Separator
Title: Separator
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
- string | No | string | No | - | Set the string to be printed |
6.1.2.15.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Separator > type
Type | const |
Required | No |
Specific value: "separator"
6.1.2.15.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Separator > string
Title: Set the string to be printed
Type | string |
Required | No |
Default | "-" |
6.1.2.16. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Sound
Title: Sound
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
- soundType | No | enum (of string) | No | - | Set what type of sound devices should be printed |
- key | No | string | No | Same as key | - |
- keyColor | No | enum (of string) | No | Same as keyColor | - |
- format | No | string | No | Same as format | - |
6.1.2.16.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Sound > type
Type | const |
Required | No |
Specific value: "sound"
6.1.2.16.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Sound > soundType
Title: Set what type of sound devices should be printed
Type | enum (of string) |
Required | No |
Default | "main" |
Must be one of:
- "main"
- "active"
- "all"
6.1.2.16.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Sound > key
Type | string |
Required | No |
Same definition as | key |
6.1.2.16.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Sound > keyColor
Type | enum (of string) |
Required | No |
Same definition as | keyColor |
6.1.2.16.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Sound > format
Type | string |
Required | No |
Same definition as | format |
6.1.2.17. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title
Title: Title
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
- fqdn | No | boolean | No | - | Set if the title should use fully qualified domain name |
- color | No | object | No | - | Set colors of the different part of title |
- key | No | string | No | Same as key | - |
- keyColor | No | enum (of string) | No | Same as keyColor | - |
- format | No | string | No | Same as format | - |
6.1.2.17.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > type
Type | const |
Required | No |
Specific value: "title"
6.1.2.17.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > fqdn
Title: Set if the title should use fully qualified domain name
Type | boolean |
Required | No |
Default | false |
6.1.2.17.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > color
Title: Set colors of the different part of title
Type | object |
Required | No |
Additional properties | [Any type: allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- user | No | enum (of string) | No | Same as defs_keyColor | Set color of the user name (left part) |
- at | No | enum (of string) | No | Same as defs_keyColor | Set color of the @ symbol (middle part) |
- host | No | enum (of string) | No | Same as defs_keyColor | Set color of the host name (right part) |
6.1.2.17.3.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > color > user
Title: Set color of the user name (left part)
Type | enum (of string) |
Required | No |
Same definition as | defs_keyColor |
6.1.2.17.3.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > color > at
Title: Set color of the @ symbol (middle part)
Type | enum (of string) |
Required | No |
Same definition as | defs_keyColor |
6.1.2.17.3.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > color > host
Title: Set color of the host name (right part)
Type | enum (of string) |
Required | No |
Same definition as | defs_keyColor |
6.1.2.17.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > key
Type | string |
Required | No |
Same definition as | key |
6.1.2.17.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > keyColor
Type | enum (of string) |
Required | No |
Same definition as | keyColor |
6.1.2.17.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > format
Type | string |
Required | No |
Same definition as | format |
6.1.2.18. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather
Title: Weather
Type | object |
Required | No |
Additional properties | [Not allowed] |
Property | Pattern | Type | Deprecated | Definition | Title/Description |
---|---|---|---|---|---|
- type | No | const | No | - | - |
- location | No | string | No | - | The location to display |
- timeout | No | integer | No | - | Time in milliseconds to wait for the weather server to respond |
- outputFormat | No | string | No | - | The output weather format to be used (must be URI encoded) |
- key | No | string | No | Same as key | - |
- keyColor | No | enum (of string) | No | Same as keyColor | - |
- format | No | string | No | Same as format | - |
6.1.2.18.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather > type
Type | const |
Required | No |
Specific value: "weather"
6.1.2.18.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather > location
Title: The location to display
Type | string |
Required | No |
6.1.2.18.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather > timeout
Title: Time in milliseconds to wait for the weather server to respond
Type | integer |
Required | No |
Default | "disabled (0)" |
Restrictions | |
---|---|
Minimum | ≥ 0 |
6.1.2.18.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather > outputFormat
Title: The output weather format to be used (must be URI encoded)
Type | string |
Required | No |
Default | "%t+-+%C+(%l)" |
6.1.2.18.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather > key
Type | string |
Required | No |
Same definition as | key |
6.1.2.18.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather > keyColor
Type | enum (of string) |
Required | No |
Same definition as | keyColor |
6.1.2.18.7. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather > format
Type | string |
Required | No |
Same definition as | format |
6.1.2.19. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > type
Title: Module type
Type | string |
Required | Yes |
Generated using json-schema-for-humans on 2023-07-21 at 09:51:08 +0800