Skip to content

Json Schema

Jump to bottom
Carter Li edited this page Oct 10, 2023 · 31 revisions

JSON config

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

1. Property JSON config > $schema

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"

2. Property JSON config > logo

Type combining
Required No
Additional properties [Any type: allowed]
One of(Option)
Disable logo
Set the source file of the logo
Fastfetch logo configurations

2.1. Property JSON config > logo > oneOf > Disable logo

Title: Disable logo
Type null
Required No

2.2. Property JSON config > logo > oneOf > Set the source file of the logo

Title: Set the source file of the logo
Type string
Required No

2.3. Property JSON config > logo > oneOf > Fastfetch logo configurations

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
- recache No boolean No - If true, regenerate image logo cache
- separate No boolean No - If true, print modules at bottom of the logo
- chafa No object No - Chafa configuration. See chafa document for details

2.3.1. Property JSON config > logo > oneOf > Fastfetch logo configurations > type

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"

2.3.2. Property JSON config > logo > oneOf > Fastfetch logo configurations > source

Title: Set the source file of the logo
Type string
Required No

2.3.3. Property JSON config > logo > oneOf > Fastfetch logo configurations > color

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
2.3.3.1. Property JSON config > logo > oneOf > Fastfetch logo configurations > color > 1

Title: Color 1
Type enum (of string)
Required No
Same definition as defs_keyColor
2.3.3.2. Property JSON config > logo > oneOf > Fastfetch logo configurations > color > 2

Title: Color 2
Type enum (of string)
Required No
Same definition as defs_keyColor
2.3.3.3. Property JSON config > logo > oneOf > Fastfetch logo configurations > color > 3

Title: Color 3
Type enum (of string)
Required No
Same definition as defs_keyColor
2.3.3.4. Property JSON config > logo > oneOf > Fastfetch logo configurations > color > 4

Title: Color 4
Type enum (of string)
Required No
Same definition as defs_keyColor
2.3.3.5. Property JSON config > logo > oneOf > Fastfetch logo configurations > color > 5

Title: Color 5
Type enum (of string)
Required No
Same definition as defs_keyColor
2.3.3.6. Property JSON config > logo > oneOf > Fastfetch logo configurations > color > 6

Title: Color 6
Type enum (of string)
Required No
Same definition as defs_keyColor
2.3.3.7. Property JSON config > logo > oneOf > Fastfetch logo configurations > color > 7

Title: Color 7
Type enum (of string)
Required No
Same definition as defs_keyColor
2.3.3.8. Property JSON config > logo > oneOf > Fastfetch logo configurations > color > 8

Title: Color 8
Type enum (of string)
Required No
Same definition as defs_keyColor
2.3.3.9. Property JSON config > logo > oneOf > Fastfetch logo configurations > color > 9

Title: Color 9
Type enum (of string)
Required No
Same definition as defs_keyColor

2.3.4. Property JSON config > logo > oneOf > Fastfetch logo configurations > width

Title: Set the width of the logo (in characters). Required for iTerm image protocol
Type integer
Required No
Restrictions
Minimum ≥ 1

2.3.5. Property JSON config > logo > oneOf > Fastfetch logo configurations > height

Title: Set the height of the logo (in characters). Required for iTerm image protocol
Type integer
Required No
Restrictions
Minimum ≥ 1

2.3.6. Property JSON config > logo > oneOf > Fastfetch logo configurations > padding

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
2.3.6.1. Property JSON config > logo > oneOf > Fastfetch logo configurations > padding > top

Title: Set the top padding of the logo
Type integer
Required No
Restrictions
Minimum ≥ 0
2.3.6.2. Property JSON config > logo > oneOf > Fastfetch logo configurations > padding > left

Title: Set the left padding of the logo
Type integer
Required No
Restrictions
Minimum ≥ 0
2.3.6.3. Property JSON config > logo > oneOf > Fastfetch logo configurations > padding > right

Title: Set the right padding of the logo
Type integer
Required No
Restrictions
Minimum ≥ 0

