The configuration framework for Zsh (zotan fork)

Go to file

Samantha McVey f8f4953dce [completion] Bump external repository to version 0.25.0 8cdf60b Updated rkt commands and arguments f9d7d9d Implemented autocompletion for rkt pods and images (Fixes #465) 9feab39 Added completion for yarn a63a098 Update completion for mix, add completion for mix test, fix completion for mix help 6285e0e Add completions for bitcoin-cli 0ed2e86 Set proper description for gist -r df5a3a1 Try to follow the style guide d7a2972 Add gist completion for read flag b0cb2ad Added _rclone b7c11f4 drop ripgrep completion 907cba3 Update repository infos ccb53f4 Support newer versions of OpenSSL f02dc8f add licence information ceaff68 Add completion for ffind		2017-06-22 10:35:44 -07:00
.github	Remove additional newlines in issue and pull request templates	2017-04-15 01:47:58 -07:00
modules	[completion] Bump external repository to version 0.25.0	2017-06-22 10:35:44 -07:00
runcoms	sorin theme: Use a proper temp file for async data	2017-06-13 10:36:35 -07:00
.gitignore	[#23 ] Rename plugins to modules	2012-04-05 13:39:40 -04:00
.gitmodules	Update zsh-autosuggestions submodule location	2017-04-04 23:00:28 -07:00
CONTRIBUTING.md	Add note to CONTRIBUTING.md about zstyle	2017-04-15 01:36:15 -07:00
init.zsh	Change print to printf in init.zsh error (#1335 )	2017-06-19 14:18:14 -07:00
LICENSE	Bump license years and tidy up readme (#1273 )	2017-04-05 09:34:31 -07:00
README.md	Fix indentation in README	2017-04-13 03:27:59 -07:00

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.