.\" Automatically generated by Pandoc
.\"
.TH "antidote\-bundle" "1" "" "" "Antidote Manual"
.SH NAME
\f[B]antidote bundle\f[R] \- download a bundle and print its source line
.SH SYNOPSIS
.PP
antidote bundle [<bundles>\&...]
.SH DESCRIPTION
\f[B]antidote\-bundle\f[R] assembles your Zsh plugins.
Bundles can be git repos, or local files or directories.
If a plugin is a repo, it will be cloned if necessary.
The zsh code necessary to load (source) the plugin is then printed.
.PP
\ \ antidote bundle gituser/gitrepo
.PD 0
.P
.PD
\ \ antidote bundle $ZSH_CUSTOM/plugins/myplugin
.PD 0
.P
.PD
\ \ antidote bundle ${ZDOTDIR:\-$HOME}/.zlibs/myfile.zsh
.PP
Bundles also support annotations.
Annotations allow you have finer grained control over your plugins.
Annotations are used in the form \[aq]keyword:value\[aq].
.TP
\f[CR]kind\f[R]
.IP \[bu] 2
\f[B]zsh\f[R]: A zsh plugin.
This is the default kind of bundle.
.IP \[bu] 2
\f[B]fpath\f[R]: Only add the plugin to your \f[I]$fpath\f[R].
.IP \[bu] 2
\f[B]path\f[R]: Add the plugin to your \f[I]$PATH\f[R].
.IP \[bu] 2
\f[B]clone\f[R]: Only clone a plugin, but don\[cq]t do anything else
with it.
.IP \[bu] 2
\f[B]defer\f[R]: Defers loading of a plugin using
\[aq]romkatv/zsh\-defer\[aq].
.IP \[bu] 2
\f[B]autoload\f[R]: Autoload all the files in the plugin directory as
zsh functions.
.TP
\f[CR]branch\f[R]
The branch annotation allows you to change the default branch of a
plugin\[cq]s repo from \f[B]main\f[R] to a branch of your choosing.
.TP
\f[CR]path\f[R]
The path annotation allows you to use a subdirectory or file within a
plugin\[cq]s structure instead of the root plugin (eg:
\[aq]path:plugins/subplugin\[aq]).
.TP
\f[CR]conditional\f[R]
The conditonal annotation allows you to wrap an \f[B]if\f[R] statement
around a plugin\[cq]s load script.
Supply the name of a zero argument zsh function to conditional to
perform the test (eg: \[aq]conditional:is\-macos\[aq]).
.TP
\f[CR]pre\f[R] / \f[CR]post\f[R]
The pre and post annotations allow you to call a function before or
after a plugin\[cq]s load script.
This is helpful when configuring plugins, since the configuration
functions will only run for active plugins.
Supply the name of a zero argument zsh function to pre or post.
.TP
\f[CR]autoload\f[R]
The autoload annotation allows you to autoload a zsh functions directory
in addition to however the plugin was loaded as specified by
\[aq]kind\[aq].
Supply a relative path to autoload (eg: \[aq]autoload:functions\[aq]).
.PP
Cloned repo directory names can be overridden with the following
\f[B]zstyle\f[R]:
.PP
\ \ zstyle \[aq]:antidote:bundle\[aq] use\-friendly\-names \[aq]yes\[aq]
.SH OPTIONS
.TP
\-h, \-\-help
Show the help documentation.
.TP
[\f[I]<bundles>\&...\f[R]]
Zsh plugin bundles
.SH EXAMPLES
Using the \f[B]kind:\f[R] annotation\&...
.PP
\ \ # a regular plugin (kind:zsh is implied, so it\[cq]s unnecessary)
.PD 0
.P
.PD
\ \ antidote bundle zsh\-users/zsh\-history\-substring\-search kind:zsh
.PP
\ \ # add prompt plugins to $fpath
.PD 0
.P
.PD
\ \ antidote bundle sindresorhus/pure kind:fpath
.PP
\ \ # add utility plugins to $PATH
.PD 0
.P
.PD
\ \ antidote bundle romkatv/zsh\-bench kind:path
.PP
\ \ # clone a repo for use in other ways
.PD 0
.P
.PD
\ \ antidote bundle mbadolato/iTerm2\-Color\-Schemes kind:clone
.PP
\ \ # autoload a functions directory
.PD 0
.P
.PD
\ \ antidote bundle sorin\-ionescu/prezto path:modules/utility/functions
kind:autoload
.PP
\ \ # defer a plugin to speed up load times
.PD 0
.P
.PD
\ \ antidote bundle olets/zsh\-abbr kind:defer
.PP
Using the \f[B]branch:\f[R] annotation\&...
.PP
\ \ # don\[cq]t use the main branch, use develop instead
.PD 0
.P
.PD
\ \ antidote bundle zsh\-users/zsh\-autosuggestions branch:develop
.PP
Using the \f[B]path:\f[R] annotation\&...
.PP
\ \ # load oh\-my\-zsh
.PD 0
.P
.PD
\ \ antidote bundle ohmyzsh/ohmyzsh path:lib
.PD 0
.P
.PD
\ \ antidote bundle ohmyzsh/ohmyzsh path:plugins/git
.PP
Using the \f[B]conditional:\f[R] annotation\&...
.PP
\ \ # define a conditional function prior to loading antidote
.PD 0
.P
.PD
\ \ function is_macos {
.PD 0
.P
.PD
\ \ \ \ [[ $OSTYPE == darwin* ]] || return 1
.PD 0
.P
.PD
\ \ }
.PD 0
.P
.PD
.PD 0
.P
.PD
\ \ # conditionally load a plugin using the function you made
.PD 0
.P
.PD
\ \ antidote bundle ohmyzsh/ohmyzsh path:plugins/macos
conditional:is_macos
.SH BUGS
See GitHub Issues: \c
.UR https://github.com/mattmc3/antidote/issues
.UE \c
.SH AUTHORS
.IP \[bu] 2
Copyright (c) 2021\-2024 Matt McElheny
.IP \[bu] 2
antidote contributors: \c
.UR https://github.com/mattmc3/antidote/graphs/contributors
.UE \c
.SH LICENSE
MIT