summaryrefslogtreecommitdiff
path: root/plugins/kind/README.md
diff options
context:
space:
mode:
authorAdam Henley <71472057+ajh-sr@users.noreply.github.com>2023-10-10 07:28:09 +1300
committerGitHub <noreply@github.com>2023-10-09 20:28:09 +0200
commit38db3e16ef3266800e1a9516c0615ff04ec97cb6 (patch)
treea3af9e6ae88a92ef5956dbc85a7405ebd74ffccb /plugins/kind/README.md
parent24b2600558f999dd53f0d354ad61fc07cf7d6e2b (diff)
downloadzsh-38db3e16ef3266800e1a9516c0615ff04ec97cb6.tar.gz
zsh-38db3e16ef3266800e1a9516c0615ff04ec97cb6.tar.bz2
zsh-38db3e16ef3266800e1a9516c0615ff04ec97cb6.zip
feat(kind): add plugin for Kind k8s tool (#9827)
Co-authored-by: jxlwqq <jxlwqq@gmail.com> Co-authored-by: Francesco Ilario <fr.ilario@gmail.com> Co-authored-by: Marc Cornellà <hello@mcornella.com>
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` |