2.3.7. Property JSON config > logo > oneOf > Fastfetch logo configurations > printRemaining

Title: Whether to print the remaining logo, if it has more lines than modules to display
Type boolean
Required No
Default false

2.3.8. Property JSON config > logo > oneOf > Fastfetch logo configurations > preserveAspectRadio

Title: Whether to preserve the aspect ratio of the logo. Supported by iTerm image protocol
Type boolean
Required No
Default false

2.3.9. Property JSON config > logo > oneOf > Fastfetch logo configurations > recache

Title: If true, regenerate image logo cache
Type boolean
Required No
Default false

2.3.10. Property JSON config > logo > oneOf > Fastfetch logo configurations > separate

Title: If true, print modules at bottom of the logo
Type boolean
Required No
Default false

2.3.11. Property JSON config > logo > oneOf > Fastfetch logo configurations > chafa

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.
2.3.11.1. Property JSON config > logo > oneOf > Fastfetch logo configurations > chafa > fgOnly

Title: Produce character-cell output using foreground colors only
Type boolean
Required No
Default false
2.3.11.2. Property JSON config > logo > oneOf > Fastfetch logo configurations > chafa > symbols

Title: Specify character symbols to employ in final output
Type string
Required No
2.3.11.3. Property JSON config > logo > oneOf > Fastfetch logo configurations > chafa > canvasMode

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"
2.3.11.4. Property JSON config > logo > oneOf > Fastfetch logo configurations > chafa > colorSpace

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"
2.3.11.5. Property JSON config > logo > oneOf > Fastfetch logo configurations > chafa > ditherMode

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"

3. Property JSON config > general

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
- thread No boolean No - Alias of multithreading
- 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
- dsForceDrm No boolean No - Force display detection to use `/sys/class/drm`. Linux only
- wmiTimeout No integer No - Set the timeout (ms) for WMI queries, `-1` for no timeout. Windows only
- processingTimeout No integer No - Set the timeout (ms) when waiting for child processes, `-1` for no timeout

3.1. Property JSON config > general > allowSlowOperations

Title: Allow operations that can be very slow for more detailed output
Type boolean
Required No
Default false

3.2. Property JSON config > general > multithreading

Title: Use multiple threads to detect values
Type boolean
Required No
Default true

3.3. Property JSON config > general > thread

Title: Alias of multithreading
Type boolean
Required No
Default true

3.4. Property JSON config > general > stat

Title: Show time usage (in ms) for individual modules
Type boolean
Required No
Default false

3.5. Property JSON config > general > escapeBedrock

Title: On Bedrock Linux, whether to escape the bedrock jail
Type boolean
Required No
Default true

3.6. Property JSON config > general > pipe

Title: Whether to enable pipe mode (disable logo and all escape sequences)
Type boolean
Required No
Default false

3.7. Property JSON config > general > playerName

Title: The name of the player to use for module Media and Player. Linux only
Type string
Required No

3.8. Property JSON config > general > osFile

Title: Set the path to the file containing OS information. Linux only
Type string
Required No

3.9. Property JSON config > general > dsForceDrm

Title: Force display detection to use /sys/class/drm. Linux only
Type boolean
Required No
Default false

3.10. Property JSON config > general > wmiTimeout

Title: Set the timeout (ms) for WMI queries, -1 for no timeout. Windows only
Type integer
Required No
Default 5000

3.11. Property JSON config > general > processingTimeout

Title: Set the timeout (ms) when waiting for child processes, -1 for no timeout
Type integer
Required No
Default 1000

4. Property JSON config > display

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
- brightColor No boolean No - Set if the keys, title and ASCII logo should be printed in bright color
- keyWidth No integer No - Align the width of keys to number of characters, 0 to disable
- 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
- temperatureUnit No enum (of string) No - Set the unit of the temperature
- bar No object No - Set the bar configuration
- 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
- percentNdigits No number No - Set the number of digits to keep after the decimal point when formatting percentage numbers
- noBuffer No boolean No - Whether to disable the stdout application buffer

4.1. Property JSON config > display > showErrors

