Awesome
<p align="center"> <img src="/logo.png" alt="butler" style="max-width:100%;"> </p>Butler is an automatation tool to scaffold new projects in only a few seconds.
We provide a powerful interactive cli. When you create a project template you
can create a Survey. Surveys are used to collect
informations from the users to generate individual templates. Beside
templating we also plan to integrate common commands for popular Project Management
Tools like Jira, Confluence in Butler.
Bootstraping projects should be fun!
Features
- ✔︎ Template Surveys
- ✔︎ Conditional files and folders
- ✔︎ After hooks for post-processing
- :sparkles: Maintanance: Auto Update, Distributed configs
- :star2: Confluence: Create spaces with preconfigured page tree
Principles
- Project Templates are simple git repositories
- Everything is a template you don't have to deal with
/templatedirectories or.tmplfiles - Required informations are asked during the bootstrapping process
Usage
- Download here
- Install in
PATH - Run
butler
Documentation
Commands
- Create Project: This command will create a new project based on the selected template.
- Create Git Hooks: This command will install all selected hooks.
- Create Confluence Space: This command will create a public or private confluence space based on the selected template.
- Maintanance:
- Dump config: Prints the final butler config in the terminal.
- Auto Update: This command will update Butler to the latest version.
- Report a bug: This command will open a new Github issue.
- Version: This command will return the current version of Butler.
Maintenance across teams
- Butler is able to update itself. The latest Github release is used.
- Stay up-to-date with new templates without to update your config manually just set the environment variable
BUTLER_CONFIG_URLto butler.yml on master and both configs are merged.
What Butler template looks like ?
Lead Maintainers
Acknowledgements
This project is kindly sponsored by netzkern. We're hiring!
License
Licensed under MIT.