Module: CPU

Note

This page is auto-generated from man/waybar-cpu.5.scd, man/waybar-cpu-graph.5.scd on the master branch. Do not edit it here — changes will be overwritten on the next sync. To update it, edit the man page(s) and open a PR.

cpu

DESCRIPTION

The cpu module displays the current CPU utilization.

CONFIGURATION

Option	Typeof	Default	Description
interval	integer or float	10	The interval in which the information gets polled. Minimum value is 0.001 (1ms). Values smaller than 1ms will be set to 1ms.
format	string	{usage}%	The format, how information should be displayed. On {} data gets inserted.
format-icons	array/object		Based on the current usage, the corresponding icon gets selected. The order is low to high. Or by the state if it is an object.
max-length	integer		The maximum length in character the module should display.
min-length	integer		The minimum length in characters the module should accept.
align	float		The alignment of the label within the module, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.
justify	string		The alignment of the text within the module's label, allowing options 'left', 'right', or 'center' to define the positioning.
rotate	integer		Positive value to rotate the text label (in 90 degree increments).
states	object		A number of CPU usage states which get activated on certain usage levels. See waybar-states(5).
on-click	string		Command to execute when clicked on the module.
on-click-middle	string		Command to execute when middle-clicked on the module using mousewheel.
on-click-right	string		Command to execute when you right-click on the module.
on-update	string		Command to execute when the module is updated.
on-scroll-up	string		Command to execute when scrolling up on the module.
on-scroll-down	string		Command to execute when scrolling down on the module.
smooth-scrolling-threshold	double		Threshold to be used when scrolling.
tooltip	bool	true	Option to disable tooltip on hover.
tooltip-format	string		The format of the tooltip shown on hover. Supports the same replacements as format.
format-<state>	string		The format to use when the given state (see states) is active. Supports the same replacements as format.
tooltip-format-<state>	string		The tooltip format to use when the given state (see states) is active. Takes precedence over tooltip-format.
expand	bool	false	Enables this module to consume all left over space dynamically.

FORMAT REPLACEMENTS

{load}: Current CPU load.

{load1}: CPU load average over the last minute.

{load5}: CPU load average over the last 5 minutes.

{load15}: CPU load average over the last 15 minutes.

{usage}: Current overall CPU usage.

{usage{n}}: Current CPU core n usage. Cores are numbered from zero, so first core will be {usage0} and 4th will be {usage3}.

{avg_frequency}: Current CPU average frequency (based on all cores) in GHz.

{max_frequency}: Current CPU max frequency (based on the core with the highest frequency) in GHz.

{min_frequency}: Current CPU min frequency (based on the core with the lowest frequency) in GHz.

{icon}: Icon for overall CPU usage.

{icon{n}}: Icon for CPU core n usage. Use like {icon0}.

{icons}: All per-core icons concatenated. Equivalent to {icon0}{icon1}...{iconN} but adapts to the number of cores automatically.

EXAMPLES

Basic configuration:

"cpu": {
	"interval": 10,
	"format": "{}% ",
	"max-length": 10
}

CPU usage per core rendered as icons:

"cpu": {
	"interval": 1,
	"format": "{icon0}{icon1}{icon2}{icon3} {usage:>2}% ",
	"format-icons": ["▁", "▂", "▃", "▄", "▅", "▆", "▇", "█"],
},

Automatically determine number of icons according to number of logical cores:

"cpu": {
	"interval": 1,
	"format": "{icons} {usage:>2}% ",
	"format-icons": ["▁", "▂", "▃", "▄", "▅", "▆", "▇", "█"],
},

STYLE

• #cpu

cpu/graph

DESCRIPTION

The cpu graph module displays a line graph with the CPU utilization.

CONFIGURATION

Option	Typeof	Default	Description
interval	integer or float	5	The interval in which the information gets polled.
graph_type	string	line	The rendering style of the graph. One of 'line', 'bar', or 'gauge'.
width	integer		The length in pixels the module should display.
datapoints	integer		How many data points to show.
on-click	string		Command to execute when clicked on the module.
on-click-middle	string		Command to execute when middle-clicked on the module using mousewheel.
on-click-right	string		Command to execute when you right-click on the module.
on-update	string		Command to execute when the module is updated.
on-scroll-up	string		Command to execute when scrolling up on the module.
on-scroll-down	string		Command to execute when scrolling down on the module.
smooth-scrolling-threshold	double		Threshold to be used when scrolling.
tooltip	bool	true	Option to disable tooltip on hover.
expand	bool	false	Enables this module to consume all left over space dynamically.

EXAMPLES

Basic configuration:

"cpu_graph": {
	"interval": 2,
	"width": 10
}

STYLE

• #cpu_graph

• .cpu-intensive

• .cpu-high

• .cpu-moderate