Return the current VCS branch.
Parameters: |
|
---|
Highlight groups used: branch_clean, branch_dirty, branch.
Return the average CPU load as a percentage.
Requires the psutil module.
Parameters: | format (str) – Output format. Accepts measured CPU load as the first argument. |
---|
Highlight groups used: cpu_load_percent_gradient (gradient) or cpu_load_percent.
Return system load average.
Highlights using system_load_good, system_load_bad and system_load_ugly highlighting groups, depending on the thresholds passed to the function.
Parameters: |
|
---|
Divider highlight group used: background:divider.
Highlight groups used: system_load_gradient (gradient) or system_load.
Return system uptime.
Parameters: |
|
---|
Divider highlight group used: background:divider.
Return external IP address.
Parameters: | query_url (str) – URI to query for IP address, should return only the IP address as a text string Suggested URIs:
|
---|
Divider highlight group used: background:divider.
Return the current hostname.
Parameters: |
|
---|
Return internal IP address
Requires netifaces module to work properly.
Parameters: |
|
---|
Return the network load.
Uses the psutil module if available for multi-platform compatibility, falls back to reading /sys/class/net/interface/statistics/rx,tx_bytes.
Parameters: |
|
---|
Divider highlight group used: background:divider.
Highlight groups used: network_load_sent_gradient (gradient) or network_load_recv_gradient (gradient) or network_load_gradient (gradient), network_load_sent or network_load_recv or network_load.
Return the current working directory.
Returns a segment list to create a breadcrumb-like effect.
Parameters: |
|
---|
Divider highlight group used: cwd:divider.
Highlight groups used: cwd:current_folder or cwd. It is recommended to define all highlight groups.
Return the value of any defined environment variable
Parameters: | variable (string) – The environment variable to return if found |
---|
Return the current user.
Parameters: | hide_user (str) – Omit showing segment for users with names equal to this string. |
---|
Highlights the user with the superuser if the effective user ID is 0.
Highlight groups used: superuser or user. It is recommended to define all highlight groups.
Return battery charge status.
Parameters: |
|
---|
battery_gradient and battery groups are used in any case, first is preferred.
Highlight groups used: battery_full or battery_gradient (gradient) or battery, battery_empty or battery_gradient (gradient) or battery.
Return weather from Yahoo! Weather.
Uses GeoIP lookup from http://freegeoip.net/ to automatically determine your current location. This should be changed if you’re in a VPN or if your IP address is registered at another location.
Returns a list of colorized icon and temperature segments depending on weather conditions.
Parameters: |
|
---|
Divider highlight group used: background:divider.
Highlight groups used: weather_conditions or weather, weather_temp_gradient (gradient) or weather. Also uses weather_conditions_{condition} for all weather conditions supported by Yahoo.
Return the current date.
Parameters: |
|
---|
Divider highlight group used: time:divider.
Highlight groups used: time or date.
Return unread e-mail count for IMAP servers.
Parameters: |
|
---|
Highlight groups used: email_alert_gradient (gradient), email_alert.
Return clementine player information
Requires dbus python module.
This player segment should be added like this:
{
"function": "powerline.segments.common.players.clementine",
"name": "player"
}
(with additional "args": {…} if needed).
Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.
Parameters: |
|
---|
Return CMUS player information
Requires cmus-remote command be acessible from $PATH.
This player segment should be added like this:
{
"function": "powerline.segments.common.players.cmus",
"name": "player"
}
(with additional "args": {…} if needed).
Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.
Parameters: |
|
---|
Return generic dbus player state
This player segment should be added like this:
{
"function": "powerline.segments.common.players.dbus_player",
"name": "player"
}
(with additional "args": {…} if needed).
Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.
Parameters: |
|
---|
Return Music Player Daemon information
Requires mpc command to be acessible from $PATH or mpd Python module.
This player segment should be added like this:
{
"function": "powerline.segments.common.players.mpd",
"name": "player"
}
(with additional "args": {…} if needed).
Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.
Parameters: |
|
---|
Return rdio player information
Requires osascript available in $PATH.
This player segment should be added like this:
{
"function": "powerline.segments.common.players.rdio",
"name": "player"
}
(with additional "args": {…} if needed).
Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.
Parameters: |
|
---|
Return rhythmbox player information
Requires rhythmbox-client available in $PATH.
This player segment should be added like this:
{
"function": "powerline.segments.common.players.rhythmbox",
"name": "player"
}
(with additional "args": {…} if needed).
Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.
Parameters: |
|
---|
Return spotify player information
Requires dbus python module.
This player segment should be added like this:
{
"function": "powerline.segments.common.players.spotify",
"name": "player"
}
(with additional "args": {…} if needed).
Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.
Parameters: |
|
---|
Return spotify player information
Requires osascript available in $PATH.
This player segment should be added like this:
{
"function": "powerline.segments.common.players.spotify_apple_script",
"name": "player"
}
(with additional "args": {…} if needed).
Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.
Parameters: |
|
---|
Return spotify player information
Requires dbus python module.
This player segment should be added like this:
{
"function": "powerline.segments.common.players.spotify",
"name": "player"
}
(with additional "args": {…} if needed).
Highlight groups used: player_fallback or player, player_play or player, player_pause or player, player_stop or player.
Parameters: |
|
---|