README.md

   1 # zpe
   2 A utility to ease the management of Zsh plugins. This is NOT a complete Zsh plugin manager, I recommend [znap](https://github.com/marlonrichert/zsh-snap/) if you are looking for one. This script just takes the edge off of manually managing them, if you don't want to deal with one of the full-fledged plugin managers.
   3
   4 ## Usage
   5 ### Basic usage
   6   1. Source the script in your `zshrc`
   7   2. Add a list of the plugin repositories in `~/.config/zpe/repositories`. Use the full URL, either SSH or HTTP, comments can be added with a #.
   8   3. Run `zpe-clone` to pull the repositories
   9   4. Source the plugin in your zshrc using the `zpe-source` command. For each plugin, locate the source-able file (usually contains the word init, or has the .plugin.zsh extension). Add it to your zshrc using the following syntax: `zpe-source <plugin name>/<source-able file name>`. Make sure that this goes after sourcing the `zpe.zsh` script.
  10
  11 ### Extra commands
  12   * `zpe-pull` updates the repositories
  13   * `zpe-clean` removes any cloned repositories that are no longer in the `repositories` file
  14   * `zpe` opens the `repositories` file in $EDITOR
  15
  16 ## Motivation
  17 All of the other available plugin managers try to get way too fancy. I just need something to automatically clone git repositories, and make my config nice and portable. The script is intentionally highly extensible and feature-minimal.
  18
  19 ## License
  20 Copyright Armaan Bhojwani 2020, MIT License, see the LICENSE file for more information