Man page - antidote-install(1)

Packages contains this manual

Package:  zsh-antidote
apt-get install zsh-antidote

Manuals in package:
• antidote-update(1)
• antidote-path(1)
• antidote-home(1)
• antidote-help(1)
• antidote-load(1)
• antidote-bundle(1)
• antidote-install(1)
• antidote(1)
• antidote-init(1)
• antidote-list(1)
• antidote-purge(1)
Documentations in package:
• zsh-antidote

Manual

antidote-install

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
EXAMPLES
BUGS
AUTHORS
LICENSE

---

NAME

antidote install - install a bundle

SYNOPSIS

antidote install [-h|--help] [-k|--kind <kind>] [-p|--path <path>]
[-a|--autoload <path>] [-c|--conditional <func>]
[--pre <func>] [--post <func>]
[-b|--branch <branch>] <bundle> [<bundlefile>]

DESCRIPTION

antidote-install clones a new bundle and adds it to your plugins file.

The default bundle file is ${ZDOTDIR:-$HOME}/.zsh_plugins.txt . This can be overridden with the following zstyle :

zstyle ':antidote:bundle' file /path/to/my/bundle_file.txt

OPTIONS

-h, --help

Show the help documentation.

-k, --kind

The kind of bundle. Valid values: autoload, fpath, path, clone, defer, zsh.

-p, --path

A relative subpath within the bundle where the plugin is located.

-b, --branch

The git branch to use.

-a, --autoload

A relative subpath within the bundle where autoload function files are located.

-c, --conditional

A conditional function used to check whether to load the bundle.

	--pre		A function to be called prior to loading the bundle.
	--post		A function to be called after loading the bundle.

<bundle>

Bundle to be installed.

[<bundlefile>]

Bundle file to write to if not using the default. Defaults to ${ZDOTDIR:-$HOME}/.zsh_plugins.txt or zstyle setting.

EXAMPLES

antidote install zsh-users/zsh-history-substring-search

BUGS

See GitHub Issues: <https://github.com/mattmc3/antidote/issues>

AUTHORS

	•		Copyright (c) 2021-2024 Matt McElheny
	•		antidote contributors: <https://github.com/mattmc3/antidote/graphs/contributors>

LICENSE

MIT

---