README

Powerlevel10k


- THE PROJECT HAS VERY LIMITED SUPPORT
- NO NEW FEATURES ARE IN THE WORKS
- MOST BUGS WILL GO UNFIXED
- HELP REQUESTS WILL BE IGNORED

Powerlevel10k is a theme for Zsh. It emphasizes speed,
flexibility and out-of-the-box experience.

!Powerlevel10k

- Getting started
- Features
- Installation
- Configuration
- Fonts
- Try it in Docker
- License
- FAQ
- Troubleshooting

 Getting started

1. Install the recommended font. Optional but highly
   recommended.
1. Install Powerlevel10k itself.
1. Restart Zsh with exec zsh.
1. Type p10k configure if the configuration wizard doesn't start automatically.

 Features

- Configuration wizard
- Uncompromising performance
- Powerlevel9k compatibility
- Pure compatibility
- Instant prompt
- Show on command
- Transient prompt
- Current directory that just works
- Extremely customizable
- Batteries included
- Extensible

 Configuration wizard

Type p10k configure to access the builtin configuration wizard right from your terminal.


  Screen recording

  !Powerlevel10k Configuration Wizard


All styles except Pure are functionally equivalent. They display the same
information and differ only in presentation.

Configuration wizard creates ~/.p10k.zsh based on your preferences. Additional prompt
customization can be done by editing this file. It has plenty of comments to help you navigate
through configuration options.

Tip: Install the recommended font before
running p10k configure to unlock all prompt styles.

FAQ:

- What is the best prompt style in the configuration wizard?
- What do different symbols in Git status mean?
- How do I change prompt colors?

Troubleshooting:

- Some prompt styles are missing from the configuration wizard.
- Question mark in prompt.
- Icons, glyphs or powerline symbols don't render.
- Sub-pixel imperfections around powerline symbols.
- Directory is difficult to see in prompt when using Rainbow style.

 Uncompromising performance

When you hit ENTER, the next prompt appears instantly. With Powerlevel10k there is no prompt lag.
If you install Cygwin on Raspberry Pi, cd into a Linux Git repository and activate enough prompt
segments to fill four prompt lines on both sides of the screen... wait, that's just crazy and no
one ever does that. Probably impossible, too. The point is, Powerlevel10k prompt is always fast, no
matter what you do!


  Screen recording

  !Powerlevel10k Performance


Note how the effect of every command is instantly reflected by the very next prompt.

| Command                       | Prompt Indicator | Meaning                                                               |
|-------------------------------|:----------------:|----------------------------------------------------------------------:|
| timew start hack linux      | ⌚ hack linux  | time tracking enabled in timewarrior      |
| touch x y                   | ?2             | 2 untracked files in the Git repo                                     |
| rm COPYING                  | !1          

Top issues

Discussions

Latest release

- Bug fix: honor POWERLEVEL9K_LEFT_SEGMENT_END_SEPARATOR in instant prompt. (2376)
- Bug fix: unquote ID in /etc/os-release. In particular, this fixes the detection of EndeavourOS. (2388)
- Bug fix: correctly detect DCS within instant prompt output. (2518)
- Bug fix: s/.tool-version/.tool-versions/ in all configs. (2416)
- New segment: per_directory_history. It displays a local/global history indicator when the per-directory-history Oh My Zsh plugin is in use. This segment is enabled by default in Lean, Classic and Rainbow styles. (2384)
- Add an option to the default git formatter to dis