antidote

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

Install with git

You can install the latest release of antidote by cloning it with git:

# first, run this from an interactive zsh terminal session:
git clone --depth=1 https://github.com/mattmc3/antidote.git ${ZDOTDIR:-~}/.antidote

Install with a plugin manager

antidote may also be available in your system's plugin manager:

• macOS homebrew: brew install antidote
• Arch AUR: yay -S antidote

.zshrc

After installation, the simplest way to use antidote is to call the antidote load command from your .zshrc:

# now, simply add these two lines in your ~/.zshrc

# source antidote
source ${ZDOTDIR:-~}/.antidote/antidote.zsh

# initialize plugins statically with ${ZDOTDIR:-~}/.zsh_plugins.txt
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.