Prezto is the configuration framework for Zsh; it enriches the command line interface environment with sane defaults, aliases, functions, auto completion, and prompt themes.
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.
Prezto will work with any recent release of Zsh, but the minimum required version is 4.3.11.
Launch Zsh:
zsh
Clone the repository:
git clone --recursive https://notabug.org/stefano-m/prezto.git "${ZDOTDIR:-$HOME}/.zprezto
Optional: Installing in
$XDG_CONFIG_HOME
Optionally, if you already have $XDG_CONFIG_HOME
configured (usually as
$HOME/.config
by default) and intend to install Prezto under
$XDG_CONFIG_HOME/zsh
instead, you can clone the repository there and
configure $ZDOTDIR
separately if not already configured.
Clone the repository:
git clone --recursive https://notabug.org/stefano-m/prezto.git "${ZDOTDIR:-${XDG_CONFIG_HOME:-$HOME/.config}/zsh}/.zprezto"
Configure $XDG_CONFIG_HOME
and $ZDOTDIR
in $HOME/.zshenv
:
export XDG_CONFIG_HOME="${XDG_CONFIG_HOME:=$HOME/.config}"
export ZDOTDIR="${ZDOTDIR:=$XDG_CONFIG_HOME/zsh}"
source "$ZDOTDIR/.zshenv"
Create a new Zsh configuration by copying/linking 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
in
the above operation will cause an error. In simple cases, you can load
Prezto by adding the line source "${ZDOTDIR:-$HOME}/.zprezto/init.zsh"
to
the bottom of your ${ZDOTDIR:-$HOME}/.zshrc
and keep the rest of your
Zsh configuration intact. For more complicated setups, we recommend 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.
Fig adds apps, shortcuts, and autocomplete to your existing terminal.
Install prezto
in just one click.
If you are not able to find certain commands after switching to Prezto, modify
the PATH
variable in ${ZDOTDIR:-$HOME}/.zprofile
then open a new Zsh
terminal window or tab.
Run zprezto-update
to automatically check if there is an update to Prezto.
If there are no file conflicts, Prezto and its submodules will be automatically
updated. If there are conflicts you will be 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 sync --recursive
git submodule update --init --recursive
Prezto has many features disabled by default. Read the source code and the accompanying README files to learn about what is available.
modules
to see what is available.${ZDOTDIR:-$HOME}/.zpreztorc
and then open
a new Zsh terminal window or tab.prompt -l
.prompt -p name
.Load the theme you like in ${ZDOTDIR:-$HOME}/.zpreztorc
and then
open a new Zsh terminal window or tab.
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
${ZDOTDIR:-$HOME}/.zpreztorc
) to enable this module.
/modules
and /contrib
.Additional module directories can be added to the
:prezto:load:pmodule-dirs
setting in ${ZDOTDIR:-$HOME}/.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
The project is managed via Git. We highly recommend that you fork this project so that you can commit your changes and push them to your fork on GitHub to preserve them. If you do not know how to use Git, follow this tutorial and bookmark this reference.
The Zsh Reference Card and the zsh-lovers man page are indispensable.
(The MIT License)
Copyright (c) 2009-2011 Robby Russell and contributors.
Copyright (c) 2011-2022 Sorin Ionescu and contributors.
Copyright (c) 2014-2022 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.