This repository has been archived on 2022-03-28. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
2014-01-03 14:20:32 -05:00
modules [Fix #514] Use /tmp when $TMPDIR is undefined 2014-01-03 14:20:32 -05:00
runcoms [Fix #523] Ensure zprofile exists before sourcing it 2014-01-03 13:37:36 -05:00
.gitignore [#23] Rename plugins to modules 2012-04-05 13:39:40 -04:00
.gitmodules [#129, #211] Remove z 2012-09-30 16:29:41 -04:00
CONTRIBUTING.md [Fix #293] Add CONTRIBUTING.md 2012-09-25 13:17:16 -04:00
init.zsh Allow functions in a module to be symlinks 2014-01-03 13:30:55 -05:00
README.md Fix README.md: PATH was moved from .zshenv to .zprofile 2014-01-03 13:41:05 -05:00

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 recommended version is 4.3.11. Unfortunately, Cygwin is not supported due to non-standard core utilities.

  1. Launch Zsh:

    zsh

  2. Clone the repository:

    git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto"

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

  4. Set Zsh as your default shell:

    chsh -s /bin/zsh

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

  1. Browse /modules to see what is available.
  2. Load the modules you need in ~/.zpreztorc then open a new Zsh terminal window or tab.

Themes

  1. For a list of themes, type prompt -l.

  2. To preview a theme, type prompt -p name.

  3. Load the theme you like in ~/.zpreztorc then open a new Zsh terminal window or tab.

    sorin theme

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

(The MIT License)

Copyright (c) 2009-2011 Robby Russell and contributors. Copyright (c) 2011-2014 Sorin Ionescu and contributors.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.