A fork of prezto. Originally created by Sorin Ionescu.

Stefano Mazzucco be0913862b Make zlogout more reliable 6 months ago
.github b3c7d21d31 Adjust GitHub templates with commented lines 3 years ago
keymaps 1376a1a69b map keypad enter to enter 5 years ago
modules 26d6395d45 Merge remote-tracking branch 'upstream/master' 7 months ago
runcoms be0913862b Make zlogout more reliable 6 months ago
.editorconfig 86de7a8d2e Small editorconfig file cleanup 3 years ago
.gitignore 025085a4da Merge remote-tracking branch 'upstream/master' 2 years ago
.gitmodules ac65e8eb18 Add powerlevel10k theme (#1695) 1 year ago
CONTRIBUTING.md 74a914c476 Merge remote-tracking branch 'upstream/master' into master 2 years ago
LICENSE b08bfe2f14 Add copyright notice to LICENSE 2 years ago
NEWS f70c3e4554 NEWS: migrating to notabug.org 5 years ago
README.md 7d7972fcfc Merge remote-tracking branch 'upstream/master' 1 year ago
init.zsh a3a51bdf6c Support pmodule-allow-overrides feature (#1780) 7 months 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.

About this fork

This fork of Prezto has been created to add some specific customization that would likely not fit with the official (upstream) repository.

The code is hosted on Notabug.org, which is free and open source software.

Installation

Prezto will work with any recent release of Zsh, but the minimum required version is 4.3.11.

  1. Launch Zsh:

     zsh
    
  2. Clone the repository:

     git clone --recursive https://notabug.org/stefano-m/prezto.git "${ZDOTDIR:-$HOME}/.zprezto"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 configuration files, ln will cause error. In simple cases you can load prezto by adding the line source "${ZDOTDIR:-$HOME}/.zprezto/init.zsh" to the bottom of your .zshrc and 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.

  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

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

  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 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 the pmodule list (under zstyle ':prezto:load' pmodule \ in your ~/.zpreztorc) to enable this module.

External Modules

  1. By default modules will be loaded from /modules and /contrib.
  2. Additional module directories can be added to the :prezto:load:pmodule-dirs setting 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 your favorite repo 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-2017 Sorin Ionescu and contributors.

Copyright (c) 2014-2017 Stefano Mazzucco

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.