diff options
| author | V1rgul <V1rgul@users.noreply.github.com> | 2016-01-18 07:09:19 +0300 |
|---|---|---|
| committer | V1rgul <V1rgul@users.noreply.github.com> | 2016-01-18 07:09:19 +0300 |
| commit | a0c664b1743131888cd7f72e94135edaa79dad2b (patch) | |
| tree | c95e2c51966e2145bd837e07d73868be0ff89549 /README.md | |
| parent | 7394608d5621d41f7211032ab1048a313d1dee7e (diff) | |
| parent | 67895cc5da1fe479d0ae321fba750e199758eee4 (diff) | |
Merge pull request #1 from bhilburn/next
Merge original repo
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 663 |
1 files changed, 209 insertions, 454 deletions
@@ -6,10 +6,14 @@ ZSH, [Oh-My-Zsh](https://github.com/robbyrussell/oh-my-zsh), or [Prezto](https://github.com/sorin-ionescu/prezto), and can also be installed using [antigen](https://github.com/zsh-users/antigen). -Look like a bad-ass. Impress everyone in 'Screenshot Your Desktop' threads. Use powerlevel9k. +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](https://github.com/bhilburn/powerlevel9k/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: @@ -22,299 +26,243 @@ this theme focus on four primary goals: 4. Optimize the code for execution speed as much as possible. A snappy terminal is a happy terminal. -<!-- START doctoc generated TOC please keep comment here to allow auto update --> -<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* - -- [Features](#features) -- [Installation](#installation) - - [Step 1: Install Powerlevel9k](#step-1-install-powerlevel9k) - - [Option 1: Install for Vanilla ZSH](#option-1-install-for-vanilla-zsh) - - [Option 2: Install for Oh-My-ZSH](#option-2-install-for-oh-my-zsh) - - [Option 3: Install for Prezto](#option-3-install-for-prezto) - - [Option 4: Install for antigen](#option-4-install-for-antigen) - - [Step 2: Install Powerline Fonts](#step-2-install-powerline-fonts) - - [Option 1: Install Powerline Fonts](#option-1-install-powerline-fonts) - - [Option 2: Install Awesome Powerline Fonts](#option-2-install-awesome-powerline-fonts) - - [Option 3: Compatible Mode](#option-3-compatible-mode) -- [Segment Customization](#segment-customization) - - [The AWS Profile Segment](#the-aws-profile-segment) - - [The 'context' Segment](#the-context-segment) - - [The 'dir' segment](#the-dir-segment) - - [The 'ip' segment](#the-ip-segment) - - [The 'time' segment](#the-time-segment) - - [Unit Test Ratios](#unit-test-ratios) - - [The 'vcs' Segment](#the-vcs-segment) - - [Symbols](#symbols) -- [Styling](#styling) - - [Double-Lined Prompt](#double-lined-prompt) - - [Disable Right Prompt](#disable-right-prompt) - - [Light Color Theme](#light-color-theme) - - [Icon Customization](#icon-customization) - - [Segment Color Customization](#segment-color-customization) - - [Special Segment Colors](#special-segment-colors) -- [Troubleshooting](#troubleshooting) - - [Gaps Between Segments](#gaps-between-segments) - - [Segment Colors are Wrong](#segment-colors-are-wrong) - - [Strange Characters in prompt](#strange-characters-in-prompt) -- [Meta](#meta) - - [Kudos](#kudos) - - [Developing](#developing) - - [Contributions / Bugs / Contact](#contributions--bugs--contact) - -<!-- END doctoc generated TOC please keep comment here to allow auto update --> - -### Features - -* Supports `git` and `mercurial` repo information through ZSH's `VCS_INFO`: - * branch / tag name - * current action status (rebasing, merging, etc.,) - * being behind / ahead of your remote by some number of commits - * number of stashes (git only) - * conditionally shows remote tracking branch if the name differs from local - * current active bookmark (mercurial only) - * various working tree statuses (e.g., unstaged, staged, etc.,) -* Shows return-code of the last command if it is an error code -* Indicates background jobs with a gear icon -* Can conditionally display the `user@host` string when needed (e.g., SSH) -* Provides segment for command history (so you can `$ !<num>` to re-run) -* Plenty of additional segments to choose from (e.g., AWS, ruby) -* Can be used as a single or double-lined prompt (see screenshots below) -* Several built-in color configurations to choose from - -**If you would like an OMZ theme that provides some of the same features but -doesn't require Powerline fonts, check out the sister font, -[hackersaurus](https://github.com/bhilburn/hackersaurus).** - -Here is a detailed screenshot showing `powerlevel9k` with default settings and -varying terminal status indicators: - - - -### Installation -There are two steps to start using this theme: - -1. Install the Powerlevel9k theme. -2. Install Powerline-patched fonts. -3. [Optional] Configuration - -To get the most out of Powerlevel9k, you need to install both the theme as well -as Powerline-patched fonts, if you don't have them installed already. If you -cannot install Powerline-patched fonts for some reason, follow the instructions -below for a `compatible` install. - -No configuration is necessary post-installation if you like the default -settings, but there is plenty of segment configuration available if you are -interested. - -#### Step 1: Install Powerlevel9k -There are four ways to install and use the Powerlevel9k theme: vanilla ZSH, -Oh-My-Zsh, Prezto, and antigen. Do one of the following: +Here is `powerlevel9k` in action, with [some simple settings](https://github.com/bhilburn/powerlevel9k/wiki/Show-Off-Your-Config#natemccurdys-configuration). -##### Option 1: Install for Vanilla ZSH + -If you use just a vanilla ZSH install, simply clone this repository and -reference it in your `~/.zshrc`: +### Table of Contents - $ git clone https://github.com/bhilburn/powerlevel9k.git - $ echo 'source powerlevel9k/powerlevel9k.zsh-theme' >> ~/.zshrc +1. [Installation](#installation) +2. [Customization](#prompt-customization) + 1. [Stylizing Your Prompt](https://github.com/bhilburn/powerlevel9k/wiki/Stylizing-Your-Prompt) + 2. [Customizing Prompt Segments](#customizing-prompt-segments) + 3. [Available Prompt Segments](#available-prompt-segments) +3. [Troubleshooting](https://github.com/bhilburn/powerlevel9k/wiki/Troubleshooting) -##### Option 2: Install for Oh-My-ZSH +Be sure to also [check out the Wiki](https://github.com/bhilburn/powerlevel9k/wiki)! -To install this theme for -[Oh-My-Zsh](https://github.com/robbyrussell/oh-my-zsh), clone this repository -into your OMZ `custom/themes` directory. - - $ cd ~/.oh-my-zsh/custom - $ git clone https://github.com/bhilburn/powerlevel9k.git themes/powerlevel9k - -You then need to select this theme in your `~/.zshrc`: +### Installation +There are two installation steps to go from a lame terminal to a "Power Level +9000" terminal. Once you are done, you can optionally customize your prompt. - ZSH_THEME="powerlevel9k/powerlevel9k" +[Installation Instructions](https://github.com/bhilburn/powerlevel9k/wiki/Install-Instructions) -##### Option 3: Install for Prezto +1. [Install the Powerlevel9k Theme](https://github.com/bhilburn/powerlevel9k/wiki/Install-Instructions#step-1-install-powerlevel9k) +2. [Install Powerline-Patched Fonts](https://github.com/bhilburn/powerlevel9k/wiki/Install-Instructions#step-2-install-powerline-fonts) -To install this theme for use in Prezto, clone this repository into your -[Prezto](https://github.com/sorin-ionescu/prezto) `prompt/external` directory. +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. - $ cd ~.zprezto/modules/prompt/external - $ git clone https://github.com/bhilburn/powerlevel9k.git - $ ln -s powerlevel9k/powerlevel9k.zsh-theme ../functions/prompt_powerlevel9k_setup +### Prompt Customization -You then need to select this theme in your `~/.zpreztorc`: +Be sure to check out the wiki page on the additional prompt customization +options, including color and icon settings: [Stylizing Your Prompt](https://github.com/bhilburn/powerlevel9k/wiki/Stylizing-Your-Prompt) - zstyle ':prezto:module:prompt' theme 'powerlevel9k' +#### 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`. -##### Option 4: Install for antigen +| Variable | Default Value | Description | +|----------|---------------|-------------| +|`POWERLEVEL9K_LEFT_PROMPT_ELEMENTS`|`(context dir rbenv vcs)`|Segment list for left prompt| +|`POWERLEVEL9K_RIGHT_PROMPT_ELEMENTS`|`(status history time)`|Segment list for right prompt| -If you prefer [antigen](https://github.com/zsh-users/antigen), just add this -theme to the antigen config in your `~/.zshrc`: - $ echo 'antigen theme bhilburn/powerlevel9k powerlevel9k' >> ~/.zshrc - $ echo 'antigen apply' >> ~/.zshrc +So if you wanted to set these variables manually, you would put the following in +your `~/.zshrc`: -Note that you should define any customizations before calling `antigen theme` -(i.e. setting the `POWERLEVEL9K_*` variables) in your `.zshrc`. + POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(context dir rbenv vcs) + POWERLEVEL9K_RIGHT_PROMPT_ELEMENTS=(status history time) -#### Step 2: Install Powerline Fonts -Technically, you don't *have* to install Powerline fonts. If you are using -a font that has some of the basic glyphs we need, you can use the theme in -`compatible` mode - see the third option, below. +#### Available Prompt Segments +The segments that are currently available are: -To get the most out of theme, though, you'll want Powerline-patched fonts. There -are two varieties of these: 'Powerline Fonts' and 'Awesome Powerline -Fonts'. The latter includes additional glyphs that aren't required for a normal -install. +* [aws](#aws) - The current AWS profile, if active. +* **background_jobs** - Indicator for background jobs. +* [battery](#battery) - Current battery status. +* [context](#context) - Your username and host. +* [custom_command](#custom_command) - A custom command to display the output of. +* [dir](#dir) - Your current working directory. +* **go_version** - Show the current GO version. +* **history** - The command number for the current line. +* [ip](#ip) - Shows the current IP address. +* **load** - Your machines 5 minute load average. +* **node_version** - Show the version number of the installed Node.js. +* **nvm** - Show the version of Node that is currently active, if it differs from the version used by NVM +* **os_icon** - Display a nice little icon, depending on your operating system. +* **php_version** - Show the current PHP version. +* [ram](#ram) - Show free RAM and used Swap. +* [rbenv](#rbenv) - Ruby environment information (if one is active). +* **root_indicator** - An indicator if the user is root. +* [rspec_stats](#rspec_stats) - Show a ratio of test classes vs code classes for RSpec. +* **rust_version** - Display the current rust version. +* [status](#status) - The return code of the previous command. +* [symphony2_tests](#symphony2_tests) - Show a ratio of test classes vs code classes for Symfony2. +* **symphony2_version** - Show the current Symfony2 version, if you are in a Symfony2-Project dir. +* [time](#time) - System time. +* [todo](http://todotxt.com/) - Shows the number of tasks in your todo.txt tasks file. +* [vi_mode](#vi_mode)- Vi editing mode (NORMAL|INSERT). +* **virtualenv** - Your Python [VirtualEnv](https://virtualenv.pypa.io/en/latest/). +* [vcs](#vcs) - Information about this `git` or `hg` repository (if you are in one). -Do one of the following: -##### Option 1: Install Powerline Fonts +##### aws -You can find the [installation instructions for Powerline Fonts here] -(https://powerline.readthedocs.org/en/latest/installation/linux.html#fonts-installation). -You can also find the raw font files [in this Github -repository](https://github.com/powerline/fonts) if you want to manually install -them for your OS. +If you would like to display the [current AWS +profile](http://docs.aws.amazon.com/cli/latest/userguide/installing.html), add +the `aws` segment to one of the prompts, and define `AWS_DEFAULT_PROFILE` in +your `~/.zshrc`: -After you have installed Powerline fonts, make the default font in your terminal -emulator the Powerline font you want to use. +| Variable | Default Value | Description | +|----------|---------------|-------------| +|`AWS_DEFAULT_PROFILE`|None|Your AWS profile name| -This is the default mode for `Powerlevel9k`, and no further configuration is -necessary. +##### battery -**N.B.:** If Powerlevel9k is not working properly, it is almost always the case -that the fonts were not properly installed, or you have not configured your -terminal to use a Powerline-patched font! +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). -##### Option 2: Install Awesome Powerline Fonts +| 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.| -Alternatively, you can install [Awesome Powerline -Fonts](https://github.com/gabrielelana/awesome-terminal-fonts), which provide -a number of additional glyphs. +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 then need to indicate that you wish to use the additional glyphs by defining -the following in your `~/.zshrc`: +##### custom_command - POWERLEVEL9K_MODE='awesome-fontconfig' +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: -If you chose to use already patched fonts, use instead : + 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" - POWERLEVEL9K_MODE='awesome-patched' +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_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 + } -If you choose to make use of this, your prompt will look something like this: + 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: -Note that if you prefer flat segment transitions, you can use the following with -`Awesome Powerline Fonts` installed: + - POWERLEVEL9K_MODE='flat' +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! -Which looks like this: +##### context - +The `context` segment (user@host string) is conditional. This lets you enable +it, but only display it if you are not your normal user or on a remote host +(basically, only print it when it's likely you need it). -##### Option 3: Compatible Mode +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`: -This option is best if you prefer not to install additional fonts. This option -will work out-of-the-box if your your terminal font supports the segment -separator characters `\uE0B0` (left segment separator) and `\uE0B2` (right -segment separator). +| Variable | Default Value | Description | +|----------|---------------|-------------| +|`DEFAULT_USER`|None|Username to consider a "default context" (you can also use `$USER`)| -All you need to do to in this case is install the `Powerlevel9k` theme itself, -as explained above, and then define the following in your `~/.zshrc`: +##### dir - POWERLEVEL9K_MODE='compatible' +The `dir` segment shows the current working directory. When using the "Awesome +Powerline" fonts, there are additional glyphs, as well: -Note that depending on your terminal font, this may still not render -appropriately. This configuration should be used as a back-up. +| `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 | -### Segment Customization +To turn off these icons you could set these variables to an empty string. -Customizing your prompt is easy! Select the segments you want to have displayed, -and then assign them to either the left or right prompt. The segments that are -currently available are: + POWERLEVEL9K_HOME_ICON='' + POWERLEVEL9K_HOME_SUB_ICON='' + POWERLEVEL9K_FOLDER_ICON='' -* **aws** - The current AWS profile, if active (more info below) -* **context** - Your username and host (more info below) -* **dir** - Your current working directory. -* **history** - The command number for the current line. -* **ip** - Shows the current IP address. -* **load** - Your machines 5 minute load average and free RAM. -* **node_version** - Show the version number of the installed Node.js. -* **os_icon** - Display a nice little icon, depending on your operating system. -* **php_version** - Show the current PHP version. -* **rbenv** - Ruby environment information (if one is active). -* **rspec_stats** - Show a ratio of test classes vs code classes for RSpec. -* **status** - The return code of the previous command, and status of background jobs. -* **symfony2_tests** - Show a ratio of test classes vs code classes for Symfony2. -* **symfony2_version** - Show the current Symfony2 version, if you are in a Symfony2-Project dir. -* **time** - System time. -* **vi_mode** - Vi editing mode (NORMAL|INSERT). -* **virtualenv** - Your Python [VirtualEnv](https://virtualenv.pypa.io/en/latest/). -* **vcs** - Information about this `git` or `hg` repository (if you are in one). +You can limit the output to a certain length by truncating long paths. +Customizations available are: -To specify which segments you want, just add the following variables to your -`~/.zshrc`. If you don't customize this, the below configuration is the default: +| Variable | Default Value | Description | +|----------|---------------|-------------| +|`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. By default, it will truncate whole directories. Other options are `truncate_middle`, which leaves the start and end of the directory strings, and `truncate_from_right`, which cuts starting from the end of the string.| +|`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.| - POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(context dir rbenv vcs) - POWERLEVEL9K_RIGHT_PROMPT_ELEMENTS=(status history time) +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: -#### The AWS Profile Segment + POWERLEVEL9K_SHORTEN_DIR_LENGTH=1 + POWERLEVEL9K_SHORTEN_DELIMITER="" + POWERLEVEL9K_SHORTEN_STRATEGY="truncate_from_right" -If you would like to display the [current AWS -profile](http://docs.aws.amazon.com/cli/latest/userguide/installing.html), add -the `aws` segment to one of the prompts, and define `AWS_DEFAULT_PROFILE` in -your `~/.zshrc`: +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. - export AWS_DEFAULT_PROFILE=<profile_name> -#### The 'context' Segment +##### ip -The `context` segment (user@host string) is conditional. This lets you enable it, but only display -it if you are not your normal user or on a remote host (basically, only print it -when it's likely you need it). +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: -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`: +| Variable | Default Value | Description | +|----------|---------------|-------------| +|`POWERLEVEL9K_IP_INTERFACE`|None|The NIC for which you wish to display the IP address. Example: `eth0`.| - export DEFAULT_USER=<your username> +##### rspec_stats -#### The 'dir' segment +See [Unit Test Ratios](#unit-test-ratios), below. -The `dir` segment shows the current working directory. You can limit the output -to a certain length: +##### status - # Limit to the last two folders - POWERLEVEL9K_SHORTEN_DIR_LENGTH=2 +This segment shows the return code of the last command. -To change the way how the current working directory is truncated, just set: +| Variable | Default Value | Description | +|----------|---------------|-------------| +|`POWERLEVEL9K_STATUS_VERBOSE`|`true`|Set to false if you wish to hide this segment when the last command completed successfully.| - # truncate the middle part - POWERLEVEL9K_SHORTEN_STRATEGY="truncate_middle" - # truncate from right, leaving the first X characters untouched - POWERLEVEL9K_SHORTEN_STRATEGY="truncate_from_right" - # default behaviour is to truncate whole directories +##### ram -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. +| Variable | Default Value | Description | +|----------|---------------|-------------| +|`POWERLEVEL9K_RAM_ELEMENTS`|Both|Specify `ram_free` or `swap_used` to only show one or the other rather than both.| -#### The 'ip' segment +##### symphony2_tests -This segment shows you your current internal IP address. It tries to examine -all currently used network interfaces and prints the first address it finds. -In the case that this is not the right IP address you can specify the correct -network interface by setting: +See [Unit Test Ratios](#unit-test-ratios), below. - POWERLEVEL9K_IP_INTERFACE="eth0" +##### time -#### The 'time' segment +| Variable | Default Value | Description | +|----------|---------------|-------------| +|`POWERLEVEL9K_TIME_FORMAT`|`'H:M:S'`|ZSH time format to use in this segment.| -By default the time is show in 'H:M:S' format. If you want to change it, -just set another format in your `~/.zshrc`. As an example, this is a reversed -time format: +As an example, if you wanted a reversed time format, you would use this: # Reversed time format POWERLEVEL9K_TIME_FORMAT='%D{%S:%M:%H}' @@ -325,62 +273,18 @@ segment, as well: # Output time, date, and a symbol from the "Awesome Powerline Font" set POWERLEVEL9K_TIME_FORMAT="%D{%H:%M:%S \uE868 %d.%m.%y}" -#### Showing Status - -Usually we display always the status, and in case a command failed, the return -code of the last executed program. In case you want to display the status only -if something special happend, you can set `POWERLEVEL9K_STATUS_VERBOSE=false` -in your `~/.zshrc`. - -#### Unit Test Ratios - -The `symfony2_tests` and `rspec_tests` 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. - -#### VI-Mode Indicator - -This Segment shows the current mode of your ZSH. If you want to use your ZSH in -VI-Mode, you need to configure it separatly in your `~/.zshrc`: - - # VI-Mode - # general activation - bindkey -v - - # set some nice hotkeys - bindkey '^P' up-history - bindkey '^N' down-history - bindkey '^?' backward-delete-char - bindkey '^h' backward-delete-char - bindkey '^w' backward-kill-word - bindkey '^r' history-incremental-search-backward - - # make it more responsive - export KEYTIMEOUT=1 +##### vcs -#### The 'vcs' Segment +By default, the `vcs` segment will provide quite a bit of information. Further +customization is provided via: -By default, the `vcs` segment will provide quite a bit of information. If you -would also like for it to display the current hash / changeset, simply define -`POWERLEVEL9K_SHOW_CHANGESET` in your `~/.zshrc`. If activated, it will show -the first 12 characters of the changeset id. To change the amount of characters, -set `POWERLEVEL9K_CHANGESET_HASH_LENGTH` to any value you want. +| 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.| - # enable the vcs segment in general - POWERLEVEL9K_SHOW_CHANGESET=true - # just show the 6 first characters of changeset - POWERLEVEL9K_CHANGESET_HASH_LENGTH=6 - -You can also disable the branch icon in your prompt by setting -`POWERLEVEL9K_HIDE_BRANCH_ICON` to `true`: - - # Hide the branch icon - POWERLEVEL9K_HIDE_BRANCH_ICON=true - -##### Symbols +**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` @@ -401,181 +305,32 @@ from the [Installation](#Installation) section above. | None | None |  | Repository is a git repository | None | None |  | Repository is a Mercurial repository -### Styling - -You can configure the look and feel of your prompt easily with some built-in -options. - -#### Double-Lined Prompt - -By default, `powerlevel9k` is a single-lined prompt. If you would like to have -the segments display on one line, and print the command prompt below it, simply -define `POWERLEVEL9K_PROMPT_ON_NEWLINE` in your `~/.zshrc`: - - POWERLEVEL9K_PROMPT_ON_NEWLINE=true - -Here is what it looks like: - - - -You can customize the icons used to draw the multiline prompt by setting the -following variables in your `~/.zshrc`: - - POWERLEVEL9K_MULTILINE_FIRST_PROMPT_PREFIX="↱" - POWERLEVEL9K_MULTILINE_SECOND_PROMPT_PREFIX="↳ " - -#### Disable Right Prompt - -If you do not want a right prompt, you can disable it by setting: - - POWERLEVEL9K_DISABLE_RPROMPT=true - -#### Light Color Theme - -If you prefer to use "light" colors, simply set `POWERLEVEL9K_COLOR_SCHEME` -to `light` in your `~/.zshrc`, and you're all set! - - POWERLEVEL9K_COLOR_SCHEME='light' - -The 'light' color scheme works well for ['Solarized -Light'](https://github.com/altercation/solarized) users. Check it out: - - - -#### Icon Customization - -Each icon used can be customized too by specifying a variable named like -the icon and prefixed with 'POWERLEVEL9K'. If you want to use another icon -as segment separators, you can easily do that: - - POWERLEVEL9K_LEFT_SEGMENT_SEPARATOR=$'\uE0B1' - POWERLEVEL9K_RIGHT_SEGMENT_SEPARATOR=$'\uE0B3' - -You could get a list of all icons defined in random colors, by adding the -special segment `icons_test` to your prompt: - - POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=(icons_test) - -This special prompt does not work on the right side, as it would be too long, -and ZSH hides it automatically. Also have in mind, that the output depends on -your `POWERLEVEL9K_MODE` settings. - -You can change any icon by setting a environment variable. To get a full list -of icons just type `get_icon_names` in your terminal. - -#### Segment Color Customization - -For each segment in your prompt, you can specify a foreground and background -color by setting them in your `~/.zshrc`. Use the segment names from the above -section `Segment Customization`. For example, to change the appearance of the -`time` segment, you would use: - - POWERLEVEL9K_TIME_FOREGROUND='red' - POWERLEVEL9K_TIME_BACKGROUND='blue' - -Note that you can also use a colorcode value. Example: +##### vi_mode - POWERLEVEL9K_VCS_FOREGROUND='021' # Dark blue +This segment shows ZSH's current input mode. Note that this is only useful if +you are using the [ZSH Line Editor](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html) +(VI mode). You can enable this either by `.zshrc` configuration or using a plugin, like +[Oh-My-Zsh's vi-mode plugin](https://github.com/robbyrussell/oh-my-zsh/blob/master/plugins/vi-mode/vi-mode.plugin.zsh). -For a full list of supported colors, run the `spectrum_ls` program in your -terminal. +| 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.| -#### Special Segment Colors - -Some segments have additional color options if you want to customize the look of -your prompt even further. These Segments are `context`, `vcs`, `rspec_stats`, -`symfony2_tests`: - - # Customizing `context` colors for root and non-root users - POWERLEVEL9K_CONTEXT_DEFAULT_BACKGROUND="green" - POWERLEVEL9K_CONTEXT_DEFAULT_FOREGROUND="cyan" - POWERLEVEL9K_CONTEXT_ROOT_BACKGROUND="red" - POWERLEVEL9K_CONTEXT_ROOT_FOREGROUND="blue" - - # Advanced `vcs` color customization - POWERLEVEL9K_VCS_FOREGROUND='blue' - POWERLEVEL9K_VCS_DARK_FOREGROUND='black' - POWERLEVEL9K_VCS_BACKGROUND='green' - # If VCS changes are detected: - POWERLEVEL9K_VCS_MODIFIED_FOREGROUND='red' - POWERLEVEL9K_VCS_MODIFIED_BACKGROUND='cyan' - - # rspec_stats for good test coverage - POWERLEVEL9K_RSPEC_STATS_GOOD_FOREGROUND='blue' - POWERLEVEL9K_RSPEC_STATS_GOOD_BACKGROUND='green' - # rspec_stats for average test coverage - POWERLEVEL9K_RSPEC_STATS_AVG_FOREGROUND='black' - POWERLEVEL9K_RSPEC_STATS_AVG_BACKGROUND='cyan' - # rspec_stats for poor test coverage - POWERLEVEL9K_RSPEC_STATS_BAD_FOREGROUND='red' - POWERLEVEL9K_RSPEC_STATS_BAD_BACKGROUND='white' - - # symfony2_tests for good test coverage - POWERLEVEL9K_SYMFONY2_TESTS_GOOD_FOREGROUND='blue' - POWERLEVEL9K_SYMFONY2_TESTS_GOOD_BACKGROUND='green' - # symfony2_tests for average test coverage - POWERLEVEL9K_SYMFONY2_TESTS_AVG_FOREGROUND='black' - POWERLEVEL9K_SYMFONY2_TESTS_AVG_BACKGROUND='cyan' - # symfony2_tests for poor test coverage - POWERLEVEL9K_SYMFONY2_TESTS_BAD_FOREGROUND='red' - POWERLEVEL9K_SYMFONY2_TESTS_BAD_BACKGROUND='white' - -### Troubleshooting - -Here are some fixes to some common problems. - -#### Gaps Between Segments - -You can see this issue in the screenshot, below: - - - -Thankfully, this is easy to fix. This happens if you have successfully installed -Powerline fonts, but did not make a Powerline font the default font in your -terminal emulator (e.g., 'terminator', 'gnome-terminal', 'konsole', etc.,). - -#### Segment Colors are Wrong - -If the color display within your terminal seems off, it's possible you are using -a reduced color set. You can check this by invoking `echotc Co` in your -terminal, which should yield `256`. If you see something different, try setting -`xterm-256color` in your `~/.zshrc`: - - TERM=xterm-256color - -#### Strange Characters in prompt - -If your prompt shows strange character like this: - - - -it is most likely that you set `POWERLEVEL9K_MODE="awesome-patched"`, but -did not install an [awesome-font](https://github.com/gabrielelana/awesome-terminal-fonts). For most other modes, you need a [powerline-patched](https://github.com/powerline/fonts) font. - -### Meta - -#### Kudos - -This theme wouldn't have happened without inspiration from the original -[agnoster](https://github.com/agnoster/agnoster-zsh-theme) ZSH theme. - -Before creating this theme, I also tried [jeremyFreeAgent's -theme](https://github.com/jeremyFreeAgent/oh-my-zsh-powerline-theme) and -[maverick2000's theme, ZSH2000](https://github.com/maverick2000/zsh2000). - -#### Developing - -Documentation for developers is kept on the [Powerlevel9k Github -wiki](https://github.com/bhilburn/powerlevel9k/wiki/Developer's-Guide). +#### Unit Test Ratios -#### Contributions / Bugs / Contact +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. -If you have any requests or bug reports, please use the tracker in this Github -repository. +### tl; dr -I'm happy to accept code contributions from anyone who has a bug fix, new -feature, or just a general improvement! Please submit your contribution as -a Github pull-request. +Want to just get a quick start? Check out the [Show Off Your +Config](https://github.com/bhilburn/powerlevel9k/wiki/Show-Off-Your-Config) +portion of the wiki to get going. -If you would like to contact me directly, you can find my e-mail address on my -[Github profile page](https://github.com/bhilburn). +[The Wiki also has a ton of other useful +information!](https://github.com/bhilburn/powerlevel9k/wiki) |