summaryrefslogtreecommitdiff
path: root/plugins/kind/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/kind/README.md')
-rw-r--r--plugins/kind/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/plugins/kind/README.md b/plugins/kind/README.md
new file mode 100644
index 000000000..49024648d
--- /dev/null
+++ b/plugins/kind/README.md
@@ -0,0 +1,22 @@
+# Kind plugin
+
+This plugin adds completion for the [Kind](https://kind.sigs.k8s.io/) tool, as well
+as a few aliases for easier use.
+
+To use it, add `kind` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... kind)
+```
+
+## Aliases
+
+| Alias | Command |
+| ------- | ---------------------------- |
+| `kicc` | `kind create cluster` |
+| `kiccn` | `kind create cluster --name` |
+| `kigc` | `kind get clusters` |
+| `kidc` | `kind delete cluster` |
+| `kidcn` | `kind delete cluster --name` |
+| `kidca` | `kind delete clusters -A` |
+| `kigk` | `kind get kubeconfig` |