summaryrefslogtreecommitdiff
path: root/plugins/multipass/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/multipass/README.md')
-rw-r--r--plugins/multipass/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/plugins/multipass/README.md b/plugins/multipass/README.md
new file mode 100644
index 000000000..f6b2d76f4
--- /dev/null
+++ b/plugins/multipass/README.md
@@ -0,0 +1,22 @@
+# multipass
+
+This plugin provides completion for [multipass](https://multipass.run), as well as aliases
+for multipass commands.
+
+To use it, add `multipass` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... multipass)
+```
+
+## Aliases
+
+| Alias | Command |
+| ------ | ------------------------------------------------------------------- |
+| `mp` | `multipass` |
+| `mpl` | `multipass list` |
+| `mpla` | `multipass launch` |
+| `mpln` | `multipass launch --network en0 --network name=bridge0,mode=manual` |
+| `mps` | `multipass shell` |
+| `mpsp` | `multipass stop` |
+| `mpst` | `multipass start` |