mirror of https://github.com/TheLocehiliosan/yadm synced 2024-10-27 20:34:27 +00:00

History

Erik Flodin 57eed9742a Rework zsh completion fallback Don't rely on internals from the git completion. Instead set up the environment and then simply call _git and let it do the completion as it see fit. See #292.		2021-01-06 20:36:07 +01:00
..
bash	Reorganize shell completion code	2020-12-28 12:05:39 -06:00
fish	Reorganize shell completion code	2020-12-28 12:05:39 -06:00
zsh	Rework zsh completion fallback	2021-01-06 20:36:07 +01:00
README.md	Reorganize shell completion code	2020-12-28 12:05:39 -06:00

README.md

Installation

Prerequisites

Bash and Zsh completion only works if Git completions are also enabled.

Homebrew

If using homebrew to install yadm, Bash, Zsh, and Fish completions should automatically be installed. For Bash and Zsh, you also must install bash-completion or zsh-completions. This might require you to include the main completion script in your own shell configuration like this:

[ -f /usr/local/etc/bash_completion ] && source /usr/local/etc/bash_completion

Bash (manual installation)

Copy the completion script locally, and add this to you bashrc:

[ -f /path/to/yadm/completion/bash/yadm ] && source /path/to/yadm/completion/bash/yadm

Zsh (manual installation)

Add the completion/zsh folder to $fpath in .zshrc:

fpath=(/path/to/yadm/completion/zsh $fpath)
autoload -U compinit
compinit

Zsh (using zplug)

Load _yadm as a plugin in your .zshrc:

fpath=("$ZPLUG_HOME/bin" $fpath)
zplug "TheLocehiliosan/yadm", use:"completion/zsh/_yadm", as:command, defer:2

Fish (manual installation)

Copy the completion script yadm.fish to any folder within $fish_complete_path. For example, for local installation, you can copy it to $HOME/.config/fish/completions/ and it will be loaded when yadm is invoked.