Title: Print occurring errors to the console. False to ignore errored modules
Type boolean
Required No
Default false

4.2. Property JSON config > display > disableLinewrap

Title: Whether to disable line wrap during the run
Type boolean
Required No
Default true

4.3. Property JSON config > display > hideCursor

Title: Whether to hide the cursor during the run
Type boolean
Required No
Default true

4.4. Property JSON config > display > separator

Title: Set the separator between key and value
Type string
Required No
Default ": "

4.5. Property JSON config > display > color

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

4.5.1. Property JSON config > display > color > oneOf > Set the both color of the keys and title

Title: Set the both color of the keys and title
Type enum (of string)
Required No
Same definition as defs_keyColor

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

Type object
Required No
Additional properties [Not allowed]
Property Pattern Type Deprecated Definition Title/Description
- keys No enum (of string) No Same as defs_keyColor Set the color of the keys
- title No enum (of string) No Same as defs_keyColor Set the color of the title
4.5.2.1. Property JSON config > display > color > oneOf > item 1 > keys

Title: Set the color of the keys
Type enum (of string)
Required No
Same definition as defs_keyColor
4.5.2.2. Property JSON config > display > color > oneOf > item 1 > title

Title: Set the color of the title
Type enum (of string)
Required No
Same definition as defs_keyColor

4.6. Property JSON config > display > brightColor

Title: Set if the keys, title and ASCII logo should be printed in bright color
Type boolean
Required No
Default true

4.7. Property JSON config > display > keyWidth

Title: Align the width of keys to number of characters, 0 to disable
Type integer
Required No
Default 0
Restrictions
Minimum ≥ 0

4.8. Property JSON config > display > binaryPrefix

Title: Set the binary prefix to used when printing bytes
Type enum (of string)
Required No

Must be one of:

  • "iec"
  • "si"
  • "jedec"

4.9. Property JSON config > display > sizeNdigits

Title: Set the number of digits to keep after the decimal point when formatting sizes
Type integer
Required No
Default 2
Restrictions
Minimum ≥ 0
Maximum ≤ 9

4.10. Property JSON config > display > sizeMaxPrefix

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"

4.11. Property JSON config > display > temperatureUnit

Title: Set the unit of the temperature
Type enum (of string)
Required No
Default "C"

Must be one of:

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

4.12. Property JSON config > display > bar

Title: Set the bar configuration
Type object
Required No
Additional properties [Any type: allowed]
Property Pattern Type Deprecated Definition Title/Description
- charElapsed No string No - Set the character to use in elapsed part
- charTotal No string No - Set the character to use in total part
- border No boolean No - Whether to show a border around the bar
- width No integer No - Set the width of the bar, in number of characters

4.12.1. Property JSON config > display > bar > charElapsed

Title: Set the character to use in elapsed part
Type string
Required No
Default "■"

4.12.2. Property JSON config > display > bar > charTotal

Title: Set the character to use in total part
Type string
Required No
Default "-"

4.12.3. Property JSON config > display > bar > border

Title: Whether to show a border around the bar
Type boolean
Required No
Default true

4.12.4. Property JSON config > display > bar > width

Title: Set the width of the bar, in number of characters
Type integer
Required No
Default 10
Restrictions
Minimum ≥ 1

4.13. Property JSON config > display > percentType

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 ≤ 255

4.14. Property JSON config > display > percentNdigits

Title: Set the number of digits to keep after the decimal point when formatting percentage numbers
Type number
Required No
Default 0
Restrictions
Minimum ≥ 0
Maximum ≤ 9

4.15. Property JSON config > display > noBuffer

Title: Whether to disable the stdout application buffer
Type boolean
Required No
Default false

5. Property JSON config > library

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)

5.1. Property JSON config > library > pci

Title: GPU output (Linux and FreeBSD)
Type string
Required No

5.2. Property JSON config > library > vulkan

Title: Vulkan module & fallback for GPU output
Type string
Required No

5.3. Property JSON config > library > freetype

Title: Used for Termux font detection (Android)
Type string
Required No

