diff --git a/plugins/molecule/README.md b/plugins/molecule/README.md index 27b21f941..7489cfb7f 100644 --- a/plugins/molecule/README.md +++ b/plugins/molecule/README.md @@ -1,9 +1,20 @@ # Molecule plugin -This plugin adds completion for [Molecule](https://ansible.readthedocs.io/projects/molecule/), the project designed to aid in the development and testing of Ansible roles.. +This plugin adds aliases and completion for [Molecule](https://ansible.readthedocs.io/projects/molecule/), the +project designed to aid in the development and testing of Ansible roles.. To use it, add `molecule` to the plugins array in your zshrc file: ```zsh plugins=(... molecule) ``` + +## Aliases + +| Command | Description | +| :------ | :----------------------- | +| alias | mol='molecule ' | +| alias | mct='molecule create ' | +| alias | mcv='molecule converge ' | +| alias | mls='molecule list ' | +| alias | mvf='molecule verify ' | diff --git a/plugins/molecule/molecule.plugin.zsh b/plugins/molecule/molecule.plugin.zsh index 65ba85e64..1b312aa2e 100644 --- a/plugins/molecule/molecule.plugin.zsh +++ b/plugins/molecule/molecule.plugin.zsh @@ -12,3 +12,11 @@ if [[ ! -f "$ZSH_CACHE_DIR/completions/_molecule" ]]; then fi _MOLECULE_COMPLETE=zsh_source molecule >| "$ZSH_CACHE_DIR/completions/_molecule" &| + +# Alias +# molecule: https://docs.ansible.com/projects/molecule/ +alias mol='molecule ' +alias mct='molecule create ' +alias mcv='molecule converge ' +alias mls='molecule list ' +alias mvf='molecule verify '