2012-09-03 20:08:39 +00:00
|
|
|
Prezto — Instantly Awesome Zsh
|
|
|
|
|
==============================
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2012-09-03 20:08:39 +00:00
|
|
|
Prezto is the configuration framework for [Zsh][1]; it enriches the command line
|
2012-05-22 00:18:30 +00:00
|
|
|
interface environment with sane defaults, aliases, functions, auto completion,
|
|
|
|
|
and prompt themes.
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2012-05-22 00:18:30 +00:00
|
|
|
Installation
|
|
|
|
|
------------
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2014-10-06 01:10:27 +00:00
|
|
|
Prezto will work with any recent release of Zsh, but the minimum required
|
2014-08-29 17:09:15 +00:00
|
|
|
version is 4.3.17.
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2012-09-03 20:08:39 +00:00
|
|
|
1. Launch Zsh:
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2017-04-03 20:29:58 +00:00
|
|
|
`zsh`
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2012-09-03 20:08:39 +00:00
|
|
|
2. Clone the repository:
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2017-04-03 20:29:58 +00:00
|
|
|
`git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto"`
|
2012-09-03 20:08:39 +00:00
|
|
|
|
|
|
|
|
3. Create a new Zsh configuration by copying the Zsh configuration files
|
|
|
|
|
provided:
|
|
|
|
|
|
2017-04-03 20:29:58 +00:00
|
|
|
```
|
2012-09-03 20:38:18 +00:00
|
|
|
setopt EXTENDED_GLOB
|
|
|
|
|
for rcfile in "${ZDOTDIR:-$HOME}"/.zprezto/runcoms/^README.md(.N); do
|
2012-09-04 13:12:52 +00:00
|
|
|
ln -s "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}"
|
2012-05-27 22:23:57 +00:00
|
|
|
done
|
2017-04-03 20:29:58 +00:00
|
|
|
```
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2017-04-13 10:27:59 +00:00
|
|
|
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.
|
2017-04-13 09:53:07 +00:00
|
|
|
|
2012-09-03 20:08:39 +00:00
|
|
|
4. Set Zsh as your default shell:
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2017-04-03 20:29:58 +00:00
|
|
|
`chsh -s /bin/zsh`
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2012-09-03 20:08:39 +00:00
|
|
|
5. Open a new Zsh terminal window or tab.
|
2011-12-30 03:55:45 +00:00
|
|
|
|
|
|
|
|
### Troubleshooting
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2012-09-03 20:08:39 +00:00
|
|
|
If you are not able to find certain commands after switching to *Prezto*,
|
2013-12-17 00:17:31 +00:00
|
|
|
modify the `PATH` variable in *~/.zprofile* then open a new Zsh terminal
|
2011-12-30 03:55:45 +00:00
|
|
|
window or tab.
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2013-09-26 18:06:54 +00:00
|
|
|
Updating
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
Pull the latest changes and update submodules.
|
|
|
|
|
|
|
|
|
|
git pull && git submodule update --init --recursive
|
|
|
|
|
|
2012-05-27 22:23:57 +00:00
|
|
|
Usage
|
|
|
|
|
-----
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2012-09-03 20:08:39 +00:00
|
|
|
Prezto has many features disabled by default. Read the source code and
|
2011-12-30 03:55:45 +00:00
|
|
|
accompanying README files to learn of what is available.
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2012-03-28 16:41:39 +00:00
|
|
|
### Modules
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2012-05-27 22:23:57 +00:00
|
|
|
1. Browse */modules* to see what is available.
|
2012-09-03 20:38:18 +00:00
|
|
|
2. Load the modules you need in *~/.zpreztorc* then open a new Zsh terminal
|
|
|
|
|
window or tab.
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2011-12-30 03:55:45 +00:00
|
|
|
### Themes
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2012-05-27 22:23:57 +00:00
|
|
|
1. For a list of themes, type `prompt -l`.
|
|
|
|
|
2. To preview a theme, type `prompt -p name`.
|
2012-09-03 20:38:18 +00:00
|
|
|
3. Load the theme you like in *~/.zpreztorc* then open a new Zsh terminal
|
|
|
|
|
window or tab.
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2012-05-27 22:23:57 +00:00
|
|
|
![sorin theme][2]
|
|
|
|
|
|
|
|
|
|
Customization
|
|
|
|
|
-------------
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2013-08-12 05:20:14 +00:00
|
|
|
The project is managed via [Git][3]. It is highly recommended that you fork this
|
|
|
|
|
project; so, that you can commit your changes and push them to [GitHub][4] to
|
|
|
|
|
not lose them. If you do not know how to use Git, follow this [tutorial][5] and
|
|
|
|
|
bookmark this [reference][6].
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2012-05-27 22:23:57 +00:00
|
|
|
Resources
|
|
|
|
|
---------
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2012-08-28 00:17:36 +00:00
|
|
|
The [Zsh Reference Card][7] and the [zsh-lovers][8] man page are indispensable.
|
2011-07-18 04:00:35 +00:00
|
|
|
|
2012-05-27 22:23:57 +00:00
|
|
|
License
|
|
|
|
|
-------
|
2011-12-28 22:04:43 +00:00
|
|
|
|
2017-04-05 16:34:31 +00:00
|
|
|
This project is licensed under the MIT License.
|
2011-12-28 22:04:43 +00:00
|
|
|
|
2012-05-22 00:18:30 +00:00
|
|
|
[1]: http://www.zsh.org
|
2015-05-19 21:39:00 +00:00
|
|
|
[2]: http://i.imgur.com/nrGV6pg.png "sorin theme"
|
2012-05-22 00:18:30 +00:00
|
|
|
[3]: http://git-scm.com
|
|
|
|
|
[4]: https://github.com
|
|
|
|
|
[5]: http://gitimmersion.com
|
|
|
|
|
[6]: http://gitref.org
|
2012-08-28 00:17:36 +00:00
|
|
|
[7]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf
|
|
|
|
|
[8]: http://grml.org/zsh/zsh-lovers.html
|
