LinuxCommandLibrary

antigen

TLDR

Load oh-my-zsh framework

$ antigen use oh-my-zsh
copy
Install and load a plugin bundle
$ antigen bundle [git]
copy
Load a plugin from a GitHub repository
$ antigen bundle [zsh-users/zsh-autosuggestions]
copy
Load a theme from oh-my-zsh
$ antigen theme [robbyrussell]
copy
Apply all changes (required at end of .zshrc)
$ antigen apply
copy
Update all plugins
$ antigen update
copy
List loaded bundles
$ antigen list
copy
Clear the cache and reload configuration
$ antigen reset
copy

SYNOPSIS

antigen command [arguments]

DESCRIPTION

Antigen is a plugin manager for zsh, inspired by Vundle for vim and Pathogen. It simplifies managing shell plugins (called bundles) by handling installation, loading, and updates automatically.
Bundles can be loaded from oh-my-zsh, prezto, or any Git repository. The typical workflow involves sourcing antigen.zsh, declaring bundles with antigen bundle, optionally loading a theme, and calling antigen apply to activate everything.
Example .zshrc configuration:

$ source ~/antigen.zsh
antigen use oh-my-zsh
antigen bundle git
antigen bundle zsh-users/zsh-syntax-highlighting
antigen theme robbyrussell
antigen apply
copy
Antigen caches compiled configurations for faster shell startup. After modifying bundle declarations, use antigen reset to clear the cache and reload changes.

PARAMETERS

bundle spec

Install (if needed) and load a plugin; accepts GitHub shorthand (user/repo) or full URLs
bundles
Bulk load multiple plugins via heredoc syntax (one per line)
use framework
Load a pre-packaged framework like oh-my-zsh or prezto
theme name
Load and activate a zsh theme (call after antigen use)
apply
Commit the configuration; must be called at the end of bundle declarations
update [bundle-name]
Update specified bundle or all bundles if no name given
list [--long]
Display currently loaded bundles; --long shows detailed information
revert
Revert all plugins to their state before the last update
reset
Clear the generated cache to reload configuration changes
selfupdate
Update Antigen itself to the latest version
cleanup
Remove plugins that are no longer loaded in configuration
purge bundle
Remove a specific bundle from the system

CAVEATS

Requires zsh version 4.3.11 or higher. Themes from oh-my-zsh may depend on framework functions, so antigen use oh-my-zsh should be called before antigen theme. Updates downloaded via antigen update require opening a new shell to take effect.

HISTORY

Antigen was created by Shrikant Sharat Kandula around 2012 to bring Vundle-style plugin management to zsh. It became one of the first popular zsh plugin managers and helped popularize modular shell configuration. The project continues to be maintained by the zsh-users community on GitHub.

SEE ALSO

oh-my-zsh(1), zsh(1), zinit(1), zplug(1)

Copied to clipboard