powerlevel10k/README.md
2015-02-01 15:51:14 -08:00

3.3 KiB

powerlevel9k Theme for Oh-My-Zsh

This is a theme for Oh-My-Zsh. This theme uses Powerline Fonts, thus giving you the most bad-ass terminal styling in the universe (as of 2015 C.E.).

Look like a bad-ass. Impress everyone in 'Screenshot Your Desktop' threads. Use powerlevel9k.

In addition to looking amazing, this theme actually provides a lot of useful information.

Features

  • Shows lots of information about Git repositories, including:
    • branch / tag name
    • current action status (rebasing, merging, etc.,)
    • being behind / ahead of your remote
    • various local working tree statuses
  • Shows command number in right-prompt (so you can $ !<num> to re-run)
  • Shows return-code of command if it is an error code
  • Shows system time in right-prompt
  • Indicates background jobs with a gear
  • Will conditionally display the user@host string

If you would like an OMZ theme that provides most of the same features but doesn't require Powerline fonts, check out the sister font, hackersaurus.

These screenshots should give you an idea of what powerlevel9k looks like:

Installation

First, you need to install Powerline Fonts. You can find the installation instructions here. You can also find the raw font files in this Github repository.

To install this theme, drop the .zsh-theme file into your .oh-my-zsh/themes directory. A better form of installation is to clone this repository and then create a symlink in your 'themes' directory:

$ git clone https://github.com/bhilburn/powerlevel9k.git powerlevel9k.git
$ ln -s powerlevel9k.git/powerlevel9k.zsh-theme ~/.oh-my-zsh/themes/powerlevel9k.zsh-theme

Note that you cannot clone this repository into your ~/.oh-my-zsh/themes/ directory. Oh-My-Zsh does not traverse subdirectories for themes, and will not find your theme.

You then need to select it in your ~/.zshrc:

ZSH_THEME="powerlevel9k"

If you do not want to display the user@host string, you should also put this in your ~/.zshrc:

export DEFAULT_USER=<your username>

History

I discovered the 'agnoster' OMZ theme while looking around for a new OMZ theme. I loved the Powerline styling, but the terminal status lines themselves were missing a lot of the information I like having. So, I started building on-top of the 'agnoster' theme, changing some things as I went.

This theme was first announced on my blog in December of 2014. At the time, the theme was missing some of the more advanced Git information. Tom Upton then helped me get things fixed up with his vcs_info hooks.

Bugs / Contact

If you have any requests or bug reports, please use the tracker in this Github repository.