CheatGradle JVM build tool
Light · Postcard
102 × 152 mm · PDF
Dark · Postcard
102 × 152 mm · PDF
Ink saver · Postcard
102 × 152 mm · PDF
Light · A4 landscape
297 × 210 mm · PDF
Dark · A4 landscape
297 × 210 mm · PDF
Ink saver · A4 landscape
297 × 210 mm · PDF
Light · A3 landscape
420 × 297 mm · PDF
Dark · A3 landscape
420 × 297 mm · PDF
Ink saver · A3 landscape
420 × 297 mm · PDF
Start here
./gradlew buildCompile, test, assemble
./gradlew testRun the tests
./gradlew runRun the application
./gradlew cleanDelete build output
./gradlew tasksList available tasks
./gradlew dependencies
Show dependency tree
./gradlew build --scan
Publish a Build Scan
./gradlew --stop
Stop the daemons
Concepts
Build settings.gradle(.kts)
Project build.gradle(.kts)
Task build, test, ...
Run tasks
./gradlew <task>
Run a task and its dependencies
./gradlew <task1> <task2>
Run several tasks in order
./gradlew buildAssemble and run all checks
./gradlew checkRun all verification tasks
./gradlew runAssemble and run the application
./gradlew cleanDelete the build directory contents
./gradlew clean build
Rebuild from scratch
./gradlew :<sub>:<task>
Run a task in one subproject
./gradlew <task> -x <name>
Skip a task, even if others need it
e.g. ./gradlew build -x test
./gradlew <task> -m
Dry run: show what would execute
./gradlew <task> --continue
Keep going after a failure
./gradlew <task> -t
Re-run when inputs change
./gradlew <task> --rerun-tasks
Ignore up-to-date checks
./gradlew <task> --rerun
Force only that task to re-run
Testing
./gradlew testRun all tests
./gradlew test --tests <Class>
Run one test class
./gradlew test --tests <Class>.<method>
Run one test method
./gradlew test --tests '<pkg>*'
Run a package recursively
Starts with a capital letter = simple class name; otherwise
fully qualified
./gradlew test --tests <a> --tests <b>
Combine several filters
./gradlew test --test-dry-run
Show which tests would be selected
./gradlew test -i
Show test output in the console
Options
-i / --infoLog at info level
-s / --stacktrace
Print stack traces for user errors
-S / --full-stacktrace
Print the full stack trace
--scanCreate a Build Scan
--offlineDo not use the network
-U / --refresh-dependencies
Refresh dependency state
--parallelBuild projects in parallel
Off by default
--build-cacheEnable the build cache
Off by default; --no-build-cache to disable
--max-workers <n>
Limit worker count
--console=plainPlain output (no rich console)
Modes: auto, plain, colored, rich, verbose
-p <dir>Use another project directory
-D<prop>=<value>
Set a JVM system property
-P<prop>=<value>
Set a project property
-I <script>
Add an init script
Daemon
./gradlew --status
List running daemons
./gradlew --stop
Stop all daemons
--no-daemonRun without the daemon
--foregroundStart the daemon in the foreground
Inspect
./gradlew tasksList main tasks
./gradlew tasks --all
Include tasks of all groups
./gradlew tasks --group <name>
List one task group
./gradlew help --task <name>
Show usage of one task
./gradlew projects
List subprojects as a tree
./gradlew dependencies
Dependency tree per configuration
./gradlew dependencies --configuration <name>
Tree for one configuration
e.g. runtimeClasspath
./gradlew dependencyInsight --dependency <name>
--configuration <cfg>
Explain why a dependency is there
./gradlew buildEnvironment
Show buildscript dependencies
./gradlew -q <task>
Quiet output
Setup and wrapper
gradle initCreate a new build interactively
gradle init --type <type>
Pick a project type
e.g. java-library
gradle wrapperGenerate gradlew and wrapper files
gradle wrapper --gradle-version <ver>
Pin or upgrade the wrapper version
gradle wrapper --distribution-type all
Use the all distribution (sources, docs)
gradle wrapper --gradle-distribution-url <url>
Download from your own mirror
./gradlew --version
Show the Gradle version in use
Recipes
./gradlew clean build --stacktrace --info./gradlew dependencyInsight \ --dependency guava \ --configuration runtimeClasspath./gradlew test --tests UserServiceTest -t -i./gradlew wrapper --gradle-version 9./gradlew --version
