目录
- configremove junk that has slipped in through 9f989151 (#1487)3个月前
- gitstatusMerge commit '140a6ade4e9d7431df697de4dfff04b353e219e2'1年前
- internalformatting3个月前
- .gitattributessurvive broken user-defined gitattributes6年前
- .gitignorezcompile all sources6年前
- LICENSEadd a link to contributors7年前
- Makefileadd 'minify' make target4年前
- README.mddocs: typo4个月前
- font.mddocs: typo4个月前
- powerlevel10k.pngupdate screenshot, now with rainbow style6年前
- powerlevel10k.zsh-themedisable re_match_pcre, otherwise we can get an error when users enable this option without having zsh/pcre module5年前
- powerlevel9k.zsh-themeremove spurious execute permissions6年前
- prompt_powerlevel10k_setupreplace symbolic links with regular files that "source"6年前
- prompt_powerlevel9k_setupreplace symbolic links with regular files that "source"6年前
Powerlevel10k
Powerlevel10k is a theme for Zsh. It emphasizes speed, flexibility and out-of-the-box experience.
Getting started
exec zsh.p10k configureif the configuration wizard doesn’t start automatically.Features
Configuration wizard
Type
p10k configureto access the builtin configuration wizard right from your terminal.Screen recording
All styles except Pure are functionally equivalent. They display the same information and differ only in presentation.
Configuration wizard creates
~/.p10k.zshbased 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 configureto unlock all prompt styles.FAQ:
what-is-the-best-prompt-style-in-the-configuration-wizard)
what-do-different-symbols-in-git-status-mean)
Troubleshooting:
some-prompt-styles-are-missing-from-the-configuration-wizard).
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,
cdinto 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
Note how the effect of every command is instantly reflected by the very next prompt.
timew start hack linux⌚ hack linuxtouch x y?2rm COPYING!1echo 3.7.3 >.python-version🐍 3.7.3Other Zsh themes capable of displaying the same information either produce prompt lag or print prompt that doesn’t reflect the current state of the system and then refresh it later. With Powerlevel10k you get fast prompt and up-to-date information.
FAQ: Is it really fast?
Powerlevel9k compatibility
Powerlevel10k understands all Powerlevel9k configuration parameters.
Screen recording
Migration from Powerlevel9k to Powerlevel10k is a straightforward process. All your
POWERLEVEL9Kconfiguration parameters will still work. Prompt will look the same as before (almostig)) but it will be much faster (certainly).FAQ:
im-using-powerlevel9k-with-oh-my-zsh-how-do-i-migrate)
does-powerlevel10k-always-render-exactly-the-same-prompt-as-powerlevel9k-given-the-same-config)
What-is-the-relationship-between-powerlevel9k-and-powerlevel10k)
Pure compatibility
Powerlevel10k can produce the same prompt as Pure. Type
p10k configureand select Pure style.Screen recording
You can still use Powerlevel10k features such as transient prompt or instant prompt when sporting Pure style.
To customize prompt, edit
~/.p10k.zsh. Powerlevel10k doesn’t recognize Pure configuration parameters, so you’ll need to usePOWERLEVEL9K_COMMAND_EXECUTION_TIME_THRESHOLD=3instead ofPURE_CMD_MAX_EXEC_TIME=3, etc. All relevant parameters are in~/.p10k.zsh. This file has plenty of comments to help you navigate through it.FAQ: What is the best prompt style in the configuration wizard?
Instant prompt
If your
~/.zshrcloads many plugins, or perhaps just a few slow ones (for example, pyenv or nvm), you may have noticed that it takes some time for Zsh to start.Screen recording
Powerlevel10k can remove Zsh startup lag even if it’s not caused by a theme.
Screen recording
This feature is called Instant Prompt. You need to explicitly enable it through
p10k configureor manually. It does what it says on the tin – prints prompt instantly upon Zsh startup allowing you to start typing while plugins are still loading.Other themes increase Zsh startup lag – some by a lot, others by a just a little. Powerlevel10k removes it outright.
If you are curious about how Instant Prompt works, see this section in zsh-bench.
FAQ: How do I configure instant prompt?
Show on command
The behavior of some commands depends on global environment. For example,
kubectl run ...runs an image on the cluster defined by the current kubernetes context. If you frequently change context between “prod” and “testing”, you might want to display the current context in Zsh prompt. If you do likewise for AWS, Azure and Google Cloud credentials, prompt will get pretty crowded.Enter Show On Command. This feature makes prompt segments appear only when they are relevant to the command you are currently typing.
Screen recording
Configs created by
p10k configureenable show on command for several prompt segments by default. Here’s the relevant parameter for kubernetes context:To customize when different prompt segments are shown, open
~/.p10k.zsh, search forSHOW_ON_COMMANDand either remove these parameters to display affected segments unconditionally, or change their values.Transient prompt
When Transient Prompt is enabled through
p10k configure, Powerlevel10k will trim down every prompt when accepting a command line.Screen recording
Transient prompt makes it much easier to copy-paste series of commands from the terminal scrollback.
Tip: If you enable transient prompt, take advantage of two-line prompt. You’ll get the benefit of extra space for typing commands without the usual drawback of reduced scrollback density. Sparse prompt (with an empty line before prompt) also works great in combination with transient prompt.
Current directory that just works
The current working directory is perhaps the most important prompt segment. Powerlevel10k goes to great length to highlight its important parts and to truncate it with the least loss of information when horizontal space gets scarce.
Screen recording
When the full directory doesn’t fit, the leftmost segment gets truncated to its shortest unique prefix. In the screencast,
~/workbecomes~/wo. It couldn’t be truncated to~/wbecause it would be ambiguous (there was~/wireguardwhen the session was recorded). The next segment –projects– turns intopas there was nothing else that started withpin~/work/.Directory segments are shown in one of three colors:
Tip: If you copy-paste a truncated directory and hit TAB, it’ll complete to the original.
Troubleshooting: Directory is difficult to see in prompt when using Rainbow style.
Extremely customizable
Powerlevel10k can be configured to look like any other Zsh theme out there.
Screen recording
Pure, Powerlevel9k and robbyrussell emulations are built-in. To emulate the appearance of other themes, you’ll need to write a suitable configuration file. The best way to go about it is to run
p10k configure, select the style that is the closest to your goal and then edit~/.p10k.zsh.The full range of Powerlevel10k appearance spans from spartan:
To
ridiculousextravagant:Batteries included
Powerlevel10k comes with dozens of built-in high quality prompt segments that can display information from a variety of sources. When you run
p10k configureand choose any style except Pure, many of these segments get enabled by default while others can be manually enabled by opening~/.p10k.zshand uncommenting them. You can enable as many segments as you like. It won’t slow down your prompt or Zsh startup.anacondaasdfawsaws_eb_envazurebackground_jobsbatterycommand_execution_timecontextcpu_archdirdirenvdisk_usagedotnet_versionfvmgcloudgoenvgoogle_app_credgo_versionhaskell_stackipjava_versionjenvkubecontextlaravel_versionloadluaenvmidnight_commandernix_shellnnnlfchezmoi_shellnodeenvnodenvnode_versionnordvpnnvmos_iconpackagename@versionfrom package.jsonper_directory_historyperlbrewphpenvphp_versionplenvprompt_char❯,❮,V,▶for insert, command, visual and replace mode respectively; turns red on errorproxypublic_ippyenvramrangeryazirbenvrust_versionrvmscalaenvstatusswaptaskwarriorterraformterraform_versiontimetimewarriortodotoolboxvcsvim_shell:sh)virtualenvvi_modevpn_ipwifixplrExtensible
If there is no prompt segment that does what you need, implement your own. Powerlevel10k provides public API for defining segments that are as fast and as flexible as built-in ones.
Screen recording
On Linux you can fetch current CPU temperature by reading
/sys/class/thermal/thermal_zone0/temp. The screencast shows how to define a prompt segment to display this value. Once the segment is defined, you can use it like any other segment. All standard customization parameters will work for it out of the box.Type
p10k help segmentfor reference.Note: If you modify
POWERLEVEL9K_*parameters in an already initialized interactive shell (as opposed to editing~/.p10k.zsh), the changes might not be immediately effective. To apply the modifications, invokep10k reload. SettingPOWERLEVEL9K_DISABLE_HOT_RELOAD=falseeliminates the necessity forp10k reloadbut results in a marginally slower prompt.Tip: Prefix names of your own segments with
my_to avoid clashes with future versions of Powerlevel10k.Installation
Manual
Users in China can use the official mirror on gitee.com for faster download.
中国用户可以使用 gitee.com 上的官方镜像加速下载.
This is the simplest kind of installation and it works even if you are using a plugin manager. Just make sure to disable the current theme in your plugin manager. See troubleshooting for help.
Oh My Zsh
Clone the repository:
Users in China can use the official mirror on gitee.com for faster download.
中国用户可以使用 gitee.com 上的官方镜像加速下载.
Open
~/.zshrc, find the line that setsZSH_THEME, and change its value to"powerlevel10k/powerlevel10k".Prezto
Add
zstyle :prezto:module:prompt theme powerlevel10kto~/.zpreztorc.Zim
Add
zmodule romkatv/powerlevel10k --use degitto~/.zimrcand runzimfw install.Antibody
Add
antibody bundle romkatv/powerlevel10kto~/.zshrc.Antidote
Add
romkatv/powerlevel10kto~/.zsh_plugins.txt.Antigen
Add
antigen theme romkatv/powerlevel10kto~/.zshrc. Make sure you haveantigen applysomewhere after it.Zplug
Add
zplug romkatv/powerlevel10k, as:theme, depth:1to~/.zshrc.Zgen
Add
zgen load romkatv/powerlevel10k powerlevel10kto~/.zshrc.Zplugin
Add
zplugin ice depth=1; zplugin light romkatv/powerlevel10kto~/.zshrc.The use of
depth=1ice is optional. Other types of ice are neither recommended nor officially supported by Powerlevel10k.Zinit
Add
zinit ice depth=1; zinit light romkatv/powerlevel10kto~/.zshrc.The use of
depth=1ice is optional. Other types of ice are neither recommended nor officially supported by Powerlevel10k.Zi
Add
zi ice depth=1; zi light romkatv/powerlevel10kto~/.zshrc.The use of
depth=1ice is optional. Other types of ice are neither recommended nor officially supported by Powerlevel10k.Zap
Add
plug "romkatv/powerlevel10k"to~/.zshrc.Homebrew
Arch Linux
zsh-theme-powerlevel10k-git referenced above is the official Powerlevel10k package.
Alpine Linux
Fig
Follow the instructions on this page.
Configuration
For new users
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. Configuration wizard creates~/.p10k.zshbased 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.FAQ:
what-is-the-best-prompt-style-in-the-configuration-wizard)
what-do-different-symbols-in-git-status-mean)
how-do-i-add-username-andor-hostname-to-prompt)
why-some-prompt-segments-appear-and-disappear-as-im-typing)
Troubleshooting:
sub-pixel-imperfections-around-powerline-symbols).
directory-is-difficult-to-see-in-prompt-when-using-rainbow-style).
For Powerlevel9k users
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. See Powerlevel9k compatibility.
FAQ:
im-using-powerlevel9k-with-oh-my-zsh-how-do-i-migrate)
what-is-the-relationship-between-powerlevel9k-and-powerlevel10k)
does-powerlevel10k-always-render-exactly-the-same-prompt-as-powerlevel9k-given-the-same-config)
Troubleshooting: Extra or missing spaces in prompt compared to Powerlevel9k.
Fonts
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.
👇 Recommended font: Meslo Nerd Font patched for Powerlevel10k. 👇
Meslo Nerd Font patched for Powerlevel10k
Gorgeous monospace font designed by Jim Lyles for Bitstream, customized by the same for Apple, further customized by André Berg, and finally patched by yours truly with customized scripts originally developed by Ryan L McIntyre of Nerd Fonts. Contains all glyphs and symbols that Powerlevel10k may need. Battle-tested in dozens of different terminals on all major operating systems.
FAQ: How was the recommended font created?
Automatic font installation
If you are using iTerm2 or Termux,
p10k configurecan install the recommended font for you. Simply answerYeswhen asked whether to install Meslo Nerd Font.If you are using a different terminal, proceed with manual font installation. 👇
Manual font installation
Download these four ttf files:
Double-click on each file and click “Install”. This will make
MesloLGS NFfont available to all applications on your system.Configure your terminal to use this font:
iTerm2: Type
p10k configureand answerYeswhen asked whether to install Meslo Nerd Font. Alternatively, open iTerm2 → Preferences → Profiles → Text and set Font toMesloLGS NF.Apple Terminal: Open Terminal → Preferences → Profiles → Text, click Change under Font and select
MesloLGS NFfamily.Hyper: Open Hyper → Edit → Preferences and change the value of
fontFamilyundermodule.exports.configtoMesloLGS NF.Visual Studio Code: Open File → Preferences → Settings (PC) or Code → Preferences → Settings (Mac), enter
terminal.integrated.fontFamilyin the search box at the top of Settings tab and set the value below toMesloLGS NF. Consult this screenshot to see how it should look like or see this issue for extra information.Note that software installed via Snap is unable to use system fonts. If you’ve install Visual Studio Code via Snap, remove it by running
sudo snap remove codeand install the official.debbuild from the Visual Studio Code website.GNOME Terminal (the default Ubuntu terminal): Open Terminal → Preferences and click on the selected profile under Profiles. Check Custom font under Text Appearance and select
MesloLGS NF Regular.Konsole: Open Settings → Edit Current Profile → Appearance, click Select Font and select
MesloLGS NF Regular.Tilix: Open Tilix → Preferences and click on the selected profile under Profiles. Check Custom font under Text Appearance and select
MesloLGS NF Regular.Windows Console Host (the old thing): Click the icon in the top left corner, then Properties → Font and set Font to
MesloLGS NF.Windows Terminal by Microsoft (the new thing): Open Settings (Ctrl+,), click either on the selected profile under Profiles or on Defaults, click Appearance and set Font face to
MesloLGS NF.Conemu: Open Setup → General → Fonts and set Main console font to
MesloLGS NF.IntelliJ (and other IDEs by Jet Brains): Open IDE → Edit → Preferences → Editor → Color Scheme → Console Font. Select Use console font instead of the default and set the font name to
MesloLGS NF.Termux: Type
p10k configureand answerYeswhen asked whether to install Meslo Nerd Font.Blink: Type
config, go to Appearance, tap Add a new font, tap Open Gallery, select MesloLGS NF.css, tap import and typeexitin the home view to reload the font.Tabby (formerly Terminus): Open Settings → Appearance and set Font to
MesloLGS NF.Terminator: Open Preferences using the context menu. Under Profiles select the General tab (should be selected already), uncheck Use the system fixed width font (if not already) and select
MesloLGS NF Regular. Exit the Preferences dialog by clicking Close.Guake: Right Click on an open terminal and open Preferences. Under Appearance tab, uncheck Use the system fixed width font (if not already) and select
MesloLGS NF Regular. Exit the Preferences dialog by clicking Close.MobaXterm: Open Settings → Configuration → Terminal → (under Terminal look and feel) and change Font to
MesloLGS NF. If you have sessions, you need to change the font in each of them through Settings → right click on an individual session → Edit Session → Terminal Settings → Font settings.Asbrú Connection Manager: Open Preferences → Local Shell Options → Look and Feel, enable Use these personal options and change Font: under Terminal UI to
MesloLGS NF Regular. To change the font for the remote host connections, go to Preferences → Terminal Options → Look and Feel and change Font: under Terminal UI toMesloLGS NF Regular.Warp: Open Warp and Navigate to Settings then Appearance. Scroll down to Text Section and under “Terminal Font”, select the
MesloLGS NFfont.WSLtty: Right click on an open terminal and then on Options. In the Text section, under Font, click “Select…” and set Font to
MesloLGS NF Regular.Yakuake: Click ≡ → Manage Profiles → New → Appearance. Click Choose next to the Font dropdown, select
MesloLGS NFand click OK. Click OK to save the profile. Select the new profile and click Set as Default.Alacritty: Create or open
~/.config/alacritty/alacritty.tomland add the following section to it:foot: Create or open
~/.config/foot/foot.iniand add the following section to it:kitty: Create or open
~/.config/kitty/kitty.confand add the following line to it:Restart kitty by closing all sessions and opening a new session.
puTTY: Set Window → Appearance → Font to
MesloLGS NF. Requires puTTY version >= 0.75.WezTerm: Create or open
$HOME/.config/wezterm/wezterm.luaand add the following:If the file already exists, only add the line with the font to the existing return. Also add the first line if it is not already present.
urxvt: Create or open
~/.Xresourcesand add the following line to it:You can adjust the font size to your preference. After changing the config run
xrdb ~/.Xresourcesto reload it. The new config is applied to all new terminals.xterm: Create or open
~/.Xresourcesand add the following line to it:After changing the config run
xrdb ~/.Xresourcesto reload it. The new config is applied to all new terminals.Zed: Open
~/.config/zed/settings.jsonand setterminal.font_familyto"MesloLGS NF".Crostini (Linux on Chrome OS): Open chrome-untrusted://terminal/html/nassh_preferences_editor.html, set Text font family to
'MesloLGS NF'(including the quotes) and Custom CSS (inline text) to the following:CAVEAT: If you open the normal terminal preferences these settings will be overwritten.
Deepin Terminal: Create or open
~/.config/deepin/deepin-terminal/config.confand add the following section to it:Ghostty: Open Menu → Open Configuration (Linux) or Ghostty → Settings… (Mac) and add the following line:
Run
p10k configureto generate a new~/.p10k.zsh. The old config may work incorrectly with the 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 it in Docker
Try Powerlevel10k in Docker. You can safely make any changes to the file system while trying out the theme. Once you exit Zsh, the container is deleted.
Tip: Install the recommended font before running the Docker command to get access to all prompt styles.
Tip: Run
p10k configurewhile in Docker to try a different prompt style.License
Powerlevel10k is released under the MIT license.
FAQ
$HOME/.gitnot displayed in prompt?How do I update Powerlevel10k?
The command to update Powerlevel10k depends on how it was installed.
git -C ~/powerlevel10k pullgit -C "${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/themes/powerlevel10k" pullzprezto-updatezimfw updateantigen updateantidote updatezplug updatezgen updatezplugin updatezinit updatezi updatezap updatebrew update && brew upgradeyay -S --noconfirm zsh-theme-powerlevel10k-gitapk update && apk upgradeIMPORTANT: Restart Zsh after updating Powerlevel10k. Do not use
source ~/.zshrc.How do I uninstall Powerlevel10k?
Remove all references to “p10k” from
~/.zshrc. You might have this snippet at the top:And this at the bottom:
These are added by the configuration wizard. Remove them.
Remove all references to “powerlevel10k” from
~/.zshrc,~/.zpreztorcand~/.zimrc(some of these files may be missing – this is normal). These references have been added manually by yourself when installing Powerlevel10k. Refer to the installation instructions if you need a reminder.Verify that all references to “p10k” and “powerlevel10k” are gone from
~/.zshrc,~/.zpreztorcand~/.zimrc.If this command produces output, there are still references to “p10k” or “powerlevel10k”. You need to remove them.
Delete Powerlevel10k configuration file. This file is created by the configuration wizard and may contain manual edits by yourself.
Delete Powerlevel10k source files. These files have been downloaded when you’ve installed Powerlevel10k. The command to delete them depends on which installation method you’d chosen. Refer to the installation instructions if you need a reminder.
rm -rf ~/powerlevel10krm -rf -- "${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}/themes/powerlevel10k"zimfw uninstallantigen purge romkatv/powerlevel10kantidote purge romkatv/powerlevel10kzplug cleanzgen resetzplugin delete romkatv/powerlevel10kzinit delete romkatv/powerlevel10kzi delete romkatv/powerlevel10kzsh -ic 'zap clean'brew uninstall powerlevel10kyay -R --noconfirm zsh-theme-powerlevel10k-gitapk del zsh-theme-powerlevel10kRestart Zsh. Do not use
source ~/.zshrc.Delete Powerlevel10k cache files.
How do I install Powerlevel10k on a machine without Internet access?
target_unamewith the output of the previous command:~/powerlevel10kfrom the machine connected to the Internet to the one without Internet access.source ~/powerlevel10k/powerlevel10k.zsh-themeto~/.zshrcon the machine without Internet access:~/.zshrcon the machine without Internet access setsZSH_THEME, remove that line.To update, remove
~/powerlevel10kon both machines and repeat steps 1-3.Where can I ask for help and report bugs?
The best way to ask for help and to report bugs is to open an issue.
Gitter is another option.
If all else fails, email roman.perepelitsa@gmail.com.
If necessary, encrypt your communication with this PGP key.
Which aspects of shell and terminal does Powerlevel10k affect?
Powerlevel10k defines prompt and nothing else. It sets prompt-related options, and parameters
PS1andRPS1.Everything within the highlighted areas on the screenshot is produced by Powerlevel10k. Powerlevel10k has no control over the terminal content or colors outside these areas.
Powerlevel10k does not affect:
ls.gitcommand.PS1andRPS1.p10k.I’m using Powerlevel9k with Oh My Zsh. How do I migrate?
p10k configureand choose your favorite prompt style.Related:
does-powerlevel10k-always-render-exactly-the-same-prompt-as-powerlevel9k-given-the-same-config)
extra-or-missing-spaces-in-prompt-compared-to-powerlevel9k)
Is it really fast?
Yes. See zsh-bench or a direct comparison with Powerlevel9k and Spaceship.
How do I configure instant prompt?
See instant prompt to learn about instant prompt. This section explains how you can enable and configure it and lists caveats that you should be aware of.
Instant prompt can be enabled either through
p10k configureor by manually adding the following code snippet at the top of~/.zshrc:It’s important that you copy the lines verbatim. Don’t replace
sourcewith something else, don’t callzcompile, don’t redirect output, etc.When instant prompt is enabled, for the duration of Zsh initialization standard input is redirected to
/dev/nulland 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
~/.zshrcthat breaks when instant prompt is enabled:Fixed version:
If
POWERLEVEL9K_INSTANT_PROMPTis unset or set toverbose, 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) withPOWERLEVEL9K_INSTANT_PROMPT=quiet. This is recommended if some initialization code in~/.zshrcprints 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 withPOWERLEVEL9K_INSTANT_PROMPT=off. Do this if instant prompt breaks Zsh initialization and you don’t know how to fix it.The value of
POWERLEVEL9K_INSTANT_PROMPTcan be changed by runningp10k configureand selecting the appropriate option on the Instant Prompt screen. Alternatively, you can search forPOWERLEVEL9K_INSTANT_PROMPTin the existing~/.p10k.zshand change its value there.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.
FAQ:
how-do-i-initialize-direnv-when-using-instant-prompt)
how-do-i-export-gpg_tty-when-using-instant-prompt)
How do I initialize direnv when using instant prompt?
If you’ve enabled instant prompt, you should have these lines at the top of
~/.zshrc:To initialize direnv you need to add one line above that block and one line below it.
Related: How do I export GPG_TTY when using instant prompt?
How do I export GPG_TTY when using instant prompt?
You can export
GPG_TTYlike this anywhere in~/.zshrc:This works whether you are using instant prompt or not. It works even if you aren’t using powerlevel10k. As an extra bonus, it’s much faster than the commonly used
export GPG_TTY=$(tty).Related: How do I initialize direnv when using instant prompt?
What do different symbols in Git status mean?
When using Lean, Classic or Rainbow style, Git status may look like this:
feature#tagor@commitif not on a branchgit status --ignore-submodules=dirtymastergit rev-parse --abbrev-ref --symbolic-full-name @{upstream}wipgit show --pretty=%s --no-patch HEAD=git rev-list --count HEAD...@{upstream}⇣42git rev-list --right-only --count HEAD...@{upstream}⇡42git rev-list --left-only --count HEAD...@{upstream}⇠42git rev-list --right-only --count HEAD...@{push}⇢42git rev-list --left-only --count HEAD...@{push}*42git stash listmergegit status --ignore-submodules=dirty~42git status --ignore-submodules=dirty+42git status --ignore-submodules=dirty!42git status --ignore-submodules=dirty?42git status --ignore-submodules=dirty─echo $POWERLEVEL9K_VCS_MAX_INDEX_SIZE_DIRTYorgit config --get bash.showDirtyStateRelated: How do I change the format of Git status?
How do I change the format of Git status?
To change the format of Git status, open
~/.p10k.zsh, search formy_git_formatterand edit its source code.Related: What do different symbols in Git status mean?
Why is Git status from
$HOME/.gitnot displayed in prompt?When using Lean, Classic or Rainbow style,
~/.p10k.zshcontains the following parameter:To see Git status for
$HOME/.gitin prompt, open~/.p10k.zshand removePOWERLEVEL9K_VCS_DISABLED_WORKDIR_PATTERN.Why does Git status sometimes appear grey and then gets colored after a short period of time?
tl;dr: When Git status in prompt is greyed out, it means Powerlevel10k is currently computing up-to-date Git status in the background. Prompt will get automatically refreshed when this computation completes.
When your current directory is within a Git repository, Powerlevel10k computes up-to-date Git status after every command. If the repository is large, or the machine is slow, this computation can take quite a bit of time. If it takes longer than 10 milliseconds (configurable via
POWERLEVEL9K_VCS_MAX_SYNC_LATENCY_SECONDS), Powerlevel10k displays the last known Git status in grey and continues to compute up-to-date Git status in the background. When the computation completes, Powerlevel10k refreshes prompt with new information, this time with colored Git status.When using Rainbow style, Git status is displayed as black on grey while it’s still being computed. Depending on the terminal color palette, this may be difficult to read. In this case you might want to change the background color to something lighter for more contrast. To do that, open
~/.p10k.zsh, search forPOWERLEVEL9K_VCS_LOADING_BACKGROUND, uncomment it if it’s commented out, and change the value.Type
source ~/.p10k.zshto apply your changes to the current Zsh session.Related: How do I change prompt colors?
How do I add username and/or hostname to prompt?
When using Lean, Classic or Rainbow style, prompt shows
username@hostnamewhen you are logged in as root or via SSH. There is little value in showingusernameorhostnamewhen you are logged in to your local machine as a normal user. So the absence ofusername@hostnamein 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.Search for
contextto find the section in the config that lists parameters specific to this prompt segment. You should see the following lines:If you follow the tip and remove (or comment out) the last line, you’ll always see
username@hostnamein prompt. You can change the format to justusername, or change the color, by adjusting the values of parameters nearby. There are plenty of comments to help you navigate.You can also move
contextto a different position inPOWERLEVEL9K_RIGHT_PROMPT_ELEMENTSor even toPOWERLEVEL9K_LEFT_PROMPT_ELEMENTS.Why some prompt segments appear and disappear as I’m typing?
Prompt segments can be configured to be shown only when the current command you are typing invokes a relevant tool.
Configs created by
p10k configuremay contain parameters of this kind. To customize when different prompt segments are shown, open~/.p10k.zsh, search forSHOW_ON_COMMANDand either remove these parameters or change their values.You can also define a function in
~/.zshrcto toggle the display of a prompt segment between always and on command. This is similar tokubeon/kubeofffrom kube-ps1.Invoke this function by typing
kube-toggle. You can also bind it to a key by adding two more lines to~/.zshrc:How do I change prompt colors?
You can either change the color palette used by your terminal or set colors through Powerlevel10k configuration parameters.
Change the color palette used by your terminal
How exactly you change the terminal color palette (a.k.a. color scheme, or theme) depends on the kind of terminal you are using. Look around in terminal’s settings/preferences or consult documentation.
When you change the terminal color palette, it usually affects only the first 16 colors, numbered from 0 to 15. In order to see any effect on Powerlevel10k prompt, you need to use prompt style that utilizes these low-numbered colors. Type
p10k configureand select Rainbow, Lean → 8 colors or Pure → Original. Other styles use higher-numbered colors, so they look the same in any terminal color palette.Set colors through Powerlevel10k configuration parameters
Open
~/.p10k.zsh, search for “color”, “foreground” and “background” and change values of appropriate parameters. For example, here’s how you can set the foreground oftimeprompt segment to bright red:Colors are specified using numbers from 0 to 255. Colors from 0 to 15 look differently in different terminals. Many terminals also support customization of these colors through color palettes (a.k.a. color schemes, or themes). Colors from 16 to 255 always look the same.
Type
source ~/.p10k.zshto apply your changes to the current Zsh session.To see how different numbered colors look in your terminal, run the following command: