LinuxCommandLibrary

antibody

Manage and load shell environment bundles

TLDR

Bundle all plugins for static loading

$ antibody bundle < [~/.zsh_plugins.txt] > [~/.zsh_plugins.sh]
copy

Update all bundles
$ antibody update
copy

List all installed plugins
$ antibody list
copy

SYNOPSIS

antibody command [options]

PARAMETERS

bundle repository[@version]
    Adds a plugin bundle to the current shell session.
repository specifies the location of the plugin, often in the format of 'github_user/repo_name'. The optional @version specifies the git tag/commit/branch to use.

source
    Sources all bundled plugins, usually used at the end of .zshrc. It fetches the plugins if they are not already cached locally.

update
    Updates all bundled plugins to the latest version, overwriting the existing cached versions.

list
    Lists all currently installed and cached plugins.

init
    Generates an initial antibody configuration file in the current directory.

completion [shell]
    Generates shell completion scripts for antibody itself. Specifying shell is optional; if not specified, it tries to detect the shell.

--version
    Displays the antibody version number.

DESCRIPTION

Antibody is a fast, flexible, and simple-to-use plugin manager for the Zsh shell.
Unlike some other plugin managers, Antibody leverages the power of Zsh itself for plugin management, allowing for concurrent loading of plugins and functions.

It primarily operates through a single command, `antibody`, which is used to fetch, load, and manage your plugins. The core concept is to describe your desired plugin configuration in a `.zshrc` (or equivalent) file using `antibody bundle` commands, and then invoke `antibody source` to load them. Antibody handles caching and efficient loading, resulting in faster shell startup times.

CAVEATS

Antibody relies on Git for fetching and managing plugins. Git must be installed and available in your system's PATH.

EXAMPLE USAGE

In your `.zshrc` file:

antibody bundle junegunn/fzf
antibody bundle zsh-users/zsh-syntax-highlighting
antibody source

This snippet specifies two plugins to be managed by Antibody: `fzf` and `zsh-syntax-highlighting`. The `antibody source` command then loads these plugins when the shell starts.

HISTORY

Antibody was developed to address the need for a fast and efficient Zsh plugin manager that leverages the capabilities of Zsh itself. It gained popularity as an alternative to slower plugin managers that relied heavily on external scripting languages. Its focus on concurrent plugin loading and caching contributed to its widespread adoption.

SEE ALSO

zsh(1)

Copied to clipboard