yadm/completion
Tin Lai ecdc985ab0
add manual entry for fish completions
2020-06-04 14:31:57 +10:00
..
README.md add manual entry for fish completions 2020-06-04 14:31:57 +10:00
yadm.bash_completion Merge pull request #136 from dseomn/bash-completion 2019-11-25 16:55:43 -06:00
yadm.fish_completion improve fish completion by adding more completion options 2020-06-03 18:02:04 +10:00
yadm.zsh_completion Support XDG base directory specification 2019-09-27 08:40:31 -05:00

README.md

Installation

Bash completions

Prerequisites

yadm completion only works if Git completions are also enabled.

Homebrew

If using homebrew to install yadm, completions should automatically be handled if you also install brew install bash-completion. This might require you to include the main completion script in your own bashrc file like this:

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

Manual installation

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

[ -f /full/path/to/yadm.bash_completion ] && source /full/path/to/yadm.bash_completion

Zsh completions

Homebrew

If using homebrew to install yadm, completions should handled automatically.

Manual installation

Copy the completion script yadm.zsh_completion locally, rename it to _yadm, and add the containing folder to $fpath in .zshrc:

fpath=(/path/to/folder/containing_yadm $fpath)
autoload -U compinit
compinit

Installation using zplug

Load _yadm as a plugin in your .zshrc:

fpath=("$ZPLUG_HOME/bin" $fpath)
zplug "TheLocehiliosan/yadm", rename-to:_yadm, use:"completion/yadm.zsh_completion", as:command, defer:2

Fish completions

Manual installation

Copy the completion script yadm.fish_completion locally, rename it to yadm.fish, and add it 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.