Github url

powerlevel9k

by Powerlevel9k

Powerlevel9k /powerlevel9k

Powerlevel9k was a tool for building a beautiful and highly functional CLI, customized for you. P9k ...

12.8K Stars 935 Forks Last release: over 1 year ago (v0.6.7) MIT License 1.7K Commits 16 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Powerlevel9k is deprecated and now unmaintained. Please use Powerlevel10k!


Build StatusJoin the chat at https://gitter.im/bhilburn/powerlevel9k

Powerlevel9k is a theme for ZSH which uses Powerline Fonts. It can be used with vanilla ZSH or ZSH frameworks such as Oh-My-Zsh,Prezto,Antigen, and many others.

Get more out of your terminal. Be a badass. Impress everyone in 'Screenshot Your Desktop' threads. Use powerlevel9k.

You can check out some other users' configurations in our wiki: Show Off Your Config.

There are a number of Powerline ZSH themes available, now. The developers of this theme focus on four primary goals:

  1. Give users a great out-of-the-box configuration with no additional configuration required.
  2. Make customization easy for users who do want to tweak their prompt.
  3. Provide useful segments that you can enable to make your prompt even more effective and helpful. We have prompt segments for everything from unit test coverage to your AWS instance.
  4. Optimize the code for execution speed as much as possible. A snappy terminal is a happy terminal.

Powerlevel9k can be used to create both very useful and beautiful terminal environments:

Table of Contents

  1. Installation
  2. Customization
    1. Stylizing Your Prompt
    2. Customizing Prompt Segments
    3. Available Prompt Segments
  3. Troubleshooting

Be sure to also check out the Wiki!

Installation

There are two installation steps to go from a vanilla terminal to a PL9k terminal. Once you are done, you can optionally customize your prompt.

Installation Instructions

  1. Install the Powerlevel9k Theme
  2. Install Powerline Fonts

No configuration is necessary post-installation if you like the default settings, but there are plenty of segment customization options available if you are interested.

Prompt Customization

Be sure to check out the wiki page on the additional prompt customization options, including color and icon settings: Stylizing Your Prompt

Customizing Prompt Segments

Customizing your prompt is easy! Select the segments you want to have displayed, and then assign them to either the left or right prompt by adding the following variables to your

~/.zshrc

.

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_LEFT\_PROMPT\_ELEMENTS

|

(context dir vcs)

|Segment list for left prompt| |

POWERLEVEL9K\_RIGHT\_PROMPT\_ELEMENTS

|

(status root\_indicator background\_jobs history time)

|Segment list for right prompt|

The table above shows the default values, so if you wanted to set these variables manually, you would put the following in your

~/.zshrc

:

zsh POWERLEVEL9K\_LEFT\_PROMPT\_ELEMENTS=(context dir vcs) POWERLEVEL9K\_RIGHT\_PROMPT\_ELEMENTS=(status root\_indicator background\_jobs history time)

Available Prompt Segments

The segments that are currently available are:

