summaryrefslogtreecommitdiff
path: root/.config/zsh/oh-my-zsh/plugins/gh/README.md
diff options
context:
space:
mode:
authorPedro Pereira <pedro.hr.pereira@proton.me>2026-10-16 15:19:13 -0300
committerPedro Pereira <pedro.hr.pereira@proton.me>2026-10-16 15:19:13 -0300
commit1eb69e9a795cc19450178c07d8d382622bc7ad70 (patch)
treeb6bc60605044fe929986f31b3b6bf4fee9b56e14 /.config/zsh/oh-my-zsh/plugins/gh/README.md
first commit
Diffstat (limited to '.config/zsh/oh-my-zsh/plugins/gh/README.md')
-rw-r--r--.config/zsh/oh-my-zsh/plugins/gh/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/.config/zsh/oh-my-zsh/plugins/gh/README.md b/.config/zsh/oh-my-zsh/plugins/gh/README.md
new file mode 100644
index 0000000..54e046a
--- /dev/null
+++ b/.config/zsh/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.