Prezto — Instantly Awesome Zsh
Prezto is the configuration framework for Zsh; it enriches the command line
interface environment with sane defaults, aliases, functions, auto completion,
and prompt themes.
Installation
Prezto will work with any recent release of Zsh, but the minimum required
version is 4.3.11.
-
Launch Zsh:
zsh -
Clone the repository:
git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto" -
Create a new Zsh configuration by copying the Zsh configuration files
provided:setopt EXTENDED_GLOB for rcfile in "${ZDOTDIR:-$HOME}"/.zprezto/runcoms/^README.md(.N); do ln -s "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}" doneNote: If you already have any of the given configuration files,
lnwill
cause error. In simple cases you can load prezto by adding the line
source "${ZDOTDIR:-$HOME}/.zprezto/init.zsh"to the bottom of your
.zshrcand keep the rest of your Zsh configuration intact. For more
complicated setups, it is recommended that you back up your original
configs and replace them with the provided prezto runcoms. -
Set Zsh as your default shell:
chsh -s /bin/zsh -
Open a new Zsh terminal window or tab.
Troubleshooting
If you are not able to find certain commands after switching to Prezto,
modify the PATH variable in ~/.zprofile then open a new Zsh terminal
window or tab.
Updating
Run zprezto-update to automatically check if there is an update to zprezto.
If there are no file conflicts, zprezto and its submodules will be
automatically updated. If there are conflicts you will instructed to go into
the $ZPREZTODIR directory and resolve them yourself.
To pull the latest changes and update submodules manually:
cd $ZPREZTODIR
git pull
git submodule update --init --recursive
Usage
Prezto has many features disabled by default. Read the source code and
accompanying README files to learn of what is available.
Modules
- Browse /modules to see what is available.
- Load the modules you need in ~/.zpreztorc then open a new Zsh terminal
window or tab.
Themes
-
For a list of themes, type
prompt -l. -
To preview a theme, type
prompt -p name. -
Load the theme you like in ~/.zpreztorc then open a new Zsh terminal
window or tab.
Note that the 'git' module may be required for special symbols to appear,
such as those on the right of the above image. Add'git'to thepmodule
list (underzstyle ':prezto:load' pmodule \in your ~/.zpreztorc) to
enable this module.
External Modules
-
By default modules will be loaded from /modules and /contrib.
-
Additional module directories can be added to the
:prezto:load:pmodule-dirssetting in ~/.zpreztorc.Note that module names need to be unique or they will cause an error when
loading.zstyle ':prezto:load' pmodule-dirs $HOME/.zprezto-contrib
Customization
The project is managed via Git. It is highly recommended that you fork this
project; so, that you can commit your changes and push them to GitHub to
not lose them. If you do not know how to use Git, follow this tutorial and
bookmark this reference.
Resources
The Zsh Reference Card and the zsh-lovers man page are indispensable.
License
This project is licensed under the MIT License.