diff options
| author | kalle (jag) <kalle.jillheden@gmail.com> | 2021-05-03 16:35:28 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-03 16:35:28 +0200 |
| commit | 70ab2928a5ecd2513d4f6a67beb10f79d64d5172 (patch) | |
| tree | 86460e8502621429db24b035b4d943f9399c448a /plugins/gh/README.md | |
| parent | 63a7422d8dd5eb93c849df0ab9e679e6f333818a (diff) | |
| download | zsh-70ab2928a5ecd2513d4f6a67beb10f79d64d5172.tar.gz zsh-70ab2928a5ecd2513d4f6a67beb10f79d64d5172.tar.bz2 zsh-70ab2928a5ecd2513d4f6a67beb10f79d64d5172.zip | |
feat(plugins): add `gh` plugin for GitHub CLI (#9557)
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. |