README.md
1# MicroK8s plugin
2
3This plugin provides completion and useful aliases for [MicroK8s](https://microk8s.io/).
4
5To use it, add `microk8s` to the plugins array in your zshrc file.
6
7```zsh
8plugins=(... microk8s)
9```
10
11## Aliases
12
13| Alias | Command | Description |
14|-------|------------------|----------------------------------------------------------------------------------------------------------|
15| mco | microk8s.config | Shows the Kubernetes config file. |
16| mct | microk8s.ctr | Interact with containerd CLI. |
17| mdi | microk8s.disable | Disables an addon. |
18| me | microk8s.enable | Enables an addon. |
19| mh | microk8s.helm | Interact with Helm CLI. |
20| mis | microk8s.istio | Interact with Istio CLI. |
21| mk | microk8s.kubectl | Interact with Kubernetes CLI. |
22| msp | microk8s.stop | Stops all Kubernetes services. |
23| mst | microk8s.start | Starts MicroK8s after it is being stopped. |
24| msts | microk8s.status | Provides an overview of the MicroK8s state (running / not running) as well as the set of enabled addons. |