zsh plugin manager cross-reference

zsh-plugin-manager-plugin-installation-procedures.md

Instructions for installing zsh plugins, for a variety of plugin managers

• antibody: Add <owner>/<repo> to your plugins file. If you use static loading update the sh.

• Antigen: Add antigen bundle <owner>/<repo> to your .zshrc.

• Oh-My-Zsh:

  • Clone to OMZ's plugins' directory:

    git clone https://github.com/<owner>/<repo>.git ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/<repo>

  • Add to the OMZ plugins array in your .zshrc:

    plugins=( [plugins...] <repo>)

• prezto:

  • Clone the plugin repo to either ~/.zprezto/modules or to some other directory of your choosing. If you choose a directory other than ~/.zprezto/modules tell prezto to look for modules in that directory: add zstyle ':prezto:load' pmodule-dirs <dir path> to your .zpreztorc file (replace <dir path> with the path to your directory).

  • Load the plugin by adding it to the .zpreztorc file's pmodule list. The list will look something like

    zstyle ':prezto:load' pmodule \
      'plugin1' \
      'plugin2' \
      'plugin3' \

• zcomet: add zcomet load <owner>/<repo> to your .zshrc

• zed: add zed load <tld>.com/<owner>/<repo> to your .zshrc

• zgen

  ⚠️ as of this writing, not actively maintained

  add zgen load <owner>/<repo> to your .zshrc

• zgenom

  a maintained fork of zgen

  add zgenom load <owner>/<repo> to your .zshrc

• zim add

  zmodule <owner>/<repo>

  to your .zshrc (see homepage for other options) and then run

  zimfw install

• zinit (formerly zplugin):

  ⚠️ zinit is not generally recommended except for existing zinit/zplugin users. See https://www.reddit.com/r/zsh/comments/qinb6j/httpsgithubcomzdharma_has_suddenly_disappeared_i/ for some history. As of this writing the original owner's repo is deleted and the project can be found at https://github.com/zdharma-continuum/zinit

  simplest option is to add this to your .zshrc:

  zinit light <owner>/<repo>

  zinit has a wide range of options for optimizing performance. If you notice the plugin impacting the performance of new terminals, and if you don't need the plugin to be available the moment you're able to type at a prompt, a good place to start is

  zinit ice wait lucid
  zinit light <owner>/<repo>

  That will silently delay loading the plugin until after the shell has started up.

• znap:

  Run

  znap clone <url>

  and then add to .zshrc

  znap source <repo>

• zplug: add zplug "<owner>/<repo>" to your .zshrc (see homepage for other options).

Then restart zsh:

exec zsh