mirrors/prezto
1
0
Fork 1
mirror of https://github.com/sorin-ionescu/prezto.git synced 2024-05-20 16:41:08 +02:00
Code Issues Packages Projects Releases Wiki Activity
The configuration framework for Zsh
1606 commits 34 branches 0 tags 6.1 MiB
Shell 100%
Go to file
Samantha McVey 75a60bc7bf [editor] Add bindkey-all function to show all bound keys (#1358) 
* [editor] Add bindkey-all function to show all bound keys

Function which allows you to see all the bound keys for all of
the different keymaps. It does accept arguments and passes them
through to bindkey -m "$keymap" so you could set a shortcut to
all keymaps as well if you wished.

Makes it much easier to see and grep what keys are bound to each of
the different keymaps.

When no arguments are given it will print keymap headers to stderr,
if given arguments it will not print anything extra to the screen.

* [editor] Update README to include information about bindkey-all funct.
2017-07-05 23:05:31 -07:00
.github Remove additional newlines in issue and pull request templates 2017-04-15 01:47:58 -07:00
modules [editor] Add bindkey-all function to show all bound keys (#1358) 2017-07-05 23:05:31 -07:00
runcoms [runcoms/zprofile+zshenv] Ensure TMPDIR is always set 2017-06-26 14:58:37 -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 [CONTRUBITING] Add section on using a secondary devel directory 2017-06-26 15:39:55 -07:00
init.zsh Updater: fix bug regarding source init in new updater logic 2017-07-05 11:44:26 -07:00
LICENSE Bump license years and tidy up readme (#1273) 2017-04-05 09:34:31 -07:00
README.md [zprezto-update] Add convenience function to update zprezto (#1344) 2017-06-29 23:26:53 -07:00

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.

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

Run zprezto-update to automatically check if there is an update to zprezto. If there are no file conflicts, zprezto its submodules will be automatically be 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

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.