Powerlevel10k is a theme for ZSH. It's fast, flexible and easy to install and configure.
Powerlevel10k can be used as a fast drop-in replacement for Powerlevel9k. When given the same configuration options it will generate the same prompt.
git clone --depth=1 https://github.com/romkatv/powerlevel10k.git ~/powerlevel10k
echo 'source ~/powerlevel10k/powerlevel10k.zsh-theme' >>! ~/.zshrc
This is the simplest kind of installation and it works even if you are using a plugin manager. Just make sure to disable your current theme in your plugin manager. See FAQ for help.
git clone --depth=1 https://github.com/romkatv/powerlevel10k.git $ZSH_CUSTOM/themes/powerlevel10k
Set ZSH_THEME=powerlevel10k/powerlevel10k
in your ~/.zshrc
.
Add zstyle :prezto:module:prompt theme powerlevel10k
to your ~/.zpreztorc
.
Add antigen theme romkatv/powerlevel10k
to your ~/.zshrc
. Make sure you have antigen apply
somewhere after it.
Add zplug romkatv/powerlevel10k, as:theme, depth:1
to your ~/.zshrc
.
Add zgen load romkatv/powerlevel10k powerlevel10k
to your ~/.zshrc
.
Add antibody bundle romkatv/powerlevel10k
to your ~/.zshrc
.
Add zplugin ice depth=1; zplugin light romkatv/powerlevel10k
to your ~/.zshrc
.
The use of depth=1
ice is optional. Other types of ice are neither recommended nor officially
supported by Powerlevel10k.
On the first run, Powerlevel10k configuration wizard will ask you a few questions and configure
your prompt. If it doesn't trigger automatically, type p10k configure
. You can further customize
your prompt by editing ~/.p10k.zsh
.
If you've been using Powerlevel9k before, do not remove the configuration options. Powerlevel10k will pick them up and provide you with the same prompt UI you are used to. Powerlevel10k recognized all configuration options used by Powerlevel9k. See Powerlevel9k configuration guide.
To go beyond the functionality of Powerlevel9k, type p10k configure
and explore the unique styles
and features Powerlevel10k has to offer. You can further customize your prompt by editing
~/.p10k.zsh
.
Powerlevel10k doesn't require custom fonts but can take advantage of them if they are available. It works well with Nerd Fonts, Source Code Pro, Font Awesome, Powerline, and even the default system fonts. The full choice of style options is available only when using Nerd Fonts.
Download these four ttf files:
Double-click on each file and press "Install". This will make MesloLGS NF
font available to all
applications on your system. Configure your terminal to use this font:
p10k configure
, answer Yes
when asked whether to install
Meslo Nerd Font and restart iTerm2 for the changes to take effect. Alternatively, open
iTerm2 → Preferences → Profiles → Text and set Font to MesloLGS NF
.MesloLGS NF
family.fontFamily
under
module.exports.config
to MesloLGS NF
.terminal.integrated.fontFamily
in the search box and set the value to MesloLGS NF
.MesloLGS NF Regular
.MesloLGS NF Regular
.MesloLGS NF Regular
.MesloLGS NF
.Ctrl+,
), search for fontFace
and set
value to MesloLGS NF
for every profile.p10k configure
and answer Yes
when asked whether to install
Meslo Nerd Font.Run p10k configure
to pick the best style for your new font.
Using a different terminal and know how to set the font for it? Share your knowledge by sending a PR to expand the list!
Try Powerlevel10k in Docker. You can safely make any changes to the file system while trying out the theme. Once you exit zsh, the image is deleted.
docker run -e TERM -it --rm archlinux/base bash -uexc '
pacman -Sy --noconfirm zsh git
git clone --depth=1 https://github.com/romkatv/powerlevel10k.git ~/powerlevel10k
echo "source ~/powerlevel10k/powerlevel10k.zsh-theme" >>~/.zshrc
cd ~/powerlevel10k
exec zsh'
Yes.
Benchmark results obtained with zsh-prompt-benchmark on an Intel i9-7900X running Ubuntu 18.04 with the config from the demo.
Theme | Prompt Latency |
---|---|
powerlevel9k/master | 1046 ms |
powerlevel9k/next | 1005 ms |
powerlevel10k | 8.7 ms |
Powerlevel10k is over 100 times faster than Powerlevel9k in this benchmark.
In fairness, Powerlevel9k has acceptable latency when given a spartan configuration. If all you need is the current directory without truncation or shortening, Powerlevel9k can render it for you in 17 ms. Powerlevel10k can do the same 30 times faster but it won't matter in practice because 17 ms is fast enough (the threshold where latency becomes noticeable is around 50 ms). You have to be careful with Powerlevel9k configuration as it's all too easy to make prompt frustratingly slow. Powerlevel10k, on the other hand, doesn't require trading latency for utility -- it's virtually instant with any configuration. It stays well below the 50 ms mark, leaving most of the latency budget for other plugins you might install.
Powerlevel10k is released under the MIT license. Contributions are covered by the same license.
Instant Prompt is an optional feature of Powerlevel10k. When enabled, it gives you a limited prompt within a few milliseconds of starting zsh, allowing you to start hacking right away while zsh is initializing. Once initialization is complete, the full-featured Powerlevel10k prompt will seamlessly replace instant prompt.
You can enable instant prompt either by running p10k configure
or by manually adding the following
code snippet at the top of ~/.zshrc
:
# Enable Powerlevel10k instant prompt. Should stay close to the top of ~/.zshrc.
# Initialization code that may require console input (password prompts, [y/n]
# confirmations, etc.) must go above this block, everything else may go below.
if [[ -r "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh" ]]; then
source "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh"
fi
It's important that you copy the lines verbatim. Don't replace source
with something else, don't
call zcompile
, don't redirect output, etc.
When instant prompt is enabled, for the duration of zsh initialization standard input is redirected
to /dev/null
and standard output with standard error are redirected to a temporary file. Once zsh
is fully initialized, standard file descriptors are restored and the content of the temporary file
is printed out.
When using instant prompt, you should carefully check any output that appears on zsh startup as it
may indicate that initialization has been altered, or perhaps even broken, by instant prompt.
Initialization code that may require console input, such as asking for a keyring password or for a
[y/n] confirmation, must be moved above the instant prompt preamble in ~/.zshrc
. Initialization
code that merely prints to console but never reads from it will work correctly with instant prompt,
although output that normally has colors may appear uncolored. You can either leave it be, suppress
the output, or move it above the instant prompt preamble.
Here's an example of ~/.zshrc
that breaks when instant prompt is enabled:
if [[ -r "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh" ]]; then
source "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh"
fi
keychain id_rsa --agents ssh # asks for password
chatty-script # spams to stdout even when everything is fine
Fixed version:
keychain id_rsa --agents ssh # moved before instant prompt
# OK to perform console I/O before this point.
if [[ -r "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh" ]]; then
source "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh"
fi
# From this point on, until zsh is fully initialized, console input won't work and
# console output may appear uncolored.
chatty-script >/dev/null # spam output suppressed
If POWERLEVEL9K_INSTANT_PROMPT
is unset or set to verbose
, Powerlevel10k will print a warning
when it detects console output during initialization to bring attention to potential issues. You can
silence this warning (without suppressing console output) with POWERLEVEL9K_INSTANT_PROMPT=quiet
.
This is recommended if some initialization code in ~/.zshrc
prints to console and it's infeasible
to move it above the instant prompt preamble or to suppress its output. You can completely disable
instant prompt with POWERLEVEL9K_INSTANT_PROMPT=off
. Do this if instant prompt breaks zsh
initialization and you don't know how to fix it.
NOTE: Instant prompt requires zsh >= 5.4. It's OK to enable it even when using an older version of zsh but it won't do anything.
It's likely your font's fault.
Install the recommended font and run
p10k configure
.
Type echo '\u276F'
. If you get an error saying "zsh: character not in range", your locale
doesn't support UTF-8. You need to fix it. If you are running zsh over SSH, see
this. If you are
running zsh locally, Google "set UTF-8 locale in your OS".
Type echo '\u276F'
. If you get an error saying "zsh: character not in range", see the
previous question.
If the echo
command prints ❯
but the cursor is still in the wrong place, install
the recommended font and run
p10k configure
.
If this doesn't help, add unset ZLE_RPROMPT_INDENT
at the bottom of ~/.zshrc
.
Still having issues? Run the following command to diagnose the problem:
() {
emulate -L zsh
setopt err_return no_unset
local text
print -rl -- 'Select a part of your prompt from the terminal window and paste it below.' ''
read -r '?Prompt: ' text
local -i len=${(m)#text}
local frame="+-${(pl.$len..-.):-}-+"
print -lr -- $frame "| $text |" $frame
}
+------------------------------+
| romka@adam ✓ ~/powerlevel10k |
+------------------------------+
If the output of the command is aligned for every part of your prompt (left and right), this indicates a bug in the theme or your config. Use this command to diagnose it:
print -rl -- ${(eq+)PROMPT} ${(eq+)RPROMPT}
Look for %{...%}
and backslash escapes in the output. If there are any, they are the likely
culprits. Open an issue if you get stuck.
+-----------------------------+
| romka@adam ✓ ~/powerlevel10k |
+-----------------------------+
This is usually caused by a terminal bug or misconfiguration that makes it print ambiguous-width characters as double-width instead of single width. For example, this issue.
+------------------------------+
| romka@adam ✓~/powerlevel10k |
+------------------------------+
Note that this prompt is different from the original as it's missing a space after the checkmark.
This can be caused by a low-level bug in macOS. See this issue.
+--------------------------------+
| romka@adam ✓ ~/powerlevel10k |
+--------------------------------+
This can be caused by misconfigured locale. See this issue.
See Why is my cursor in the wrong place?
See Why is my cursor in the wrong place?
When Powerlevel10k starts, it automatically runs p10k configure
if no POWERLEVEL9K_*
parameters are defined. Based on your prompt style choices, the configuration wizard creates
~/.p10k.zsh
with a bunch of POWERLEVEL9K_*
parameters in it and adds a line to ~/.zshrc
to
source this file. The next time you start zsh, the configuration wizard shouldn't run automatically.
If it does, this means the evaluation of ~/.zshrc
terminates prematurely before it reaches the
line that sources ~/.p10k.zsh
. This most often happens due to syntax errors in ~/.zshrc
. These
errors get hidden by the configuration wizard screen, so you don't notice them. Scroll up in the
first configuration wizard screen to see these errors. Alternatively, run
POWERLEVEL9K_DISABLE_CONFIGURATION_WIZARD=true zsh
to start zsh without automatically running the
configuration wizard. Once you can see the errors, fix ~/.zshrc
to get rid of them.
Once you download the recommended font, you can install it just like any other font. Google "how to install fonts on your OS".
If it looks like a regular ?
, that's normal. It means you have untracked files in the current Git
repository. Type git status
to see these files. You can change this symbol or disable the display
of untracked files altogether. Search for untracked files
in ~/.p10k.zsh
.
You can also get a weird-looking question mark in your prompt if your terminal's font is missing
some glyphs. To fix this problem,
install the recommended font and run
p10k configure
.
When using Lean, Classic or Rainbow style, Git status may look like this:
feature:master ⇣42⇡42 *42 merge ~42 +42 !42 ?42
Symbol | Meaning | Source |
---|---|---|
feature |
current branch; replaced with #tag or @commit if not on a branch |
git status |
master |
remote tracking branch; only shown if different from local branch | git rev-parse --abbrev-ref --symbolic-full-name @{u} |
⇣42 |
this many commits behind the remote | git status |
⇡42 |
this many commits ahead of the remote | git status |
*42 |
this many stashes | git stash list |
merge |
repository state | git status |
~42 |
this many merge conflicts | git status |
+42 |
this many staged changes | git status |
!42 |
this many unstaged changes | git status |
?42 |
this many untracked files | git status |
See also: How do I change the format of Git status?
To change the format of Git status, open ~/.p10k.zsh
, search for my_git_formatter
and edit its
source code.
When using Lean, Classic or Rainbow style, prompt shows username@hostname
when you are
logged in as root or via SSH. There is little value in showing username
or hostname
when you are
logged in to your local machine as a normal user. So the absence of username@hostname
in your
prompt is an indication that you are working locally and that you aren't root. You can change it,
however.
Open ~/.p10k.zsh
. Close to the top you can see the most important parameters that define which
segments are shown in your prompt. All generally useful prompt segments are listed in there. Some of
them are enabled, others are commented out. One of them is of interest to you.
typeset -g POWERLEVEL9K_RIGHT_PROMPT_ELEMENTS=(
...
context # user@hostname
...
)
Search for context
to find the section in the config that lists parameters specific to this prompt
segment. You should see the following lines:
# Don't show context unless running with privileges or in SSH.
# Tip: Remove the next line to always show context.
typeset -g POWERLEVEL9K_CONTEXT_{DEFAULT,SUDO}_{CONTENT,VISUAL_IDENTIFIER}_EXPANSION=
If you follow the tip and remove (or comment out) the last line, you'll always see
username@hostname
in prompt. You can change the format to just username
, or change the color, by
adjusting the values of parameters nearby. There are plenty of comments to help you navigate.
Finally, you can move context
segment to where you want it to be in your prompt. Perhaps somewhere
within POWERLEVEL9K_LEFT_PROMPT_ELEMENTS
.
Powerlevel10k uses gitstatus as the backend behind vcs
prompt; gitstatus spawns gitstatusd
and zsh
. See
gitstatus for details. Powerlevel10k may also spawn zsh
to trigger async prompt refresh. To avoid security hazard, these background processes aren't shared
by different interactive shells.
No, Powerlevel10k is always fast, with any configuration you throw at it. If you have noticeable prompt latency when using Powerlevel10k, please open an issue.
Yes, provided that you are using zsh >= 5.4.
Loading time, or time to first prompt, can be measured with the following benchmark:
time (repeat 1000 zsh -dfis <<< 'source ~/powerlevel10k/powerlevel10k.zsh-theme')
NOTE: This measures time to first complete prompt. Powerlevel10k can also display a limited prompt before the full-featured prompt is ready.
Running this command with ~/powerlevel10k
as the current directory on the same machine as in the
prompt benchmark takes 29 seconds (29 ms per invocation). This is about 6
times faster than powerlevel9k/master and 17 times faster than powerlevel9k/next.
This is the goal. You should be able to switch from Powerlevel9k to Powerlevel10k with no visible changes except for performance. There are, however, several differences.
git
vcs backend is enabled in Powerlevel10k. If you need svn
and hg
, you'll
need to add them to POWERLEVEL9K_VCS_BACKENDS
.ZLE_RPROMPT_INDENT
. As a result, right prompt in Powerlevel10k
can have an extra space at the end compared to Powerlevel9k. Set ZLE_RPROMPT_INDENT=0
if you
don't want that space.POWERLEVEL9K_MODE
before sourcing the theme. This parameter gets ignored
by Powerlevel9k but honored by Powerlevel10k. If you want your prompt to look in Powerlevel10k
the same as in Powerlevel9k, remove POWERLEVEL9K_MODE
.If you notice any other changes in prompt appearance when switching from Powerlevel9k to Powerlevel10k, please open an issue.
Yes, zsh-theme-powerlevel10k-git. This package is owned by an unaffiliated volunteer.
If the installation instructions didn't work for you, try disabling your current theme (so that you end up with no theme) and then installing Powerlevel10k manually.
~/.zshrc
and remove the zplug
command that refers to your current theme. For
example, if you are currently using Powerlevel9k, look for
zplug bhilburn/powerlevel9k, use:powerlevel9k.zsh-theme
.~/.zpreztorc
and put zstyle :prezto:module:prompt theme off
in it. Remove
any other command that sets theme
such as zstyle :prezto:module:prompt theme powerlevel9k
.~/.zshrc
and remove the line that sets ZSH_THEME
, such as
ZSH_THEME=powerlevel9k/powerlevel9k
.~/.zshrc
and remove the line that sets antigen theme
, such as
antigen theme powerlevel9k/powerlevel9k
.git clone https://github.com/romkatv/powerlevel10k.git ~/powerlevel10k
echo 'source ~/powerlevel10k/powerlevel10k.zsh-theme' >>! ~/.zshrc
This method of installation won't make anything slower or otherwise sub-par.
Zsh 5.1 or newer should work. Fast startup requires zsh >= 5.4.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。