System Status Segments:* [

background\_jobs

](https://github.com/Powerlevel9k/powerlevel9k/blob/master/#background_jobs) - Indicator for background jobs. * [

battery

](https://github.com/Powerlevel9k/powerlevel9k/blob/master/#battery) - Current battery status. * [

context

](https://github.com/Powerlevel9k/powerlevel9k/blob/master/#context) - Your username and host, conditionalized based on $USER and SSH status. * [

date

](https://github.com/Powerlevel9k/powerlevel9k/blob/master/#date) - System date. * [

dir

](https://github.com/Powerlevel9k/powerlevel9k/blob/master/#dir) - Your current working directory. *

dir\_writable

Development Environment Segments:* [

vcs

](https://github.com/Powerlevel9k/powerlevel9k/blob/master/#vcs) - Information about this

git

or

hg

repository (if you are in one).

Language Segments:* GoLang Segments: *

go\_version

Cloud Segments:* AWS Segments: * [

aws

](https://github.com/Powerlevel9k/powerlevel9k/blob/master/#aws) - The current AWS profile, if active. *

aws\_eb\_env
  • The current Elastic Beanstalk Environment. *
    docker\_machine
  • The current Docker Machine. *
    kubecontext
  • The current context of your
    kubectl
    configuration. *
    dropbox
  • Indicates Dropbox directory and syncing status using
    dropbox-cli

Other:* [

custom\_command

](https://github.com/Powerlevel9k/powerlevel9k/blob/master/#custom_command) - Create a custom segment to display the output of an arbitrary command. * [

command\_execution\_time

](https://github.com/Powerlevel9k/powerlevel9k/blob/master/#command_execution_time) - Display the time the current command took to execute. * [

todo

](http://todotxt.com/) - Shows the number of tasks in your todo.txt tasks file. *

detect\_virt
  • Virtualization detection with systemd *
    newline
  • Continues the prompt on a new line. *
    openfoam
  • Shows the currently sourced OpenFOAM environment.

anaconda

This segment shows your active anaconda environment. It relies on either the

CONDA\_ENV\_PATH

or the

CONDA\_PREFIX

(depending on the

conda

version) environment variable to be set which happens when you properly

source activate

an environment.

Special configuration variables:

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_ANACONDA\_LEFT\_DELIMITER

|"("|The left delimiter just before the environment name.| |

POWERLEVEL9K\_ANACONDA\_RIGHT\_DELIMITER

|")"|The right delimiter just after the environment name.|

Additionally the following segment specific parameters can be used to customize it:

POWERLEVEL9K\_PYTHON\_ICON

,

POWERLEVEL9K\_ANACONDA\_BACKGROUND

, and

POWERLEVEL9K\_ANACONDA\_FOREGROUND

.

aws

If you would like to display the current AWS profile, add the

aws

segment to one of the prompts, and define

AWS\_DEFAULT\_PROFILE

in your

~/.zshrc

:

| Variable | Default Value | Description | |----------|---------------|-------------| |

AWS\_DEFAULT\_PROFILE

|None|Your AWS profile name|

background_jobs

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_BACKGROUND\_JOBS\_VERBOSE

|

true

|If there is more than one background job, this segment will show the number of jobs. Set this to

false

to turn this feature off.|

POWERLEVEL9K\_BACKGROUND\_JOBS\_VERBOSE\_ALWAYS

|

false

|Always show the jobs count (even if it's zero).|

battery

The default settings for this segment will display your current battery status (fails gracefully on systems without a battery). It is supported on both OSX and Linux (note that it requires

acpi

on Linux).

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_BATTERY\_CHARGING

|

"yellow"

|Color to indicate a charging battery.| |

POWERLEVEL9K\_BATTERY\_CHARGED

|

"green"

|Color to indicate a charged battery.| |

POWERLEVEL9K\_BATTERY\_DISCONNECTED

|

$DEFAULT\_COLOR

|Color to indicate absence of battery.| |

POWERLEVEL9K\_BATTERY\_LOW\_THRESHOLD

|

10

|Threshold to consider battery level critical.| |

POWERLEVEL9K\_BATTERY\_LOW\_COLOR

|

"red"

|Color to indicate critically low charge level.| |

POWERLEVEL9K\_BATTERY\_VERBOSE

|

true

|Display time remaining next to battery level.| |

POWERLEVEL9K\_BATTERY\_HIDE\_ABOVE\_THRESHOLD

|

unset

|Threshold from which the battery segment should not be displayed.|

Note that you can [modify the

\_FOREGROUND

color](https://github.com/bhilburn/powerlevel9k/wiki/Stylizing-Your-Prompt#segment-color-customization)without affecting the icon color.

You can also change the battery icon automatically depending on the battery level. This will override the default battery icon. In order to do this, you need to define the

POWERLEVEL9k\_BATTERY\_STAGES

variable.

| Variable | Default Value | Description | |-------------------------------|---------------|---------------------------------------------------------------| |

POWERLEVEL9K\_BATTERY\_STAGES

| Unset | A string or array, which each index indicates a charge level. |

Powerlevel9k will use each index of the string or array as a stage to indicate battery charge level, progressing from left to right. You can provide any number of stages. The setting below, for example, provides 8 stages for Powerlevel9k to use.

zsh POWERLEVEL9K\_BATTERY\_STAGES="▁▂▃▄▅▆▇█"

If you require extra spacing after the icon, you will have to set it as an array, since spaces in the string will be used as one of the stages and you will get a missing icon. To do this, declare the variable as follows:

zsh POWERLEVEL9K\_BATTERY\_STAGES=($'\u2581 ' $'\u2582 ' $'\u2583 ' $'\u2584 ' $'\u2585 ' $'\u2586 ' $'\u2587 ' $'\u2588 ')

Using the array syntax, you can create stages comprised of multiple characters. The below setting provides 40 battery stages.

zsh POWERLEVEL9K\_BATTERY\_STAGES=( $'▏ ▏' $'▎ ▏' $'▍ ▏' $'▌ ▏' $'▋ ▏' $'▊ ▏' $'▉ ▏' $'█ ▏' $'█▏ ▏' $'█▎ ▏' $'█▍ ▏' $'█▌ ▏' $'█▋ ▏' $'█▊ ▏' $'█▉ ▏' $'██ ▏' $'██ ▏' $'██▎ ▏' $'██▍ ▏' $'██▌ ▏' $'██▋ ▏' $'██▊ ▏' $'██▉ ▏' $'███ ▏' $'███ ▏' $'███▎ ▏' $'███▍ ▏' $'███▌ ▏' $'███▋ ▏' $'███▊ ▏' $'███▉ ▏' $'████ ▏' $'████ ▏' $'████▎▏' $'████▍▏' $'████▌▏' $'████▋▏' $'████▊▏' $'████▉▏' $'█████▏' )

You can also change the background of the segment automatically depending on the battery level. This will override the following variables:

POWERLEVEL9K\_BATTERY\_CHARGING

,

POWERLEVEL9K\_BATTERY\_CHARGED

,

POWERLEVEL9K\_BATTERY\_DISCONNECTED

, and

POWERLEVEL9K\_BATTERY\_LOW\_COLOR

. In order to do this, define a color array, from low to high, as shown below:

zsh POWERLEVEL9K\_BATTERY\_LEVEL\_BACKGROUND=(red1 orangered1 darkorange orange1 gold1 yellow1 yellow2 greenyellow chartreuse1 chartreuse2 green1)

As with the battery stages, you can use any number of colors and Powerlevel9k will automatically use all of them appropriately.

Some example settings:

| Brightness | Possible Array | |----------------|---------------------------------------------------------------------------------------------------------------| | Bright Colors |

(red1 orangered1 darkorange orange1 gold1 yellow1 yellow2 greenyellow chartreuse1 chartreuse2 green1)

| | Normal Colors |

(red3 darkorange3 darkgoldenrod gold3 yellow3 chartreuse2 mediumspringgreen green3 green3 green4 darkgreen)

| | Subdued Colors |

(darkred orange4 yellow4 yellow4 chartreuse3 green3 green4 darkgreen)

|

chruby

This segment shows the version of Ruby being used when using

chruby

to change your current Ruby stack.

It uses

$RUBY\_ENGINE

and

$RUBY\_VERSION

as set by

chruby

.

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_CHRUBY\_SHOW\_ENGINE

|true|Show the currently selected Ruby engine (e.g.

ruby

,

jruby

,

rbx

, etc) |

POWERLEVEL9K\_CHRUBY\_SHOW\_VERSION

|true|Shows the currently selected engine's version (e.g.

2.5.1

)

command_execution_time

Display the time the previous command took to execute if the time is above

POWERLEVEL9K\_COMMAND\_EXECUTION\_TIME\_THRESHOLD

. The time is formatted to be "human readable", and so scales the units based on the length of execution time. If you want more precision, just set the

POWERLEVEL9K\_COMMAND\_EXECUTION\_TIME\_PRECISION

field.

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_COMMAND\_EXECUTION\_TIME\_THRESHOLD

|3|Threshold above which to print this segment. Can be set to

0

to always print.| |

POWERLEVEL9K\_COMMAND\_EXECUTION\_TIME\_PRECISION

|2|Number of digits to use in the fractional part of the time value.|

custom_command

The

custom\_...

segment allows you to turn the output of a custom command into a prompt segment. As an example, if you wanted to create a custom segment to display your WiFi signal strength, you might define a custom segment called

custom\_wifi\_signal

like this:

zsh POWERLEVEL9K\_LEFT\_PROMPT\_ELEMENTS=(context time battery dir vcs virtualenv custom\_wifi\_signal) POWERLEVEL9K\_CUSTOM\_WIFI\_SIGNAL="echo signal: \$(nmcli device wifi | grep yes | awk '{print \$8}')" POWERLEVEL9K\_CUSTOM\_WIFI\_SIGNAL\_BACKGROUND="blue" POWERLEVEL9K\_CUSTOM\_WIFI\_SIGNAL\_FOREGROUND="yellow"

If you prefer, you can also define the function in your

.zshrc

rather than putting it in-line with the variable export, as shown above. Just don't forget to invoke your function from your segment! Example code that achieves the same result as the above: ```zsh zsh_wifi_signal(){ local signal=$(nmcli device wifi | grep yes | awk '{print $8}') local color='%F{yellow}' [[$signal -gt 75]] && color='%F{green}' [[$signal -lt 50]] && color='%F{red}' echo -n "%{$color%}\uf230 $signal%{%f%}" # \uf230 is  }

POWERLEVEL9K_CUSTOM_WIFI_SIGNAL="zsh_wifi_signal" POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(context time battery dir vcs virtualenv custom_wifi_signal) ``` The command, above, gives you the wireless signal segment shown below:

signal

You can define as many custom segments as you wish. If you think you have a segment that others would find useful, please consider upstreaming it to the main theme distribution so that everyone can use it!

context

The

context

segment ([email protected] string) is conditional. By default, it will only print if you are not your 'normal' user (including if you are root), or if you are SSH'd to a remote host.

SUDO

and

REMOTE\_SUDO

states are also available to show whether the current user or remote user has superuser privileges.

To use this feature, make sure the

context

segment is enabled in your prompt elements (it is by default), and define a

DEFAULT\_USER

in your

~/.zshrc

.

You can customize the

context

segment. For example, you can make it to print the full hostname by setting

POWERLEVEL9K\_CONTEXT\_TEMPLATE="%[email protected]`hostname -f`"

You can set the

POWERLEVEL9K\_CONTEXT\_HOST\_DEPTH

variable to change how the hostname is displayed. See ZSH Manualfor details. The default is set to %m which will show the hostname up to the first ‘.’ You can set it to %{N}m where N is an integer to show that many segments of system hostname. Setting N to a negative integer will show that many segments from the end of the hostname.

| Variable | Default Value | Description | |----------|---------------|-------------| |

DEFAULT\_USER

|None|Username to consider a "default context" (you can also set

$USER

).| |

POWERLEVEL9K\_ALWAYS\_SHOW\_CONTEXT

|false|Always show this segment, including $USER and hostname.| |

POWERLEVEL9K\_ALWAYS\_SHOW\_USER

|false|Always show the username, but conditionalize the hostname.| |

POWERLEVEL9K\_CONTEXT\_TEMPLATE

|%[email protected]%m|Default context prompt ([email protected]). Refer to the ZSH Documentation for all possible expansions, including deeper host depths.|

This segment can have different states. They might help you to visualize your different privileges. Read more about styling with states here.

| State | Meaning | |---------------|----------------------------------------------------------| |

DEFAULT

| You are a normal user | |

ROOT

| You are the root user | |

SUDO

| You are using elevated rights | |

REMOTE\_SUDO

| You are SSH'ed into the machine and have elevated rights | |

REMOTE

| You are SSH'ed into the machine |

date

The

date

segment shows the current system date.

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_DATE\_FORMAT

|

%D{%d.%m.%y}

|ZSH time format to use in this segment.|

dir

The

dir

segment shows the current working directory. When using the "Awesome Powerline" fonts, there are additional glyphs, as well:

|

Compatible

|

Powerline

|

Awesome Powerline

| Situation |------------|-----------|-------------------|---------------------------- | None | None | | At the root of your home folder | | None | None | | Within a subfolder of your home directory | | None | None | | Outside of your home folder | | None | None | ⚙ | Within the

/etc

directory |

To turn off these icons you could set these variables to an empty string.

zsh POWERLEVEL9K\_HOME\_ICON='' POWERLEVEL9K\_HOME\_SUB\_ICON='' POWERLEVEL9K\_FOLDER\_ICON='' POWERLEVEL9K\_ETC\_ICON=''

You can limit the output to a certain length by truncating long paths. Customizations available are:

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_DIR\_PATH\_ABSOLUTE

|None|If set to

true

, will use absolute paths instead of home folder abbreviation

~

| |

POWERLEVEL9K\_SHORTEN\_DIR\_LENGTH

|

2

|If your shorten strategy, below, is entire directories, this field determines how many directories to leave at the end. If your shorten strategy is by character count, this field determines how many characters to allow per directory string.| |

POWERLEVEL9K\_SHORTEN\_STRATEGY

|None|How the directory strings should be truncated. See the table below for more informations.| |

POWERLEVEL9K\_SHORTEN\_DELIMITER

|

..

|Delimiter to use in truncated strings. This can be any string you choose, including an empty string if you wish to have no delimiter.|

| Strategy Name | Description | |---------------|-------------| |Default|Truncate whole directories from left. How many is defined by

POWERLEVEL9K\_SHORTEN\_DIR\_LENGTH

| |

truncate\_absolute\_chars

|Truncates an absolute number of characters from the left such that the number of characters that your path displays (with or without

POWERLEVEL9K\_SHORTEN\_DELIMITER

) is no more than

POWERLEVEL9K\_SHORTEN\_DIR\_LENGTH
  • the length of
    POWERLEVEL9K\_SHORTEN\_DELIMITER
    | |
    truncate\_middle
    |Truncates the middle part of a folder. E.g. you are in a folder named
    ~/MySuperProjects/AwesomeFiles/BoringOffice
    , then it will truncated to
    ~/MyS..cts/Awe..les/BoringOffice
    , if
    POWERLEVEL9K\_SHORTEN\_DIR\_LENGTH=3
    is also set (controls the amount of characters to be left).| |
    truncate\_from\_right
    |Just leaves the beginning of a folder name untouched. E.g. your folders will be truncated like so:
    /ro../Pr../office
    . How many characters will be untouched is controlled by
    POWERLEVEL9K\_SHORTEN\_DIR\_LENGTH
    .| |
    truncate\_absolute
    |Truncates everything exept the last few characters in the path. E.g. if you are in a folder named
    ~/Projects/powerlevel9k
    and you have set
    POWERLEVEL9K\_SHORTEN\_DIR\_LENGTH=3
    , you will get
    ..l9k
    .| |
    truncate\_to\_last
    |Truncates everything before the last folder in the path.| |
    truncate\_to\_first\_and\_last
    |Truncate middle directories from the path. How many directories will be untouched is controlled by
    POWERLEVEL9K\_SHORTEN\_DIR\_LENGTH
    . E.g. if you are in a folder named
    ~/Projects/powerlevel9k
    and you have set
    POWERLEVEL9K\_SHORTEN\_DIR\_LENGTH=1
    , you will get
    ~/../powerlevel9k
    .|| |
    truncate\_to\_unique
    |Parse all parent path components and truncate them to the shortest unique length. If you copy & paste the result to a shell, after hitting
    TAB
    it should expand to the original path unambiguously.| |
    truncate\_with\_package\_name
    |Search for a
    package.json
    or
    composer.json
    and prints the
    name
    field to abbreviate the directory path. The precedence and/or files could be set by
    POWERLEVEL9K\_DIR\_PACKAGE\_FILES=(package.json composer.json)
    . If you have jq installed, it will dramatically improve the speed of this strategy.| |
    truncate\_with\_folder\_marker
    |Search for a file that is specified by
    POWERLEVEL9K\_SHORTEN\_FOLDER\_MARKER
    and truncate everything before that (if found, otherwise stop on $HOME and ROOT).|

For example, if you wanted the truncation behavior of the

fish

shell, which truncates

/usr/share/plasma

to

/u/s/plasma

, you would use the following:

zsh POWERLEVEL9K\_SHORTEN\_DIR\_LENGTH=1 POWERLEVEL9K\_SHORTEN\_DELIMITER="" POWERLEVEL9K\_SHORTEN\_STRATEGY="truncate\_from\_right"

In each case you have to specify the length you want to shorten the directory to. So in some cases

POWERLEVEL9K\_SHORTEN\_DIR\_LENGTH

means characters, in others whole directories.

The

truncate\_with\_package\_name

strategy gives your directory path relative to the root of your project. For example, if you have a project inside

$HOME/projects/my-project

with a

package.json

that looks like:

{ "name": "my-cool-project" }

The path shown would be

my-cool-project

. If you navigate to

$HOME/projects/my-project/src

, then the path shown would be

my-cool-project/src

. Please note that this currently looks for

.git

directory to determine the root of the project.

If you want to customize the directory separator, you could set: ```zsh

Double quotes are important here!

POWERLEVEL9K_DIR_PATH_SEPARATOR="%F{red} $(print_icon 'LEFT_SUBSEGMENT_SEPARATOR') %F{black}" ``

To omit the first character (usually a slash that gets replaced if you set

POWERLEVEL9K_DIR_PATH_SEPARATOR

), you could set

POWERLEVEL9K_DIR_OMIT_FIRST_CHARACTER=true`.

You can also customize the leading tilde character when you are in

$HOME

using: ```zsh

Double quotes are important here!

POWERLEVEL9K_HOME_FOLDER_ABBREVIATION="%F{red} $(print_icon 'HOME_ICON') %F{black}" ``

You can also configure the

dir` segment to show when you are in a directory without write permissions, using the variable below.

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_DIR\_SHOW\_WRITABLE

|

false

|If set to

true

and you are in a directory that you do not have write permissions for, this segment will display a lock icon and enter the

NOT\_WRITABLE

state (which can be customized per our usual process). Note that this functionality is also available in a separate segment,

dir\_writable

.|

If you want to customize the last directory of the path, you can now set

POWERLEVEL9K\_DIR\_PATH\_HIGHLIGHT\_FOREGROUND

to a custom color and/or

POWERLEVEL9K\_DIR\_PATH\_HIGHLIGHT\_BOLD=true

to display that part in bold.

You can also color the separator separately by setting the color using

POWERLEVEL9K\_DIR\_PATH\_SEPARATOR\_FOREGROUND

.

disk_usage

The

disk\_usage

segment will show the usage level of the partition that your current working directory resides in. It can be configured with the following variables.

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_DISK\_USAGE\_ONLY\_WARNING

|false|Hide the segment except when usage levels have hit warning or critical levels.| |

POWERLEVEL9K\_DISK\_USAGE\_WARNING\_LEVEL

|90|The usage level that triggers a warning state.| |

POWERLEVEL9K\_DISK\_USAGE\_CRITICAL\_LEVEL

|95|The usage level that triggers a critical state.|

host

The

host

segment will print the hostname.

You can set the

POWERLEVEL9K\_HOST\_TEMPLATE

variable to change how the hostname is displayed. See (ZSH Manual)[http://zsh.sourceforge.net/Doc/Release/Prompt-Expansion.html#Login-information] for details. The default is set to

%m

which will show the hostname up to the first

.

. You can set it to

%{N}m

where N is an integer to show that many segments of system hostname. Setting

N

to a negative integer will show that many segments from the end of the hostname.

POWERLEVEL9K\_HOST\_TEMPLATE="%2m"

By default, LOCAL hosts will show the host icon and remote hosts will show the SSH icon. You can override them by setting

POWERLEVEL9K\_HOST\_ICON="\uF109 " POWERLEVEL9K\_SSH\_ICON="\uF489 "
ip

This segment tries to examine all currently used network interfaces and prints the first address it finds. In the case that this is not the right NIC, you can specify the correct network interface by setting:

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_IP\_INTERFACE

|None|The NIC for which you wish to display the IP address. Example:

eth0

.|

vpn_ip

This segment tries to extract the VPN related IP addresses from nmcli, based on the NIC type:

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_VPN\_IP\_INTERFACE

|

tun

|The VPN interface.|

public_ip

This segment will display your public IP address. There are several methods of obtaining this information and by default it will try all of them starting with the most efficient. You can also specify which method you would like it to use. The methods available are dig using opendns, curl, or wget. The host used for wget and curl is http://ident.me by default but can be set to another host if you prefer.

If you activate a VPN, the icon for this segment will change to the defined VPN icon.

The public_ip segment will attempt to update your public IP address every 5 minutes by default(also configurable by the user). If you lose connection your cached IP address will be displayed until your timeout expires at which point every time your prompt is generated a new attempt will be made. Until an IP is successfully pulled the value of $POWERLEVEL9K_PUBLIC_IP_NONE will be displayed for this segment. If this value is empty(the default)and $POWERLEVEL9K_PUBLIC_IP_FILE is empty the segment will not be displayed.

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_PUBLIC\_IP\_FILE

|'/tmp/p9k_public_ip'|This is the file your public IP is cached in.| |

POWERLEVEL9K\_PUBLIC\_IP\_HOST

|'http://ident.me'|This is the default host to get your public IP.| |

POWERLEVEL9K\_PUBLIC\_IP\_TIMEOUT

|300|The amount of time in seconds between refreshing your cached IP.| |

POWERLEVEL9K\_PUBLIC\_IP\_METHODS

|(dig curl wget)| These methods in that order are used to refresh your IP.| |

POWERLEVEL9K\_PUBLIC\_IP\_NONE

|None|The string displayed when an IP was not obtained|

load

Displays one of your load averages with appropriate state coloring. The thresholds are: -

0.7 \* NUM\_CORES \<

: critical -

0.5 \* NUM\_CORES \<

: warning -

less

: normal

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_LOAD\_WHICH

|5|Which average to show. Possible values: 1, 5 or 15|

newline

Puts a newline in your prompt so you can continue using segments on the next line. This allows you to use segments on both lines, unlike

POWERLEVEL9K\_PROMPT\_ON\_NEWLINE

, which simply separates segments from the prompt itself.

This only works on the left side. On the right side it does nothing.

nodeenv

Shows the currently used nodeenv. To avoid Nodeenvs activate command from interfering with Powerlevel9k, you should set

NODE\_VIRTUAL\_ENV\_DISABLE\_PROMPT=1

in your

~/.zshrc

.

rbenv

This segment shows the version of Ruby being used when using

rbenv

to change your current Ruby stack.

It figures out the version being used by taking the output of the

rbenv version-name

command.

  • If
    rbenv
    is not in $PATH, nothing will be shown.
  • By default, if the current local Ruby version is the same as the global Ruby version, nothing will be shown. See the configuration variable, below, to modify this behavior.

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_RBENV\_PROMPT\_ALWAYS\_SHOW

|

false

|Set to true if you wish to show the rbenv segment even if the current Ruby version is the same as the global Ruby version|

pyenv

This segment shows the version of Python being used when using

pyenv

to change your current Python stack.

The

PYENV\_VERSION

environment variable will be used if specified. Otherwise it figures out the version being used by taking the output of the

pyenv version-name

command.

  • If
    pyenv
    is not in $PATH, nothing will be shown.
  • If the current Python version is the same as the global Python version, nothing will be shown.

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_PYENV\_PROMPT\_ALWAYS\_SHOW

|

false

|Set to true if you wish to show the pyenv segment even if the current Python version is the same as the global Python version|

rspec_stats

See Unit Test Ratios, below.

status

This segment shows the return code of the last command.

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_STATUS\_CROSS

|

false

|Set to true if you wish not to show the error code when the last command returned an error and optionally hide this segment when the last command completed successfully by setting

POWERLEVEL9K\_STATUS\_OK

to false.| |

POWERLEVEL9K\_STATUS\_OK

|

true

|Set to true if you wish to show this segment when the last command completed successfully, false to hide it.| |

POWERLEVEL9K\_STATUS\_SHOW\_PIPESTATUS

|

true

|Set to true if you wish to show the exit status for all piped commands.| |

POWERLEVEL9K\_STATUS\_HIDE\_SIGNAME

|

false

|Set to true return the raw exit code (

1-255

). When set to false, values over 128 are shown as

SIGNAME(-n)

(e.g.

KILL(-9)

)|

ram

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_RAM\_ELEMENTS

|Both|Specify

ram\_free

or

swap\_used

to only show one or the other rather than both.|

symfony2_tests

See Unit Test Ratios, below.

time

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_TIME\_FORMAT

|

'H:M:S'

|ZSH time format to use in this segment.|

As an example, if you wanted a reversed time format, you would use this: ```zsh

Reversed time format

POWERLEVEL9K_TIME_FORMAT='%D{%S:%M:%H}'

If you are using an "Awesome Powerline Font", you can add a time symbol to this segment, as well:

zsh

Output time, date, and a symbol from the "Awesome Powerline Font" set

POWERLEVEL9K_TIME_FORMAT="%D{%H:%M:%S \uE868 %d.%m.%y}" ```

user

The

user

segment will print the username.

You can also override the icons by setting:

POWERLEVEL9K\_USER\_ICON="\uF415" #  POWERLEVEL9K\_ROOT\_ICON="#" POWERLEVEL9K\_SUDO\_ICON=$'\uF09C' # 

| Variable | Default Value | Description | |----------|---------------|-------------| |

DEFAULT\_USER

|None|Username to consider a "default context".| |

POWERLEVEL9K\_ALWAYS\_SHOW\_USER

|

false

|Always print this segment.| |

POWERLEVEL9K\_USER\_TEMPLATE

|

%n

|Default username prompt. Refer to the ZSH Documentation for all possible expansions|

vcs

By default, the

vcs

segment will provide quite a bit of information. Further customization is provided via:

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_HIDE\_BRANCH\_ICON

|

false

|Set to

true

to hide the branch icon from the segment.| |

POWERLEVEL9K\_SHOW\_CHANGESET

|

false

|Set to

true

to display the hash / changeset in the segment.| |

POWERLEVEL9K\_CHANGESET\_HASH\_LENGTH

|

12

|How many characters of the hash / changeset to display in the segment.| |

POWERLEVEL9K\_VCS\_SHOW\_SUBMODULE\_DIRTY

|

true

|Set to

false

to not reflect submodule status in the top-level repository prompt.| |

POWERLEVEL9K\_VCS\_HIDE\_TAGS

|

false

|Set to

true

to stop tags being displayed in the segment.| |

POWERLEVEL9K\_VCS\_GIT\_HOOKS

|

(vcs-detect-changes git-untracked git-aheadbehind git-stash git-remotebranch git-tagname)

|Layout of the segment for git repositories.| |

POWERLEVEL9K\_VCS\_HG\_HOOKS

|

(vcs-detect-changes)

|Layout of the segment for Mercurial repositories.| |

POWERLEVEL9K\_VCS\_SVN\_HOOKS

|

(vcs-detect-changes svn-detect-changes)

|Layout of the segment for SVN repositories.| |

POWERLEVEL9K\_VCS\_ACTIONFORMAT\_FOREGROUND

|

red

|The color of the foreground font during actions (e.g.,

REBASE

).|

vcs symbols

The

vcs

segment uses various symbols to tell you the state of your repository. These symbols depend on your installed font and selected

POWERLEVEL9K\_MODE

from the Installation section above.

|

Compatible

|

Powerline

|

Awesome Powerline

| Explanation |--------------|---------------------|-------------------|-------------------------- |

↑4

|

↑4

| icon_outgoing4 | Number of commits your repository is ahead of your remote branch |

↓5

|

↓5

| icon_incoming5 | Number of commits your repository is behind of your remote branch |

⍟3

|

⍟3

| icon_stash3 | Number of stashes, here 3. |

|

| icon_unstaged | There are unstaged changes in your working copy |

|

| icon_staged | There are staged changes in your working copy |

?

|

?

| icon_untracked | There are files in your working copy, that are unknown to your repository |

|

| icon_remote_tracking_branch | The name of your branch differs from its tracking branch. |

|

| icon_bookmark | A mercurial bookmark is active. |

@

| icon_branch_powerline | | Branch Icon | None | None | icon_commit2c3705 | The current commit hash. Here "2c3705" | None | None | icon_git | Repository is a git repository | None | None | icon_mercurial | Repository is a Mercurial repository

vcs truncation

You can limit the branch name to a certain length by truncating long names. Customizations available are:

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_VCS\_SHORTEN\_LENGTH

|None|This field determines how many characters to show.| |

POWERLEVEL9K\_VCS\_SHORTEN\_MIN\_LENGTH

|None|This field determines minimum branch length. Branch name will be truncated if its length greater than this field.| |

POWERLEVEL9K\_VCS\_SHORTEN\_STRATEGY

|None|This field determines how branch name should be truncated. See the table below for more information.| |

POWERLEVEL9K\_SHORTEN\_DELIMITER

|

...

|Delimiter to use in truncated strings. This can be any string you choose, including an empty string if you wish to have no delimiter.|

| Strategy Name | Description | |---------------|-------------| |

truncate\_middle

|Truncates the middle part of a branch. E.g. branch name is

1234-super\_super\_long\_branch\_name

, then it will truncated to

1234-...\_name

, if

POWERLEVEL9K\_VCS\_SHORTEN\_LENGTH=5

is also set (controls the amount of characters to be left).| |

truncate\_from\_right

|Just leaves the beginning of a branch name untouched. E.g. branch name will be truncated like so:

1234-...

. How many characters will be untouched is controlled by

POWERLEVEL9K\_VCS\_SHORTEN\_LENGTH

.|

For example, if you want to truncate

1234-super\_super\_long\_branch\_name

to

1234-..

and don't do it with

development

:

zsh POWERLEVEL9K\_VCS\_SHORTEN\_LENGTH=4 POWERLEVEL9K\_VCS\_SHORTEN\_MIN\_LENGTH=11 POWERLEVEL9K\_VCS\_SHORTEN\_STRATEGY="truncate\_from\_right" POWERLEVEL9K\_VCS\_SHORTEN\_DELIMITER=".."
vi_mode

This segment shows ZSH's current input mode. Note that this is only useful if you are using the ZSH Line Editor(VI mode). You can enable this either by

.zshrc

configuration or using a plugin, likeOh-My-Zsh's vi-mode plugin.

| Variable | Default Value | Description | |----------|---------------|-------------| |

POWERLEVEL9K\_VI\_INSERT\_MODE\_STRING

|

"INSERT"

|String to display while in 'Insert' mode.| |

POWERLEVEL9K\_VI\_COMMAND\_MODE\_STRING

|

"NORMAL"

|String to display while in 'Command' mode.|

To hide the segment entirely when in

INSERT

mode, set

POWERLEVEL9K\_VI\_INSERT\_MODE\_STRING=''
virtualenv

This segment shows your Python VirtualEnv. To avoid VirtualEnvs activate command from interfering with Powerlevel9k, you should set

VIRTUAL\_ENV\_DISABLE\_PROMPT=1

in your

~/.zshrc

.

Unit Test Ratios

The

symfony2\_tests

and

rspec\_stats

segments both show a ratio of "real" classes vs test classes in your source code. This is just a very simple ratio, and does not show your code coverage or any sophisticated stats. All this does is count your source files and test files, and calculate the ratio between them. Just enough to give you a quick overview about the test situation of the project you are dealing with.

Disabling / Enabling Powerlevel9k

You can disable P9k and return to a very basic prompt at any time simply by calling:

$ prompt\_powerlevel9k\_teardown

You can then re-enable it by calling:

$ prompt\_powerlevel9k\_setup

tl; dr

Want to just get a quick start? Check out the Show Off Your Configportion of the wiki to get going.

The Wiki also has a ton of other useful information!

License

Project: MIT

Logo: CC-BY-SA. Source repository: https://github.com/bhilburn/powerlevel9k-logo

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.