Schema URL

Type: object

Properties

cpu CpuConfig | null
disk DiskConfig | null
flags GeneralConfig | null
network NetworkConfig | null
processes ProcessesConfig | null
row array | null
styles StyleConfig | null
temperature TempConfig | null

Definitions

BatteryStyle object

Styling specific to the battery widget.

high_battery_color ColorStr | null

The colour of the battery widget bar when the battery is over 50%.

low_battery_color ColorStr | null

The colour of the battery widget bar when the battery is under 10%.

medium_battery_color ColorStr | null

The colour of the battery widget bar when the battery between 10% to 50%.

ColorStr string
CpuConfig object

CPU column settings.

default string

The default selection of the CPU widget. If the given selection is invalid, we will fall back to all.

Values: "all" "average"
CpuDefault string

The default selection of the CPU widget. If the given selection is invalid, we will fall back to all.

CpuStyle object

Styling specific to the CPU widget.

all_entry_color ColorStr | null

The colour of the "All" CPU label.

avg_entry_color ColorStr | null

The colour of the average CPU label and graph line.

cpu_core_colors array | null

Colour of each CPU threads' label and graph line. Read in order.

DiskColumn string
DiskConfig object

Disk configuration.

columns array | null

A list of disk widget columns.

mount_filter IgnoreList | null

A filter over the mount names.

name_filter IgnoreList | null

A filter over the disk names.

FinalWidget object

Represents a widget.

type string required
default boolean | null
ratio integer | null
format=uint16min=0max=65535
GeneralConfig object
autohide_time boolean | null
average_cpu_row boolean | null
basic boolean | null
battery boolean | null
case_sensitive boolean | null
cpu_left_legend boolean | null
current_usage boolean | null
default_time_value StringOrNum | null
default_widget_count integer | null
format=uint64min=0
default_widget_type string | null
disable_advanced_kill boolean | null
disable_click boolean | null
disable_gpu boolean | null
disable_keys boolean | null
dot_marker boolean | null
enable_cache_memory boolean | null
expanded boolean | null
free_arc boolean | null
group_processes boolean | null
hide_avg_cpu boolean | null
hide_k_threads boolean | null
hide_table_gap boolean | null
hide_time boolean | null
memory_legend string | null
network_legend string | null
network_use_binary_prefix boolean | null
network_use_bytes boolean | null
network_use_log boolean | null
no_write boolean | null
process_command boolean | null
process_memory_as_value boolean | null
rate StringOrNum | null
regex boolean | null
retention StringOrNum | null
show_table_scroll_position boolean | null
temperature_type string | null
time_delta StringOrNum | null
tree boolean | null
tree_collapse boolean | null
unnormalized_cpu boolean | null
use_old_network_legend boolean | null
whole_word boolean | null
GraphStyle object

General styling for graph widgets.

graph_color ColorStr | null

The general colour of the parts of the graph.

legend_text TextStyleConfig | null

Text styling for graph's legend text.

IgnoreList object
list string[] required
case_sensitive boolean
Default: false
is_list_ignored boolean
Default: true
regex boolean
Default: false
whole_word boolean
Default: false
MemoryStyle object

Styling specific to the memory widget.

arc_color ColorStr | null

The colour of the ARC label and graph line.

cache_color ColorStr | null

The colour of the cache label and graph line. Does not do anything on Windows.

gpu_colors array | null

Colour of each GPU's memory label and graph line. Read in order.

ram_color ColorStr | null

The colour of the RAM label and graph line.

swap_color ColorStr | null

The colour of the swap label and graph line.

NetworkConfig object

Network configuration.

interface_filter IgnoreList | null

A filter over the network interface names.

NetworkStyle object

Styling specific to the network widget.

rx_color ColorStr | null

The colour of the RX (download) label and graph line.

rx_total_color ColorStr | null

he colour of the total RX (download) label in basic mode.

tx_color ColorStr | null

The colour of the TX (upload) label and graph line.

tx_total_color ColorStr | null

The colour of the total TX (upload) label in basic mode.

ProcColumn string

A column in the process widget.

ProcessesConfig object

Process configuration.

columns ProcColumn[]

A list of process widget columns.

get_threads boolean | null

Whether to get process child threads.

RowChildren FinalWidget | object

Represents a child of a Row - either a Col (column) or a FinalWidget.

A Col can also have an optional length and children. We only allow columns to have FinalWidgets as children, lest we get some amount of mutual recursion between Row and Col.

StringOrNum string | integer
StyleConfig object

Style-related configs.

battery BatteryStyle | null

Styling for the battery widget.

cpu CpuStyle | null

Styling for the CPU widget.

graphs GraphStyle | null

Styling for graph widgets.

memory MemoryStyle | null

Styling for the memory widget.

network NetworkStyle | null

Styling for the network widget.

tables TableStyle | null

Styling for table widgets.

theme string | null

A built-in theme.

If this is and a custom colour are both set, in the config file, the custom colour scheme will be prioritized first. If a theme is set in the command-line args, however, it will always be prioritized first.

widgets WidgetStyle | null

Styling for general widgets.

TableStyle object

General styling for table widgets.

headers TextStyleConfig | null

Text styling for table headers.

TempConfig object

Temperature configuration.

sensor_filter IgnoreList | null

A filter over the sensor names.

TextStyleConfig ColorStr | object

A style for text.

WidgetBorderType string
WidgetStyle object

General styling for generic widgets.

border_color ColorStr | null

The colour of the widgets' borders.

disabled_text TextStyleConfig | null

Text styling for text when representing something that is disabled.

selected_border_color ColorStr | null

The colour of a widget's borders when the widget is selected.

selected_text TextStyleConfig | null

Text styling for text when representing something that is selected.

text TextStyleConfig | null

Text styling for text in general.

thread_text TextStyleConfig | null

Text styling for text when representing process threads. Only usable on Linux at the moment.

widget_border_type WidgetBorderType | null

Widget borders type.

widget_title TextStyleConfig | null

Text styling for a widget's title.

row object

Represents a row. This has a length of some sort (optional) and a vector of children.

child array | null
ratio integer | null
format=uint16min=0max=65535