265 lines
6.2 KiB
Groff
265 lines
6.2 KiB
Groff
.\" Automatically generated by Pandoc
|
|
.\"
|
|
.TH "antidote" "1" "" "" "Antidote Manual"
|
|
.SH NAME
|
|
\f[B]antidote\f[R] \- the cure to slow zsh plugin management
|
|
.SH SYNOPSIS
|
|
.PP
|
|
antidote [\-v | \[en]version] [\-h | \[en]help] <command> [<args> \&...]
|
|
.SH DESCRIPTION
|
|
\f[B]antidote\f[R] is a Zsh plugin manager made from the ground up
|
|
thinking about performance.
|
|
.PP
|
|
It is fast because it can do things concurrently, and generates an
|
|
ultra\-fast static plugin file that you can easily load from your Zsh
|
|
config.
|
|
.PP
|
|
It is written natively in Zsh, is well tested, and picks up where
|
|
Antigen and Antibody left off.
|
|
.SH OPTIONS
|
|
.TP
|
|
\-h, \-\-help
|
|
Show context\-sensitive help for antidote.
|
|
.TP
|
|
\-v, \-\-version
|
|
Show currently installed antidote version.
|
|
.SH COMMANDS
|
|
.TP
|
|
\f[CR]help\f[R]
|
|
Show documentation
|
|
.TP
|
|
\f[CR]load\f[R]
|
|
Statically source all bundles from the plugins file
|
|
.TP
|
|
\f[CR]bundle\f[R]
|
|
Clone bundle(s) and generate the static load script
|
|
.TP
|
|
\f[CR]install\f[R]
|
|
Clone a new bundle and add it to your plugins file
|
|
.TP
|
|
\f[CR]update\f[R]
|
|
Update antidote and its cloned bundles
|
|
.TP
|
|
\f[CR]purge\f[R]
|
|
Remove a cloned bundle
|
|
.TP
|
|
\f[CR]home\f[R]
|
|
Print where antidote is cloning bundles
|
|
.TP
|
|
\f[CR]list\f[R]
|
|
List cloned bundles
|
|
.TP
|
|
\f[CR]path\f[R]
|
|
Print the path of a cloned bundle
|
|
.TP
|
|
\f[CR]init\f[R]
|
|
Initialize the shell for dynamic bundles
|
|
.SH EXAMPLES
|
|
.SS A Simple Config
|
|
Create a \f[I].zsh_plugins.txt\f[R] file with a list of the plugins you
|
|
want:
|
|
.PP
|
|
\ \ \ # ${ZDOTDIR:\-$HOME}/.zsh_plugins.txt
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ zsh\-users/zsh\-syntax\-highlighting
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ zsh\-users/zsh\-history\-substring\-search
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ zsh\-users/zsh\-autosuggestions
|
|
.PP
|
|
Now, simply load your newly created static plugins file in your
|
|
\f[I].zshrc\f[R].
|
|
.PP
|
|
\ \ \ # ${ZDOTDIR:\-$HOME}/.zshrc
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ source /path/to/antidote/antidote.zsh
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ antidote load
|
|
.SS A More Advanced Config
|
|
Your \f[I].zsh_plugins.txt\f[R] file supports annotations.
|
|
Annotations tell antidote how to do things like load plugins from
|
|
alternate paths.
|
|
This lets you use plugins from popular frameworks like Oh\-My\-Zsh:
|
|
.PP
|
|
\ \ \ # ${ZDOTDIR:\-$HOME}/.zsh_plugins.txt
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ ohmyzsh/ohmyzsh path:lib
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ ohmyzsh/ohmyzsh path:plugins/git
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ ohmyzsh/ohmyzsh path:plugins/magic\-enter
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ etc\&...
|
|
.SS Dynamic Bundling
|
|
Users familiar with legacy plugin managers like Antigen might prefer to
|
|
use dynamic bundling.
|
|
With dynamic bundling you sacrifice some performance to avoid having
|
|
separate plugin files.
|
|
To use dynamic bundling, we need to change how \f[B]antidote bundle\f[R]
|
|
handles your plugins.
|
|
We do this by sourcing the output from \f[B]antidote init\f[R].
|
|
.PP
|
|
An example config might look like this:
|
|
.PP
|
|
\ \ \ source /path/to/antidote/antidote.zsh
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ source <(antidote init)
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ antidote bundle zsh\-users/zsh\-autosuggestions
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ antidote bundle ohmyzsh/ohmyzsh path:lib
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ antidote bundle ohmyzsh/ohmyzsh path:plugins/git
|
|
.PP
|
|
Instead of calling \f[B]antidote bundle\f[R] over and over, you might
|
|
prefer to load bundles with a HEREDOC.
|
|
.PP
|
|
\ \ \ source /path/to/antidote/antidote.zsh
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ source <(antidote init)
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ antidote bundle <<EOBUNDLES
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ \ \ \ \ zsh\-users/zsh\-syntax\-highlighting # regular plugins
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ \ \ \ \ ohmyzsh/ohmyzsh path:lib # directories
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ \ \ \ \ ohmyzsh/ohmyzsh path:plugins/magic\-enter # frameworks
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ \ \ \ \ https://github.com/zsh\-users/zsh\-history\-substring\-search
|
|
# URLs
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ \ EOBUNDLES
|
|
.SS Installation
|
|
To install antidote you can clone it with git:
|
|
.PP
|
|
\ \ git clone \[en]depth=1 https://github.com/mattmc3/antidote.git
|
|
${ZDOTDIR:\-$HOME}/.antidote
|
|
.PP
|
|
Then, simply add the following snippet to your .zshrc:
|
|
.PP
|
|
\ \ source ${ZDOTDIR:\-$HOME}/.antidote/antidote.zsh
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ antidote load
|
|
.SH CUSTOMIZATION
|
|
The location where antidote clones repositories can bu customized by
|
|
setting \f[B]$ANTIDOTE_HOME\f[R]:
|
|
.PP
|
|
\ \ ANTIDOTE_HOME=/path/to/my/repos
|
|
.PP
|
|
The bundle directory in ANTIDOTE_HOME can be changed to use friendly
|
|
names with the following \f[B]zstyle\f[R]:
|
|
.PP
|
|
\ \ zstyle \[aq]:antidote:bundle\[aq] use\-friendly\-names on
|
|
.PP
|
|
The default bundle file is
|
|
\f[B]${ZDOTDIR:\-$HOME}/.zsh_plugins.txt\f[R].
|
|
This can be overridden with the following \f[B]zstyle\f[R]:
|
|
.PP
|
|
\ \ zstyle \[aq]:antidote:bundle\[aq] file /path/to/my/bundle_file.txt
|
|
.PP
|
|
The default static file is
|
|
\f[B]${ZDOTDIR:\-$HOME}/.zsh_plugins.zsh\f[R].
|
|
This can be overridden with the following \f[B]zstyle\f[R]:
|
|
.PP
|
|
\ \ zstyle \[aq]:antidote:static\[aq] file /path/to/my/static_file.zsh
|
|
.PP
|
|
The default options used by romkatv/zsh\-defer can be changed with the
|
|
following \f[B]zstyle\f[R]:
|
|
.PP
|
|
\ \ zstyle \[cq]:antidote:bundle:*\[cq] defer\-options `\-a'
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ zstyle `:antidote:bundle:foo/bar' defer\-options `\-p'
|
|
.PP
|
|
Bundles can be Zsh compiled with the following \f[B]zstyle\f[R]:
|
|
.PP
|
|
\ \ zstyle \[cq]:antidote:bundle:*\[cq] zcompile `yes'
|
|
.PP
|
|
Or, if you only want to zcompile specific bundles, you can set those
|
|
individually:
|
|
.PP
|
|
\ \ zstyle \[cq]:antidote:bundle:*\[cq] zcompile `yes'
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\ \ zstyle `:antidote:bundle:zsh\-users/zsh\-syntax\-highlighting'
|
|
zcompile `no'
|
|
.PP
|
|
The static file can be Zsh compiled with the following \f[B]zstyle\f[R]:
|
|
.PP
|
|
\ \ zstyle `:antidote:static' zcompile `yes'
|
|
.PP
|
|
Or, to Zsh compile everything, static file and all bundles:
|
|
.PP
|
|
\ \ zstyle \[cq]:antidote:*\[cq] zcompile `yes'
|
|
.PP
|
|
By default, antidote appends to the end of your $fpath.
|
|
This is highly recommended, however if you really want to change that
|
|
behavior, there\[cq]s a zstyle for that:
|
|
.PP
|
|
\ \ zstyle `:antidote:fpath' rule `prepend'
|
|
.PP
|
|
By default, antidote uses romkatv/zsh\-defer for deferred plugins.
|
|
If there\[cq]s a fork you\[cq]d prefer to use, you can specify that with
|
|
this zstyle:
|
|
.PP
|
|
\ \ zstyle `:antidote:defer' bundle `getantidote/zsh\-defer'
|
|
.SH SEE ALSO
|
|
For more information, visit https://antidote.sh
|
|
.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
|