The configuration framework for Zsh
Go to file
Samantha McVey 7fe28574a8 [syntax-highlighting] Bump external repository to get bug fixes
ad522a0 driver: Fix printing error message to file when cannot resolve highlighters directory location
73cb832 'main': Highlight mismatched 'if'/'fi'.
be083d7 driver: Improve «unhandled ZLE widget 'foo'» error message.
237f89a 'main': Don't consider «$*» a glob.
835fec7 workaround for PAT_STATIC bug in zsh
9523d6d tests: zsh 5.4-to-be compatibility: Set a new "I am shooting myself in the foot" option.
aac4a44 driver: Fix duplicated slash in error message
4f49c4a docs: Update zplug install instruction
5efd062 tests: Add a regression test for issue #392 (aliases beginning with a '+' are lost).
67be621 tests: Move some code in preparation for next commit. No functional change.
74949c2 driver: Don't undefine aliases that begin with a '+', to workaround an upstream bug.
8d5afe4 driver: Be immune to 'alias' having been redefined.
76ea9e1 'main': Highlight possible history expansions in double-quoted strings.
50fbb5f docs: Update Homebrew link.
2dce602 driver: Be immune to weird aliases in the calling scope.
347cf0e 'main': Add regression test for previous commit.
5625e30 'main': Fix bug: no start_pos=$end_pos in comment short path
fed37a9 'main': Fix a bug concerning command word with embedded colon-space sequences.
626c034 Add FreeBSD port
3d74aa4 Add Fedora package
5398949 changelog: Update for changes pulled out of 0.5.x.
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 [syntax-highlighting] Bump external repository to get bug fixes 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

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.

  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
    

    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.

  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

This project is licensed under the MIT License.