5.4. Property JSON config > library > wayland

Title: Better display performance and output in wayland sessions. Supports different refresh rates per monitor. (Linux)
Type string
Required No

5.5. Property JSON config > library > xcbRandr

Type string
Required No

5.6. Property JSON config > library > xcb

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

5.7. Property JSON config > library > xrandr

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

5.8. Property JSON config > library > x11

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

5.9. Property JSON config > library > gio

Title: Needed for values that are only stored GSettings (Linux, FreeBSD)
Type string
Required No

5.10. Property JSON config > library > dconf

Title: Needed for values that are only stored in DConf + Fallback for GSettings (Linux, FreeBSD)
Type string
Required No

5.11. Property JSON config > library > dbus

Title: Bluetooth, Player & Media detection (Linux, FreeBSD)
Type string
Required No

5.12. Property JSON config > library > xfconf

Title: Needed for XFWM theme and XFCE Terminal font (Linux, FreeBSD)
Type string
Required No

5.13. Property JSON config > library > sqlite3

Title: Needed for pkg & rpm package count (Linux, FreeBSD)
Type string
Required No

5.14. Property JSON config > library > rpm

Title: Slower fallback for rpm package count. Needed on openSUSE & old CentOS / Redhat. (Linux)
Type string
Required No

5.15. Property JSON config > library > imagemagick

Title: Images in terminal using sixel or kitty graphics protocol (Linux, FreeBSD, macOS)
Type string
Required No

5.16. Property JSON config > library > z

Title: Libz. Faster image output when using kitty graphics protocol (Linux, FreeBSD, macOS)
Type string
Required No

5.17. Property JSON config > library > chafa

Title: Image output as ascii art (Linux, FreeBSD, macOS)
Type string
Required No

5.18. Property JSON config > library > egl

Title: Needed by the OpenGL module for gl context creation (Linux, FreeBSD)
Type string
Required No

5.19. Property JSON config > library > glx

Title: Needed by the OpenGL module for gl context creation (Linux, FreeBSD)
Type string
Required No

5.20. Property JSON config > library > osmesa

Title: Needed by the OpenGL module for gl context creation (Linux, FreeBSD)
Type string
Required No

5.21. Property JSON config > library > opencl

Title: OpenCL module (Linux, FreeBSD, Windows)
Type string
Required No

5.22. Property JSON config > library > pulse

Title: Pulseaudio. Used for Sound detection (Linux, FreeBSD)
Type string
Required No

5.23. Property JSON config > library > nm

Title: NetworkManager. Used for Wifi detection (Linux)
Type string
Required No

5.24. Property JSON config > library > ddcutil

Title: Used for brightness detection of external displays (Linux)
Type string
Required No

6. Property JSON config > modules

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 -

6.1. JSON config > modules > 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"
  • "diskio"
  • "de"
  • "font"
  • "gamepad"
  • "gpu"
  • "host"
  • "icons"
  • "kernel"
  • "lm"
  • "locale"
  • "localip"
  • "media"
  • "memory"
  • "monitor"
  • "netio"
  • "opencl"
  • "opengl"
  • "os"
  • "packages"
  • "player"
  • "poweradapter"
  • "processes"
  • "publicip"
  • "separator"
  • "shell"
  • "sound"
  • "swap"
  • "terminal"
  • "terminalfont"
  • "terminalsize"
  • "title"
  • "theme"
  • "uptime"
  • "users"
  • "version"
  • "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 [Any type: allowed]
Property Pattern Type Deprecated Definition Title/Description
+ type No string No - -
One of(Option)
Break
No additional properties
Battery
Bluetooth
CPU
CPU Usage
Colors
Command
Custom
Display
Disk
DiskIO
GPU
Local IP
NetIO
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 Combination No - -
- key No string No In #/$defs/key -
- keyColor No enum (of string) No In #/$defs/keyColor -
- keyWidth No integer No In #/$defs/keyWidth -
- 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 combining
Required No
Additional properties [Any type: allowed]
Any of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
item 6
item 7
item 8
item 9
item 10
item 11
item 12
item 13
item 14
item 15
item 16
item 17
item 18
item 19
item 20
item 21
item 22
item 23
item 24
item 25
item 26
item 27
item 28
item 29
item 30
item 31
item 32
item 33
item 34
item 35
item 36
6.1.2.2.1.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 0
Type const
Required No

