summaryrefslogtreecommitdiff
path: root/plugins/ansible/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/ansible/README.md')
-rw-r--r--plugins/ansible/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/plugins/ansible/README.md b/plugins/ansible/README.md
new file mode 100644
index 000000000..38bc13775
--- /dev/null
+++ b/plugins/ansible/README.md
@@ -0,0 +1,35 @@
+# ansible plugin
+
+## Introduction
+
+The `ansible plugin` adds several aliases for useful [ansible](https://docs.ansible.com/ansible/latest/index.html) commands and [aliases](#aliases).
+
+To use it, add `ansible` to the plugins array of your zshrc file:
+
+```
+plugins=(... ansible)
+```
+
+## Aliases
+
+| Command | Description |
+|:-------------------------------------------|:--------------------------------------------------------------------|
+| `ansible-version` / `aver` | Show the version on ansible installed in this host |
+| `ansible-role-init <role name>` / `arinit` | Creates the Ansible Role as per Ansible Galaxy standard |
+| `a` | command `ansible` |
+| `aconf` | command `ansible-config` |
+| `acon` | command `ansible-console` |
+| `aconn` | command `ansible-connection` |
+| `ainv` | command `ansible-inventory` |
+| `aplay` | command `ansible-playbook` |
+| `ainv` | command `ansible-inventory` |
+| `adoc` | command `ansible-doc` |
+| `agal` | command `ansible-galaxy` |
+| `apull` | command `ansible-pull` |
+| `aval` | command `ansible-vault` |
+
+## Maintainer
+
+### [Deepankumar](https://github.com/deepan10)
+
+[https://github.com/deepan10/oh-my-zsh/tree/features/ansible-plugin](https://github.com/deepan10/oh-my-zsh/tree/features/ansible-plugin)