Global flags
Most of the ply
commands operate on some common principles, target, recursive, and dry-run.
--json
Json output formatting
--force
Force defaults for prompts
--doc
Open documentation website
--target
By default ply
operates on the current folder similar to tools like git
. However a custom --target
flag is available for most commands and enables the used to use ply ... --target
outside of the working folder.
--recursive
Recursive mode is enabled with --recursive
or -r
for most commands. This mode starts by building a list of subprojects on the current target, and iteratively working on each subproject. Example of this is the upgrade ply upgrade all -r
command which will upgrade the current and all subprojects found in the working directory.
--dry-run
Dry-run mode is enabled with the --dry-run
flag, and are meant commands which overwrites files. When dry-run in enabled no files is changed or overwritten. Example ply upgrade all --dry-run
is effectively the same as a status printout.
Git
plybuild is git aware on the working projects, and will warn the user if it operates on a dirty repository. It will however continue as normal.
Example
INFO[0000] upgrading everything for file webservice/pom.xml
WARN[0000] operating on a dirty git repo