Description: Print BIOS name, version, release date, etc

Specific value: "bios"

6.1.2.2.1.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 1
Type const
Required No

Description: Print mather board name and other info

Specific value: "board"

6.1.2.2.1.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 2
Type const
Required No

Description: Print brightness of your monitors

Specific value: "brightness"

6.1.2.2.1.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 3
Type const
Required No

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

Specific value: "chassis"

6.1.2.2.1.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 4
Type const
Required No

Description: Print cursor style name

Specific value: "cursor"

6.1.2.2.1.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 5
Type const
Required No

Description: Print current date and time

Specific value: "datetime"

6.1.2.2.1.7. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 6
Type const
Required No

Description: Print desktop environment name

Specific value: "de"

6.1.2.2.1.8. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 7
Type const
Required No

Description: Print system font name

Specific value: "font"

6.1.2.2.1.9. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 8
Type const
Required No

Description: List connected gamepads

Specific value: "gamepad"

6.1.2.2.1.10. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 9
Type const
Required No

Description: Print product name of your computer

Specific value: "host"

6.1.2.2.1.11. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 10
Type const
Required No

Description: Print icon style name

Specific value: "icons"

6.1.2.2.1.12. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 11
Type const
Required No

Description: Print system kernel version

Specific value: "kernel"

6.1.2.2.1.13. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 12
Type const
Required No

Description: Print login manager (desktop manager) name and version

Specific value: "lm"

6.1.2.2.1.14. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 13
Type const
Required No

Description: Print system locale name

Specific value: "locale"

6.1.2.2.1.15. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 14
Type const
Required No

Description: Print playing song name

Specific value: "media"

6.1.2.2.1.16. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 15
Type const
Required No

Description: Print system memory usage info

Specific value: "memory"

6.1.2.2.1.17. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 16
Type const
Required No

Description: Print connected physical monitor information

Specific value: "monitor"

6.1.2.2.1.18. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 17
Type const
Required No

Description: Print highest OpenCL version supported by the GPU

Specific value: "opencl"

6.1.2.2.1.19. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 18
Type const
Required No

Description: Print operating system name and version

Specific value: "os"

6.1.2.2.1.20. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 19
Type const
Required No

Description: List installed package managers and count of installed packages

Specific value: "packages"

6.1.2.2.1.21. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 20
Type const
Required No

Description: Print music player name

Specific value: "player"

6.1.2.2.1.22. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 21
Type const
Required No

Description: Print power adapter name and charging watts

Specific value: "poweradapter"

6.1.2.2.1.23. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 22
Type const
Required No

Description: Count running processes

Specific value: "processes"

6.1.2.2.1.24. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 23
Type const
Required No

Description: Print current shell name and version

Specific value: "shell"

6.1.2.2.1.25. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 24
Type const
Required No

Description: Print swap (paging file) space usage

Specific value: "swap"

6.1.2.2.1.26. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 25
Type const
Required No

Description: Print current terminal name and version

Specific value: "terminal"

6.1.2.2.1.27. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 26
Type const
Required No

Description: Print font name and size used by current terminal

Specific value: "terminalfont"

6.1.2.2.1.28. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 27
Type const
Required No

Description: Print current terminal size

Specific value: "terminalsize"

6.1.2.2.1.29. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 28
Type const
Required No

Description: Print current theme information

Specific value: "theme"

6.1.2.2.1.30. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 29
Type const
Required No

Description: Print system uptime

Specific value: "uptime"

6.1.2.2.1.31. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 30
Type const
Required No

Description: List users currently logged in

Specific value: "users"

6.1.2.2.1.32. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 31
Type const
Required No

Description: Print Fastfetch version

Specific value: "version"

