A butler CLI for assistance in managing Ansible projects
Project description
ansible-butler
Butler CLI for Ansible projects
Functions
Object | Action | Description |
---|---|---|
directory | init | initialize an ansible directory |
directory | init | cleanup 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 directory init [<dir>]
ansible-butler directory clean [<dir>] [--skip-roles]
ansible-butler role list [--roles-path=PATH] [<name>]
ansible-butler role clean [--roles-path=PATH] [<name>]
ansible-butler role mk-readme [--roles-path=PATH] [<name>]
Arguments:
name name of role (accepts glob patterns)
dir path to directory [default: ./]
Options:
-h --help Show this screen
--roles-path=PATH Path to roles directory [default: ./roles]
--skip-roles Flag to skip cleaning roles
Examples
- Initialize Ansible Directory
ansible-butler directory init ./sandbox
- Clean an Ansible Directory
ansible-butler directory clean ./sandbox
ansible-butler directory clean ./sandbox --skip-roles
- 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
- check the $PATH environment variable and ensure that
License
GNU General Public License
Author Information
Zach LeBlanc
Red Hat
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ansible-butler-1.0.5.tar.gz
(19.3 kB
view hashes)
Built Distribution
Close
Hashes for ansible_butler-1.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 896e20d88138c3ddc687010c34720c112659ffc5ed9e90c187248f14f52ad2cb |
|
MD5 | d1b2de21dc4a9e9fb7523b1e86e67ea3 |
|
BLAKE2b-256 | 4b42158250f7b99299fc15b86193097a7201b47a363de7e96e0767f3177537d0 |