summaryrefslogtreecommitdiff
path: root/plugins/kamal/README.md
diff options
context:
space:
mode:
authorIgor Aleksandrov <igor.alexandrov@gmail.com>2025-05-15 01:48:50 +0400
committerGitHub <noreply@github.com>2025-05-14 14:48:50 -0700
commitc95509ebfdbcc3c497f12697cfd2717bcb0a528b (patch)
tree7abc90b42fd916a49a3d3f4c6ac79ed7efa6d486 /plugins/kamal/README.md
parentc34c1da736f4f162206e1153e66850788f3e2e16 (diff)
downloadzsh-c95509ebfdbcc3c497f12697cfd2717bcb0a528b.tar.gz
zsh-c95509ebfdbcc3c497f12697cfd2717bcb0a528b.tar.bz2
zsh-c95509ebfdbcc3c497f12697cfd2717bcb0a528b.zip
feat(kamal): add autocomplete support and aliases for Kamal (https://kamal-deploy.org/) (#13080)
Diffstat (limited to 'plugins/kamal/README.md')
-rw-r--r--plugins/kamal/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/plugins/kamal/README.md b/plugins/kamal/README.md
new file mode 100644
index 000000000..af5716826
--- /dev/null
+++ b/plugins/kamal/README.md
@@ -0,0 +1,16 @@
+# Kamal
+
+This plugin provides completion for [Kamal](https://kamal-deploy.org/) as well as some
+aliases for frequent Kamal commands.
+
+To use it, add kamal to the plugins array of your zshrc file:
+
+```zsh
+plugins=(... kamal)
+```
+
+## Aliase
+
+| Alias | Command | Description |
+|-----------|----------------------------------|----------------------------------------------------------------------------------|
+| kad | `kamal deploy` | Deploy app to servers |