6.1.2.2.1.33. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 32
Type const
Required No

Description: Print highest Vulkan version supported by the GPU

Specific value: "vulkan"

6.1.2.2.1.34. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 33
Type const
Required No

Description: Print image file path of current wallpaper

Specific value: "wallpaper"

6.1.2.2.1.35. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 34
Type const
Required No

Description: Print window manager name and version

Specific value: "wm"

6.1.2.2.1.36. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 35
Type const
Required No

Description: Print connected Wi-Fi info (SSID, connection and security protocol)

Specific value: "wifi"

6.1.2.2.1.37. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > No additional properties > type > anyOf > item 36
Type const
Required No

Description: Print current theme of window manager

Specific value: "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 > keyWidth
Type integer
Required No
Default 0
Defined in #/$defs/keyWidth
Restrictions
Minimum ≥ 0
6.1.2.2.5. 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 - Print battery capacity, status, etc
- 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 -
- keyWidth No integer No Same as keyWidth -
- 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

Description: Print battery capacity, status, etc

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 > keyWidth
Type integer
Required No
Default 0
Same definition as keyWidth
6.1.2.3.7. 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 - List bluetooth devices
- 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 -
- keyWidth No integer No Same as keyWidth -
- 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

Description: List bluetooth devices

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 > keyWidth
Type integer
Required No
Default 0
Same definition as keyWidth
6.1.2.4.6. 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 - Print CPU name, frequency, etc
- temp No boolean No - Detect and display CPU temperature if supported
- freqNdigits No integer No - Set the number of digits to keep after the decimal point when printing CPU frequency
- key No string No Same as key -
- keyColor No enum (of string) No Same as keyColor -
- keyWidth No integer No Same as keyWidth -
- 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

Description: Print CPU name, frequency, etc

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 > freqNdigits

Title: Set the number of digits to keep after the decimal point when printing CPU frequency
Type integer
Required No
Default 2
Restrictions
Minimum ≥ 0
Maximum ≤ 9
6.1.2.5.4. 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.5. 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.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > CPU > keyWidth
Type integer
Required No
Default 0
Same definition as keyWidth
6.1.2.5.7. 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 > CPU Usage

Title: CPU Usage
Type object
Required No
Additional properties [Any type: allowed]
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print CPU usage. Costs some time to collect data
- separate No boolean No - Display CPU usage per CPU logical core, instead of an average result
6.1.2.6.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > CPU Usage > type
Type const
Required No

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

Specific value: "cpuusage"

6.1.2.6.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > CPU Usage > separate
Type boolean
Required No
Default false

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

6.1.2.7. 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 - Print some colored blocks
- symbol No enum (of string) No - Set the symbol to use
- paddingLeft No integer No - Set the number of white spaces to print before the symbol
6.1.2.7.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Colors > type
Type const
Required No

Description: Print some colored blocks

Specific value: "colors"

6.1.2.7.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.7.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.8. 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 - Running custom shell scripts
- shell No string No - Set the shell program to execute the command text
Default: cmd for Windows, /bin/sh for *nix
- 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 -
- keyWidth No integer No Same as keyWidth -
- format No string No Same as format -
6.1.2.8.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Command > type
Type const
Required No

Description: Running custom shell scripts

Specific value: "command"

6.1.2.8.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, /bin/sh for *nix
Type string
Required No
6.1.2.8.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.8.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.8.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.8.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Command > keyWidth
Type integer
Required No
Default 0
Same definition as keyWidth
6.1.2.8.7. 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.9. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Custom

Title: Custom
Type object
Required No
Additional properties [Not allowed]
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print a custom string, with or without key
- key No string No - Leave empty not to print the key
- keyColor No enum (of string) No Same as keyColor -
- keyWidth No integer No Same as keyWidth -
+ format No string No - Text to print
6.1.2.9.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Custom > type
Type const
Required No

Description: Print a custom string, with or without key

Specific value: "custom"

