Commands - waffle-ops/waffle GitHub Wiki
Waffle comes packaged with some commands that provide 'global' interactions. Commands will behave consistently across all projects and use cases as commands cannot be overridden.
Note: For more information about any of the following commands, try running wfl help [command].
docs
The docs command opens a web browser to this wiki!
Usage: wfl docs
help
Provides help text for the provided command, task, or recipe.
Note: Tasks and Recipes can be overridden. Such Tasks and Recipes will not provide useful help text.
Usage: wfl help [command|task|recipe]
init
Provides a 'wizard' that walks you through generating a barebones .waffle.yml file.
Note: The init command is partially destructive. It will overwrite an existing .waffle.yml file, so make sure it is checked into version control!
Usage: wfl init
iterate
Provides a way to execute Waffle commands, tasks, or recipes over a collection of projects.
Note: The iterate command has niche use cases and is not intended for everyday use.
Usage: wfl iterate [command|task|recipe]
Examples:
# The below commands could be used individually or grouped together as a workflow.
# Generates a report of pending updates of all projects that have a .waffle.yml
# file under path/to/projects
wfl iterate update-status --dir=path/to/projects
# Creates a new feature branch for applying monthly updates for all projects
# that have a .waffle.yml file under path/to/projects.
wfl iterate update-prepare --dir=path/to/projects
# Applys pending updates on the current branch for all projects that have a
# .waffle.yml file under path/to/projects.
wfl iterate update-apply --dir=path/to/projects
list
Lists the commands, tasks, and recipes that are available for use.
Note: This is the default command that runs when you simply run wfl.
Usage: wfl list
self-update
Provides an easy way to update the installed version of Waffle.
Note: The self-update command is only available on when using the .phar.
Usage: wfl self-update
If you have some ideas for commands to add feel free to suggest something in the issue queue!