/antidote

https://getantidote.github.io - the cure to slow zsh plugin management

Primary LanguageShellMIT LicenseMIT

antidote

MIT License version

GetAntidote Logo

Get the cure

Antidote is a feature-complete Zsh implementation of the legacy Antibody plugin manager, which in turn was derived from Antigen. Antidote not only aims to provide continuity for those legacy plugin managers, but also to delight new users with high-performance, easy-to-use Zsh plugin management.

Documentation

The full documentation can be found at https://getantidote.github.io

Installation

The easiest way to get stated using antidote is to call the antidote load command from your .zshrc:

# clone antidote if necessary
if ! [[ -e ${ZDOTDIR:-~}/.antidote ]]; then
  git clone https://github.com/mattmc3/antidote.git ${ZDOTDIR:-~}/.antidote
fi

# source antidote and load plugins from `${ZDOTDIR:-~}/.zsh_plugins.txt`
source ${ZDOTDIR:-~}/.antidote/antidote.zsh
antidote load

More details available can be found at https://getantidote.github.io.

Benchmarks

You can see how antidote compares with other setups here.

Plugin authors

If you authored a Zsh plugin, the recommended snippet for antidote is:

antidote install gh_user/gh_repo

If your plugin is hosted somewhere other than GitHub, you can use this:

antidote install https://bitbucket.org/bb_user/bb_repo

Credits

A big thank you to Carlos for all his work on antibody over the years.