6.1.2.9.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.9.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.9.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Custom > keyWidth
Type integer
Required No
Default 0
Same definition as keyWidth
6.1.2.9.5. 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.10. 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 - Print resolutions, refresh rates, etc
- compactType No enum (of string) No - Set if all displays should be printed in one line
- preciseRefreshRate No boolean No - Set if decimal refresh rates should not be rounded into integers when printing
- key No string No Same as key -
- keyColor No enum (of string) No Same as keyColor -
- keyWidth No integer No Same as keyWidth -
- 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 > Display > type
Type const
Required No

Description: Print resolutions, refresh rates, etc

Specific value: "display"

6.1.2.10.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.10.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.10.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.10.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.10.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Display > keyWidth
Type integer
Required No
Default 0
Same definition as keyWidth
6.1.2.10.7. 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.11. 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 - Print partitions, space usage, disk type, etc
- folders No string No - A colon (semicolon on Windows) separated list of folder paths for the disk output
Default: "/:/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
- showReadOnly No boolean No - Set if read only volumes should be printed
- showUnknown No boolean No - Set if unknown (unable to detect sizes) volumes should be printed
- useAvailable No boolean No - Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes
- key No string No Same as key -
- keyColor No enum (of string) No Same as keyColor -
- keyWidth No integer No Same as keyWidth -
- 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 > Disk > type
Type const
Required No

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

Specific value: "disk"

6.1.2.11.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.11.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.11.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.11.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.11.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > showReadOnly

Title: Set if read only volumes should be printed
Type boolean
Required No
Default false
6.1.2.11.7. 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.11.8. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > useAvailable

Title: Use f_bavail (lpFreeBytesAvailableToCaller for Windows) instead of f_bfree to calculate used bytes
Type boolean
Required No
Default false
6.1.2.11.9. 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.11.10. 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.11.11. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Disk > keyWidth
Type integer
Required No
Default 0
Same definition as keyWidth
6.1.2.11.12. 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.12. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > DiskIO

Title: DiskIO
Type object
Required No
Additional properties [Not allowed]
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print physical disk I/O throughput
- namePrefix No string No - Show disks with given name prefix only
- key No string No Same as key -
- keyColor No enum (of string) No Same as keyColor -
- keyWidth No integer No Same as keyWidth -
- 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 > DiskIO > type
Type const
Required No

Description: Print physical disk I/O throughput

Specific value: "diskio"

6.1.2.12.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > DiskIO > namePrefix

Title: Show disks with given name prefix only
Type string
Required No
6.1.2.12.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > DiskIO > key
Type string
Required No
Same definition as key
6.1.2.12.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > DiskIO > keyColor
Type enum (of string)
Required No
Same definition as keyColor
6.1.2.12.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > DiskIO > keyWidth
Type integer
Required No
Default 0
Same definition as keyWidth
6.1.2.12.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > DiskIO > 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 > GPU

Title: GPU
Type object
Required No
Additional properties [Not allowed]
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print GPU names, graphic memory size, type, etc
- temp No 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 -
- keyWidth No integer No Same as keyWidth -
- 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 > GPU > type
Type const
Required No

Description: Print GPU names, graphic memory size, type, etc

Specific value: "gpu"

6.1.2.13.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.13.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.13.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.13.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.13.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.13.7. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > GPU > keyWidth
Type integer
Required No
Default 0
Same definition as keyWidth
6.1.2.13.8. 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.14. 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 - List local IP addresses (v4 or v6), MAC addresses, etc
- 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
- defaultRouteOnly 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 -
- keyWidth No integer No Same as keyWidth -
- 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 > Local IP > type
Type const
Required No

Description: List local IP addresses (v4 or v6), MAC addresses, etc

Specific value: "localip"

6.1.2.14.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.14.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.14.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.14.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.14.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.14.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.14.8. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > defaultRouteOnly

Title: Show ips that are used for default routing only
Type boolean
Required No
Default false
6.1.2.14.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.14.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.14.11. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Local IP > keyWidth
Type integer
Required No
Default 0
Same definition as keyWidth
6.1.2.14.12. 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.15. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > NetIO

