antidote

antidote

<a title="GetAntidote" href="https://antidote.sh" align="right" <img align="right" height="80" alt="GetAntidote Logo" src="https://avatars.githubusercontent.com/u/101279220?s=80&v=4" </a

[Get the cure][antidote]

Meet [antidote][antidote], a feature-complete Zsh implementation of the legacy [Antibody][antibody] plugin manager, which in turn was derived from [Antigen][antigen]. It 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.

Usage

Basic usage should look really familiar to you if you have used antibody or antigen. Bundles (aka: Zsh plugins) are stored in a file typically called .zshplugins.txt.

# .zsh_plugins.txt
rupa/z              # some bash plugins work too
sindresorhus/pure   # enhance your prompt

# you can even use Oh My Zsh plugins
getantidote/use-omz
ohmyzsh/ohmyzsh path:lib
ohmyzsh/ohmyzsh path:plugins/extract

# add fish-like features
zsh-users/zsh-syntax-highlighting
zsh-users/zsh-autosuggestions

A typical `.zshrc` might then look like:

.zshrc

source /path-to-antidote/antidote.zsh antidote load ${ZDOTDIR:-$HOME}/.zshplugins.txt

The full documentation can be found at [https://antidote.sh][antidote].

## Help getting started

If you want to see a full-featured example Zsh configuration using antidote, you can
have a look at this [example zdotdir](https://github.com/getantidote/zdotdir) project.
Feel free to incorporate code or plugins from it into your own dotfiles, or you can fork
it to get started building your own Zsh config from scratch driven by antidote.

## Installation

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:-$HOME}/.antidote

Install with a package manager

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

• macOS homebrew: brew install antidote
• Arch AUR: yay -S zsh-antidote
• Nix Home-Manager : programs.zsh.antidote.enable = true;

Performance

antidote supports ultra-high performance plugin loads using a static plugin file. It also allows deferred loading for plugins that support it.