Schema URL

Type: object

Properties

flags object

This group of options represents a command-line flag/option. Flags explicitly added when running (ie: btm -a) will override this config file if an option is also set here

33 nested properties
hide_avg_cpu boolean

Whether to hide the average cpu entry

Default: false
dot_marker boolean

Whether to use dot markers rather than braille

Default: false
rate integer

The update rate of the application

Default: 1000
left_legend boolean

Whether to put the CPU legend to the left

Default: false
current_usage boolean

Whether to set CPU% on a process to be based on the total CPU or just current usage

Default: false
unnormalized_cpu boolean

Whether to set CPU% on a process to be based on the total CPU or per-core CPU% (not divided by the number of cpus)

Default: false
group_processes boolean

Whether to group processes with the same name together by default

Default: false
case_sensitive boolean

Whether to make process searching case sensitive by default

Default: false
whole_word boolean

Whether to make process searching look for matching the entire word by default

Default: false
regex boolean

Whether to make process searching use regex by default

Default: false
temperature_type string

Defaults to Celsius

Default: "k"
Values: "k" "f" "c" "kelvin" "fahrenheit" "celsius"
default_time_value integer

The default time interval in milliseconds

Default: 60000
time_delta integer

The time delta on each zoom in/out action in milliseconds

Default: 15000
hide_time boolean

Hides the time scale

Default: false
default_widget_type string

Override layout default widget

Default: "proc"
default_widget_count integer

Override layout default widget

Default: 1
expanded_on_startup boolean

Expand selected widget upon starting the app

Default: true
basic boolean

Use basic mode

Default: false
use_old_network_legend boolean

Use the old network legend style

Default: false
hide_table_gap boolean

Remove space in tables

Default: false
battery boolean

Show the battery widgets

Default: false
disable_click boolean

Disable mouse clicks

Default: false
color string

Built-in themes

Default: "default"
Values: "default" "default-light" "gruvbox" "gruvbox-light" "nord" "nord-light"
process_memory_as_value boolean

Show memory values in the processes widget as values by default

Default: false
tree boolean

Show tree mode by default in the processes widget

Default: false
show_table_scroll_position boolean

Shows an indicator in table widgets tracking where in the list you are

Default: false
process_command boolean

Show processes as their commands by default in the process widget

Default: false
network_use_binary_prefix boolean

Displays the network widget with binary prefixes

Default: false
network_use_bytes boolean

Displays the network widget using bytes

Default: false
network_use_log boolean

Displays the network widget with a log scale

Default: false
disable_advanced_kill boolean

Hides advanced options to stop a process on Unix-like systems

Default: false
enable_gpu_memory boolean

Shows GPU(s) memory

Default: false
retention string

How much data is stored at once in terms of time

Default: "10m"
colors

These are all the components that support custom theming. Note that colour support will depend on terminal support

19 nested properties
table_header_color string

Represents the colour of table headers (processes, CPU, disks, temperature)

Default: "LightBlue"
widget_title_color string

Represents the colour of the label each widget has

Default: "Gray"
avg_cpu_color string

Represents the average CPU color

Default: "Red"
cpu_core_colors string[]

Represents the colour the core will use in the CPU legend and graph

Default:
[
  "LightMagenta",
  "LightYellow",
  "LightCyan",
  "LightGreen",
  "LightBlue",
  "LightRed",
  "Cyan",
  "Green",
  "Blue",
  "Red"
]
ram_color string

Represents the colour RAM will use in the memory legend and graph

Default: "LightMagenta"
swap_color string

Represents the colour SWAP will use in the memory legend and graph

Default: "LightYellow"
arc_color string

Represents the colour ARC will use in the memory legend and graph

Default: "LightCyan"
gpu_core_colors string[]

Represents the colour the GPU will use in the memory legend and graph

Default:
[
  "LightGreen",
  "LightBlue",
  "LightRed",
  "Cyan",
  "Green",
  "Blue",
  "Red"
]
rx_color string

Represents the colour rx will use in the network legend and graph

Default: "LightCyan"
tx_color string

Represents the colour tx will use in the network legend and graph

Default: "LightGreen"
border_color string

Represents the colour of the border of unselected widgets

Default: "Gray"
highlighted_border_color string

Represents the colour of the border of selected widgets

Default: "LightBlue"
text_color string

Represents the colour of most text

Default: "Gray"
selected_text_color string

Represents the colour of text that is selected

Default: "Black"
selected_bg_color string

Represents the background colour of text that is selected

Default: "LightBlue"
graph_color string

Represents the colour of the lines and text of the graph

Default: "Gray"
high_battery_color string

Represents the colours of the battery based on charge

Default: "green"
medium_battery_color string

Represents the colours of the battery based on charge

Default: "yellow"
low_battery_color string

Represents the colours of the battery based on charge

Default: "red"
row object[]
disk_filter object

hide specific temperature sensors, network interfaces, and disks using filters

5 nested properties
is_list_ignored boolean
Default: true
list array
regex boolean
Default: true
case_sensitive boolean
Default: false
whole_word boolean
Default: false
mount_filter object

hide specific temperature sensors, network interfaces, and disks using filters

5 nested properties
is_list_ignored boolean
Default: true
list array
regex boolean
Default: true
case_sensitive boolean
Default: false
whole_word boolean
Default: false
temp_filter object

hide specific temperature sensors, network interfaces, and disks using filters

5 nested properties
is_list_ignored boolean
Default: true
list array
regex boolean
Default: true
case_sensitive boolean
Default: false
whole_word boolean
Default: false
net_filter object

hide specific temperature sensors, network interfaces, and disks using filters

5 nested properties
is_list_ignored boolean
Default: true
list array
regex boolean
Default: true
case_sensitive boolean
Default: false
whole_word boolean
Default: false

Definitions

row object[]
filter object

hide specific temperature sensors, network interfaces, and disks using filters

is_list_ignored boolean
Default: true
list array
regex boolean
Default: true
case_sensitive boolean
Default: false
whole_word boolean
Default: false