Title: NetIO
Type object
Required No
Additional properties [Not allowed]
Property Pattern Type Deprecated Definition Title/Description
- type No const No - Print network I/O throughput
- namePrefix No string No - Show IPs with given name prefix only
- defaultRouteOnly 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 -
- keyWidth No integer No Same as keyWidth -
- format No string No Same as format -
6.1.2.15.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > NetIO > type
Type const
Required No

Description: Print network I/O throughput

Specific value: "netio"

6.1.2.15.2. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > NetIO > namePrefix

Title: Show IPs with given name prefix only
Type string
Required No
6.1.2.15.3. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > NetIO > defaultRouteOnly

Title: Show ips that are used for default routing only
Type boolean
Required No
Default false
6.1.2.15.4. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > NetIO > key
Type string
Required No
Same definition as key
6.1.2.15.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > NetIO > keyColor
Type enum (of string)
Required No
Same definition as keyColor
6.1.2.15.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > NetIO > keyWidth
Type integer
Required No
Default 0
Same definition as keyWidth
6.1.2.15.7. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > NetIO > format
Type string
Required No
Same definition as format
6.1.2.16. 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 - Print highest OpenGL version supported by the GPU
- 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 -
- keyWidth No integer No Same as keyWidth -
- 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 > OpenGL > type
Type const
Required No

Description: Print highest OpenGL version supported by the GPU

Specific value: "opengl"

6.1.2.16.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.16.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.16.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.16.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > OpenGL > keyWidth
Type integer
Required No
Default 0
Same definition as keyWidth
6.1.2.16.6. 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.17. 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 - Print your public IP address, etc
- 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 -
- keyWidth No integer No Same as keyWidth -
- 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 > Public IP > type
Type const
Required No

Description: Print your public IP address, etc

Specific value: "publicip"

6.1.2.17.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.17.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.17.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.17.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.17.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Public IP > keyWidth
Type integer
Required No
Default 0
Same definition as keyWidth
6.1.2.17.7. 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.18. 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 - Print a separator line
- string No string No - Set the string to be printed
6.1.2.18.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Separator > type
Type const
Required No

Description: Print a separator line

Specific value: "separator"

6.1.2.18.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.19. 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 - Print sound devices, volume, etc
- 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 -
- keyWidth No integer No Same as keyWidth -
- format No string No Same as format -
6.1.2.19.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Sound > type
Type const
Required No

Description: Print sound devices, volume, etc

Specific value: "sound"

6.1.2.19.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.19.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.19.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.19.5. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Sound > keyWidth
Type integer
Required No
Default 0
Same definition as keyWidth
6.1.2.19.6. 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.20. 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 - Print title, which contains your user name, hostname
- 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 -
- keyWidth No integer No Same as keyWidth -
- format No string No Same as format -
6.1.2.20.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > type
Type const
Required No

Description: Print title, which contains your user name, hostname

Specific value: "title"

6.1.2.20.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.20.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 [Not 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.20.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.20.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.20.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.20.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.20.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.20.6. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Title > keyWidth
Type integer
Required No
Default 0
Same definition as keyWidth
6.1.2.20.7. 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.21. 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 - Print weather information
- 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 -
- keyWidth No integer No Same as keyWidth -
- format No string No Same as format -
6.1.2.21.1. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather > type
Type const
Required No

Description: Print weather information

Specific value: "weather"

6.1.2.21.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.21.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.21.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.21.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.21.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.21.7. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > oneOf > Weather > keyWidth
Type integer
Required No
Default 0
Same definition as keyWidth
6.1.2.21.8. 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.22. Property JSON config > modules > modules items > anyOf > Run module with custom configurations > type
Type string
Required Yes

Generated using json-schema-for-humans on 2023-10-10 at 19:07:53 +0800

Docs

  1. Configuration
  2. Json Schema
  3. Logo Options
  4. Format String Guide
  5. Color Format Specification
  6. Migrate Neofetch Logo To Fastfetch
  7. Dependencies
  8. Building
  9. Support Status
Clone this wiki locally