ModuleReference

command

Execute a command and display the output

Options

Option	Type	Description	Default
exec	string	Command to execute	''
class	string	The class to use	'system'
icon	string	Name of custom icon to be put in front of the output	''

Icons

Name	Icon

diskfree

Display the amount of free disk space for the current path

Options

Option	Type	Description	Default
si	boolean	Use SI magnitudes (MiB,KiB etc)	true

Icons

Name	Icon

git

Show status from git repositories

Options

Option	Type	Description	Default
tag	boolean	Show tag	false
status	boolean	Show branch and status	true

Icons

Name	Icon
git.branch	
git.is_changed	
git.is_current	
git.need_push	
git.need_pull	
git.tag	

hostname

Show the hostname of the system

Options

Option	Type	Description	Default
class	string	The class to use	'system'

Icons

Name	Icon

ip

Show the IP of a networking device

Options

Option	Type	Description	Default
interface	string	The interface to dispaly	'eth0'

Icons

Name	Icon

loadavg

Display system load average

Options

Option	Type	Description	Default

Icons

Name	Icon
loadavg.icon	

path

Show the current working directory

Options

Option	Type	Description	Default
length	int	If greater than 0, max length of displayed path	0

Icons

Name	Icon

status

Last command status and uid/root indicator

Options

Option	Type	Description	Default

Icons

Name	Icon

text

Show a static text

Options

Option	Type	Description	Default
text	string	The text to dispaly	'Text'
class	string	The class to use	'info'
icon	string	Name of custom icon to be put in front of the output	''

Icons

Name	Icon

thermal

Show thermal zone (cpu/gpu/chassis temperature) info from sysfs

Options

Option	Type	Description	Default
zone	string	Thermal zone (from /sys/class/thermal)	'thermal_zone0'
format	string	Format	'%.1fºc'
class	string	The class to use	'system'

Icons

Name	Icon
thermal.icon

time

Show the current time and/or date, and optionally an analog clock

Options

Option	Type	Description	Default
format	string	The time format	'H:i'
class	string	The class to use	'info'
analog	boolean	Show an analog clock	false

Icons

Name	Icon

tux

Add a cute penguin to your prompt

Options

Option	Type	Description	Default
class	string	The class to use	'tux'

Icons

Name	Icon
tux.icon	🐧

username

The currently logged in/active username

Options

Option	Type	Description	Default
class	string	The class to use	'user'

Icons

Name	Icon
username.icon