The configuration framework for Zsh

Go to file

Kaleb Elwert 46a1ffaf7e Add gbr and gbR aliases to module readme		8 years ago
.github	Remove additional newlines in issue and pull request templates	8 years ago
modules	Add gbr and gbR aliases to module readme	8 years ago
runcoms	Convert long-pwd to pwd-length	8 years ago
.gitignore	[#23 ] Rename plugins to modules	13 years ago
.gitmodules	Update zsh-autosuggestions submodule location	8 years ago
CONTRIBUTING.md	Add note to CONTRIBUTING.md about zstyle	8 years ago
LICENSE	Bump license years and tidy up readme (#1273 )	8 years ago
README.md	Fix indentation in README	8 years ago
init.zsh	Don't load pfunctions from vi swap files	8 years ago

README.md

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.17.

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}"
done
```
Note: If you already have any of the given config files, ln will error. In simple cases you can add source "${ZDOTDIR:-$HOME}/.zprezto/init.zsh" to the bottom of your .zshrc to load prezto but keep your config 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

Pull the latest changes and update submodules.

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.

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.