diff options
Diffstat (limited to 'oh-my-zsh/plugins/gh')
| -rw-r--r-- | oh-my-zsh/plugins/gh/README.md | 23 | ||||
| -rw-r--r-- | oh-my-zsh/plugins/gh/gh.plugin.zsh | 14 |
2 files changed, 37 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/gh/README.md b/oh-my-zsh/plugins/gh/README.md new file mode 100644 index 0000000..54e046a --- /dev/null +++ b/oh-my-zsh/plugins/gh/README.md @@ -0,0 +1,23 @@ +# GitHub CLI plugin + +This plugin adds completion for the [GitHub CLI](https://cli.github.com/). + +To use it, add `gh` to the plugins array in your zshrc file: + +```zsh +plugins=(... gh) +``` + +This plugin does not add any aliases. + +## Cache + +This plugin caches the completion script and is automatically updated when the +plugin is loaded, which is usually when you start up a new terminal emulator. + +The cache is stored at: + +- `$ZSH/plugins/gh/_gh` completions script + +- `$ZSH_CACHE_DIR/gh_version` version of GitHub CLI, used to invalidate + the cache. diff --git a/oh-my-zsh/plugins/gh/gh.plugin.zsh b/oh-my-zsh/plugins/gh/gh.plugin.zsh new file mode 100644 index 0000000..1d8d84c --- /dev/null +++ b/oh-my-zsh/plugins/gh/gh.plugin.zsh @@ -0,0 +1,14 @@ +# Autocompletion for the GitHub CLI (gh). +if (( ! $+commands[gh] )); then + return +fi + +# If the completion file doesn't exist yet, we need to autoload it and +# bind it to `gh`. Otherwise, compinit will have already done that. +if [[ ! -f "$ZSH_CACHE_DIR/completions/_gh" ]]; then + typeset -g -A _comps + autoload -Uz _gh + _comps[gh]=_gh +fi + +gh completion --shell zsh >| "$ZSH_CACHE_DIR/completions/_gh" &| |