ANTIDOTE-INSTALL(1)

📦
version 2.3.0 · 4 versions
, in ubuntu stonking

💖 ANTIDOTE-INSTALL(1) 💖

okay bestie, welcome to the antidote manual, part of the Antidote Manual set 🌸 this one's all about antidote-install, and honestly? she's a whole vibe.

✨ 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>] [--pin <sha>] [-b|--branch <branch>] <bundle> [<bundlefile>]

🦋 DESCRIPTION 🦋

so antidote-install clones a brand-new bundle for you and then adds it to your plugins file. that's it, that's the gig. iconic behaviour, no notes. 💅

the default bundle file is ${ZDOTDIR:-$HOME}/.zsh_plugins.txt. and guess what — you can override that with this zstyle right here:

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

🌈 OPTIONS 🌈

  • -h, --help — show the help documentation. she's helpful, periodt.
  • -k, --kind <kind> — the kind of bundle. valid values: autoload, fpath, path, clone, defer, zsh. pick your fighter ✨
  • -p, --path <path> — a relative subpath within the bundle where the plugin is located.
  • -b, --branch <branch> — the git branch to use.
  • -a, --autoload <path> — a relative subpath within the bundle where autoload function files are located.
  • -c, --conditional <func> — a conditional function used to check whether to load the bundle.
  • --pre <func> — a function to be called prior to loading the bundle.
  • --post <func> — a function to be called after loading the bundle.
  • --pin <sha> — pin the bundle to a specific commit SHA. heads up bestie: pinned bundles get skipped during antidote update. they're locked in, fr fr 🔒
  • <bundle> — bundle to be installed.
  • [<bundlefile>] — bundle file to write to if you're not using the default. defaults to ${ZDOTDIR:-$HOME}/.zsh_plugins.txt or whatever the zstyle setting says. your call 💜

⭐ EXAMPLES ⭐

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

look at her go. ate that 🍓

💀 BUGS 💀

found a bug? nooo 😭 take it to GitHub Issues: https://github.com/mattmc3/antidote/issues

👑 AUTHORS 👑

📜 LICENSE 📜

MIT

and that's the whole page, bestie 🫶 this was the antidote manual, dated 1970-01-01, filed under ANTIDOTE-INSTALL(1). go forth and install your bundles, you gorgeous main character 💖✨🎀🦋🌸💅

📦 where this page comes from