mirror of
https://github.com/sorin-ionescu/prezto.git
synced 2025-01-23 11:22:17 +08:00
Merge f892755c9e into 9626ce2beb
This commit is contained in:
Fpointzero
GitHub
commit
73b1e6daa7
362
README.md
362
README.md
@ -1,160 +1,202 @@
|
|||||||
# Prezto — Instantly Awesome Zsh
|
# Prezto — Instantly Awesome Zsh
|
||||||
|
|
||||||
Prezto is the configuration framework for [Zsh][1]; it enriches the command line
|
Prezto is the configuration framework for [Zsh][1]; it enriches the command line
|
||||||
interface environment with sane defaults, aliases, functions, auto completion,
|
interface environment with sane defaults, aliases, functions, auto completion,
|
||||||
and prompt themes.
|
and prompt themes.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### Manual
|
### Manual
|
||||||
|
|
||||||
Prezto will work with any recent release of Zsh, but the minimum required
|
Prezto will work with any recent release of Zsh, but the minimum required
|
||||||
version is **4.3.11**.
|
version is **4.3.11**.
|
||||||
|
|
||||||
01. Launch Zsh:
|
01. Launch Zsh:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
zsh
|
zsh
|
||||||
```
|
```
|
||||||
|
|
||||||
02. Clone the repository:
|
02. Clone the repository:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto"
|
git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto"
|
||||||
```
|
```
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary><em>Optional: Installing in <code>$XDG_CONFIG_HOME</code></em></summary>
|
<summary><em>Optional: Installing in <code>$XDG_CONFIG_HOME</code></em></summary>
|
||||||
|
|
||||||
Optionally, if you already have `$XDG_CONFIG_HOME` configured (usually as
|
Optionally, if you already have `$XDG_CONFIG_HOME` configured (usually as
|
||||||
_`$HOME/.config`_ by default) and intend to install Prezto under
|
_`$HOME/.config`_ by default) and intend to install Prezto under
|
||||||
_`$XDG_CONFIG_HOME/zsh`_ instead, you can clone the repository there and
|
_`$XDG_CONFIG_HOME/zsh`_ instead, you can clone the repository there and
|
||||||
configure `$ZDOTDIR` separately if not already configured.
|
configure `$ZDOTDIR` separately if not already configured.
|
||||||
|
|
||||||
- Clone the repository:
|
- Clone the repository:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-${XDG_CONFIG_HOME:-$HOME/.config}/zsh}/.zprezto"
|
git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-${XDG_CONFIG_HOME:-$HOME/.config}/zsh}/.zprezto"
|
||||||
```
|
```
|
||||||
|
|
||||||
- Configure `$XDG_CONFIG_HOME` and `$ZDOTDIR` in _`$HOME/.zshenv`_:
|
- Configure `$XDG_CONFIG_HOME` and `$ZDOTDIR` in _`$HOME/.zshenv`_:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
export XDG_CONFIG_HOME="${XDG_CONFIG_HOME:=$HOME/.config}"
|
export XDG_CONFIG_HOME="${XDG_CONFIG_HOME:=$HOME/.config}"
|
||||||
[[ -d $XDG_CONFIG_HOME/zsh ]] && export ZDOTDIR="$XDG_CONFIG_HOME/zsh"
|
[[ -d $XDG_CONFIG_HOME/zsh ]] && export ZDOTDIR="$XDG_CONFIG_HOME/zsh"
|
||||||
source "$ZDOTDIR/.zshenv"
|
source "$ZDOTDIR/.zshenv"
|
||||||
```
|
```
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
03. Create a new Zsh configuration by copying/linking the Zsh configuration
|
03. Create a new Zsh configuration by copying/linking the Zsh configuration
|
||||||
files provided:
|
files provided:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
setopt EXTENDED_GLOB
|
setopt EXTENDED_GLOB
|
||||||
for rcfile in "${ZDOTDIR:-$HOME}"/.zprezto/runcoms/^README.md(.N); do
|
for rcfile in "${ZDOTDIR:-$HOME}"/.zprezto/runcoms/^README.md(.N); do
|
||||||
ln -s "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}"
|
ln -s "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}"
|
||||||
done
|
done
|
||||||
```
|
```
|
||||||
|
If you use windows, please use this command (save as `example.bat` and run it).
|
||||||
**Note:** If you already have any of the given configuration files, `ln` in
|
```bat
|
||||||
the above operation will cause an error. In simple cases, you can load
|
@echo off
|
||||||
Prezto by adding the line `source "${ZDOTDIR:-$HOME}/.zprezto/init.zsh"` to
|
setlocal enabledelayedexpansion
|
||||||
the bottom of your _`${ZDOTDIR:-$HOME}/.zshrc`_ and keep the rest of your
|
REM Define Homedir (If use zsh --login to use zsh please set HomeDir as the absolute path of /home/xxxx in your Windows (like C:\MSYS2\home\xxxx))
|
||||||
Zsh configuration intact. For more complicated setups, we recommend that you
|
set "HomeDir=%USERPROFILE%"
|
||||||
back up your original configs and replace them with the provided Prezto
|
set "sourceDir=%HomeDir%\.zprezto\runcoms"
|
||||||
[_`runcoms`_][10].
|
set "linkDir=%HomeDir%"
|
||||||
|
echo "sourceDir = %sourceDir%"
|
||||||
04. Set Zsh as your default shell:
|
echo "linkDir = %linkDir%"
|
||||||
|
REM Create Config Linking
|
||||||
```console
|
if not exist "%linkDir%" mkdir "%linkDir%"
|
||||||
chsh -s /bin/zsh
|
for /R "%sourceDir%" %%F in (*) do (
|
||||||
```
|
set "fileName=%%~nxF"
|
||||||
|
REM echo "filename=!fileName!"
|
||||||
05. Open a new Zsh terminal window or tab.
|
REM echo "F=%%F"
|
||||||
|
REM pause
|
||||||
### Troubleshooting
|
if /I not "!fileName!"=="README.md" (
|
||||||
|
mklink "%linkDir%\.!fileName!" "%%F"
|
||||||
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.
|
REM Define
|
||||||
|
set PROMPT_DIR="%HomeDir%\.zprezto\modules\prompt"
|
||||||
## Updating
|
echo "PROMPT_DIR: %PROMPT_DIR%"
|
||||||
|
set array[0]="%PROMPT_DIR%\functions\async"
|
||||||
Run `zprezto-update` to automatically check if there is an update to Prezto.
|
set array[1]="%PROMPT_DIR%\functions\prompt_agnoster_setup"
|
||||||
If there are no file conflicts, Prezto and its submodules will be automatically
|
set array[2]="%PROMPT_DIR%\functions\prompt_powerlevel10k_setup"
|
||||||
updated. If there are conflicts you will be instructed to go into the
|
set array[3]="%PROMPT_DIR%\functions\prompt_powerline_setup"
|
||||||
`$ZPREZTODIR` directory and resolve them yourself.
|
set array[4]="%PROMPT_DIR%\functions\prompt_pure_setup"
|
||||||
|
REM Del Prompt External Functions
|
||||||
To pull the latest changes and update submodules manually:
|
for /l %%i in (0,1,4) do (
|
||||||
|
echo "!array[%%i]!"
|
||||||
```console
|
del /f !array[%%i]!
|
||||||
cd $ZPREZTODIR
|
)
|
||||||
git pull
|
REM Make Linking For External Functions
|
||||||
git submodule sync --recursive
|
mklink "%PROMPT_DIR%\functions\async" "%PROMPT_DIR%\external\async\async.zsh"
|
||||||
git submodule update --init --recursive
|
mklink "%PROMPT_DIR%\functions\prompt_agnoster_setup" "%PROMPT_DIR%\external\agnoster\agnoster.zsh-theme"
|
||||||
```
|
mklink "%PROMPT_DIR%\functions\prompt_powerlevel10k_setup" "%PROMPT_DIR%\external\powerlevel10k\powerlevel10k.zsh-theme"
|
||||||
|
mklink "%PROMPT_DIR%\functions\prompt_powerline_setup" "%PROMPT_DIR%\external\powerline\prompt_powerline_setup"
|
||||||
## Usage
|
mklink "%PROMPT_DIR%\functions\prompt_pure_setup" "%PROMPT_DIR%\external\pure\pure.zsh"
|
||||||
|
endlocal
|
||||||
Prezto has many features disabled by default. Read the source code and the
|
```
|
||||||
accompanying README files to learn about what is available.
|
|
||||||
|
**Note:** If you already have any of the given configuration files, `ln` in
|
||||||
### Modules
|
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
|
||||||
01. Browse [_`modules`_][9] to see what is available.
|
the bottom of your _`${ZDOTDIR:-$HOME}/.zshrc`_ and keep the rest of your
|
||||||
02. Load the modules you need in _`${ZDOTDIR:-$HOME}/.zpreztorc`_ and then open
|
Zsh configuration intact. For more complicated setups, we recommend that you
|
||||||
a new Zsh terminal window or tab.
|
back up your original configs and replace them with the provided Prezto
|
||||||
|
[_`runcoms`_][10].
|
||||||
### Themes
|
|
||||||
|
04. Set Zsh as your default shell:
|
||||||
01. For a list of themes, type `prompt -l`.
|
|
||||||
02. To preview a theme, type `prompt -p name`.
|
```console
|
||||||
03. Load the theme you like in _`${ZDOTDIR:-$HOME}/.zpreztorc`_ and then
|
chsh -s /bin/zsh
|
||||||
open a new Zsh terminal window or tab.
|
```
|
||||||
|
|
||||||
![sorin theme][2]
|
05. Open a new Zsh terminal window or tab.
|
||||||
Note that the [_`git`_][11] module may be required for special symbols to
|
|
||||||
appear, such as those on the right of the above image. Add `'git'` to the
|
### Troubleshooting
|
||||||
`pmodule` list (under `zstyle ':prezto:load' pmodule \` in your
|
|
||||||
_`${ZDOTDIR:-$HOME}/.zpreztorc`_) to enable this module.
|
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
|
||||||
### External Modules
|
terminal window or tab.
|
||||||
|
|
||||||
01. By default modules will be loaded from [_`/modules`_][9] and _`/contrib`_.
|
## Updating
|
||||||
02. Additional module directories can be added to the
|
|
||||||
`:prezto:load:pmodule-dirs` setting in _`${ZDOTDIR:-$HOME}/.zpreztorc`_.
|
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
|
||||||
Note that module names need to be unique or they will cause an error when
|
updated. If there are conflicts you will be instructed to go into the
|
||||||
loading.
|
`$ZPREZTODIR` directory and resolve them yourself.
|
||||||
|
|
||||||
```sh
|
To pull the latest changes and update submodules manually:
|
||||||
zstyle ':prezto:load' pmodule-dirs $HOME/.zprezto-contrib
|
|
||||||
```
|
```console
|
||||||
|
cd $ZPREZTODIR
|
||||||
## Customization
|
git pull
|
||||||
|
git submodule sync --recursive
|
||||||
The project is managed via [Git][3]. We highly recommend that you fork this
|
git submodule update --init --recursive
|
||||||
project so that you can commit your changes and push them to your fork on
|
```
|
||||||
[GitHub][4] to preserve them. If you do not know how to use Git, follow this
|
|
||||||
[tutorial][5] and bookmark this [reference][6].
|
## Usage
|
||||||
|
|
||||||
## Resources
|
Prezto has many features disabled by default. Read the source code and the
|
||||||
|
accompanying README files to learn about what is available.
|
||||||
The [Zsh Reference Card][7] and the [zsh-lovers][8] man page are indispensable.
|
|
||||||
|
### Modules
|
||||||
## License
|
|
||||||
|
01. Browse [_`modules`_][9] to see what is available.
|
||||||
This project is licensed under the MIT License.
|
02. Load the modules you need in _`${ZDOTDIR:-$HOME}/.zpreztorc`_ and then open
|
||||||
|
a new Zsh terminal window or tab.
|
||||||
[1]: https://www.zsh.org
|
|
||||||
[2]: https://i.imgur.com/nrGV6pg.png "sorin theme"
|
### Themes
|
||||||
[3]: https://git-scm.com
|
|
||||||
[4]: https://github.com
|
01. For a list of themes, type `prompt -l`.
|
||||||
[5]: https://gitimmersion.com
|
02. To preview a theme, type `prompt -p name`.
|
||||||
[6]: https://git.github.io/git-reference/
|
03. Load the theme you like in _`${ZDOTDIR:-$HOME}/.zpreztorc`_ and then
|
||||||
[7]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf
|
open a new Zsh terminal window or tab.
|
||||||
[8]: https://grml.org/zsh/zsh-lovers.html
|
|
||||||
[9]: modules#readme
|
![sorin theme][2]
|
||||||
[10]: runcoms#readme
|
Note that the [_`git`_][11] module may be required for special symbols to
|
||||||
[11]: modules/git#readme
|
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.
|
||||||
|
|
||||||
|
### External Modules
|
||||||
|
|
||||||
|
01. By default modules will be loaded from [_`/modules`_][9] and _`/contrib`_.
|
||||||
|
02. 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.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
zstyle ':prezto:load' pmodule-dirs $HOME/.zprezto-contrib
|
||||||
|
```
|
||||||
|
|
||||||
|
## Customization
|
||||||
|
|
||||||
|
The project is managed via [Git][3]. We highly recommend that you fork this
|
||||||
|
project so that you can commit your changes and push them to your fork on
|
||||||
|
[GitHub][4] to preserve them. If you do not know how to use Git, follow this
|
||||||
|
[tutorial][5] and bookmark this [reference][6].
|
||||||
|
|
||||||
|
## Resources
|
||||||
|
|
||||||
|
The [Zsh Reference Card][7] and the [zsh-lovers][8] man page are indispensable.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is licensed under the MIT License.
|
||||||
|
|
||||||
|
[1]: https://www.zsh.org
|
||||||
|
[2]: https://i.imgur.com/nrGV6pg.png "sorin theme"
|
||||||
|
[3]: https://git-scm.com
|
||||||
|
[4]: https://github.com
|
||||||
|
[5]: https://gitimmersion.com
|
||||||
|
[6]: https://git.github.io/git-reference/
|
||||||
|
[7]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf
|
||||||
|
[8]: https://grml.org/zsh/zsh-lovers.html
|
||||||
|
[9]: modules#readme
|
||||||
|
[10]: runcoms#readme
|
||||||
|
[11]: modules/git#readme
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user