ansible-butler 1.0.1

A butler CLI for assistance in managing Ansible projects

ansible-butler

Butler CLI for Ansible projects

Functions

Object	Action	Description
directory	init	initialize an ansible directory
role	list	list roles
role	clean	clean role directory structure (remove empty yml files & dirs)
role	mk-readme	auto generate readme based on role meta and basic yml info

Usage

Usage:
  ansible-butler.py directory init [(-d=DIR|--directory=DIR)]
  ansible-butler.py role list [--roles-path=PATH] [<name>]
  ansible-butler.py role clean [--roles-path=PATH] [<name>]
  ansible-butler.py role mk-readme [--roles-path=PATH] [<name>]

Arguments:
  name    name of role (accepts glob patterns)

Options:
  -h --help                               Show this screen
  -d --directory=DIR   Location to initialize ansible directory structure [default: ./]
  --roles-path=PATH   Path to roles directory [default: ./roles]

Examples

• Initialize Ansible Directory
  • ansible-butler directory init ./sandbox
• Clean Roles
  • ansible-butler role clean my-role-1
  • ansible-butler role clean my-role-*
• Generate README
  • ansible-butler role mk-readme my-role-1
  • ansible-butler role mk-readme my-role-*

Troubleshooting

• ansible-butler: command not found
  • check the $PATH environment variable and ensure that ~/.local/bin is included

License

GNU General Public License

Author Information

Zach LeBlanc

Red Hat