summaryrefslogtreecommitdiff
path: root/plugins/qodana/README.md
diff options
context:
space:
mode:
authorPeter Puškár <93598525+puskarpeter@users.noreply.github.com>2023-09-04 19:17:28 +0200
committerGitHub <noreply@github.com>2023-09-04 19:17:28 +0200
commitf694d5ecc9aa45f4c394d2e15bf2bfde96eeeda6 (patch)
treefe3f16c8c0d754e698bdf5a3b9a799acafec8577 /plugins/qodana/README.md
parent2b1303a728afc285cc13a6710de128a050500f1e (diff)
downloadzsh-f694d5ecc9aa45f4c394d2e15bf2bfde96eeeda6.tar.gz
zsh-f694d5ecc9aa45f4c394d2e15bf2bfde96eeeda6.tar.bz2
zsh-f694d5ecc9aa45f4c394d2e15bf2bfde96eeeda6.zip
feat(qodana): add completion plugin (#11813)
Diffstat (limited to 'plugins/qodana/README.md')
-rw-r--r--plugins/qodana/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/qodana/README.md b/plugins/qodana/README.md
new file mode 100644
index 000000000..0b68bdecf
--- /dev/null
+++ b/plugins/qodana/README.md
@@ -0,0 +1,20 @@
+# JetBrains Qodana CLI plugin
+
+This plugin adds completion for the [JetBrains Qodana CLI](https://github.com/JetBrains/qodana-cli).
+
+To use it, add `qodana` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... qodana)
+```
+
+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_CACHE_DIR/completions/_qodana` completions script