diff options
| author | Tuowen Zhao <ztuowen@gmail.com> | 2021-05-07 20:55:25 -0600 |
|---|---|---|
| committer | Tuowen Zhao <ztuowen@gmail.com> | 2021-05-07 20:55:25 -0600 |
| commit | ffdc4bfe1204f911d71b136dbd95784176a44eb6 (patch) | |
| tree | 95acddefbb5e34f6a961b3aeb701732a399242af /plugins/gh/README.md | |
| parent | b21e3c4f28d0d55947285dcebf9f91b580384b09 (diff) | |
| parent | d646884add277d134235a9b18ab755388d6e0d8d (diff) | |
| download | zsh-ffdc4bfe1204f911d71b136dbd95784176a44eb6.tar.gz zsh-ffdc4bfe1204f911d71b136dbd95784176a44eb6.tar.bz2 zsh-ffdc4bfe1204f911d71b136dbd95784176a44eb6.zip | |
Merge remote-tracking branch 'origin/master'
Diffstat (limited to 'plugins/gh/README.md')
| -rw-r--r-- | plugins/gh/README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/plugins/gh/README.md b/plugins/gh/README.md new file mode 100644 index 000000000..54e046a1c --- /dev/null +++ b/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. |