gradle [task name...]

Gradle is an open-source build automation tool that is designed to be flexible enough to build almost any type of software

Arguments

NameDescription
task name

Subcommands

NameDescription
buildCompute all outputs
runRun applications
checkRun all checks
cleanClear the contents of the build directory
projectsList of all sub-projects
tasksList of main tasks of the selected project
helpDisplay task usage information
dependenciesGives you a list of the dependencies of the selected project, broken down by configuration
buildEnvironmentVisualises the buildscript dependencies of the selected project
dependencyInsightGives you an insight into a particular dependency (or dependencies) that match specified input
propertiesGives you a list of the properties of the selected project
--status(Standalone command) List running and recently stopped Gradle daemons. Only displays daemons of the same Gradle version
--stop(Standalone command) Stop all Gradle Daemons of the same version
initCreate new Gradle builds, with new or existing projects
wrapperGenerates a script, gradlew, that invokes a declared version of Gradle, downloading it beforehand if necessary
testRun a test task

Options

NameDescription
-?, -h, --helpShows a help message with all available CLI options
-v, --versionPrints Gradle, Groovy, Ant, JVM, and operating system version information
-S, --full-stacktracePrint out the full (very verbose) stacktrace for any exceptions
-s, --stacktracePrint out the stacktrace also for user exceptions (e.g. compile error)
--scanCreate a build scan with fine-grained information about all aspects of your Gradle build
-Dorg.gradle.debugDebug Gradle client (non-Daemon) process. Gradle will wait for you to attach a debugger at localhost:5005 by default
-Dorg.gradle.daemon.debugDebug Gradle Daemon process
--build-cacheToggles the Gradle build cache. Gradle will try to reuse outputs from previous builds. Default is off
--no-build-cacheToggles the Gradle build cache. Gradle will try to reuse outputs from previous builds. Default is off
--configure-on-demandToggles Configure-on-demand. Only relevant projects are configured in this build run. Default is off
--no-configure-on-demandToggles Configure-on-demand. Only relevant projects are configured in this build run. Default is off
--max-workers <number>Sets maximum number of workers that Gradle may use. Default is number of processors
--parallelBuild projects in parallel. For limitations of this option, see Parallel Project Execution. Default is off
--no-parallelDisables --parallel
--priority <priority>Specifies the scheduling priority for the Gradle daemon and all processes launched by it
--profileGenerates a high-level performance report in the $buildDir/reports/profile directory. --scan is preferred
--scanGenerate a build scan with detailed performance diagnostics
--watch-fsToggles watching the file system. When enabled Gradle re-uses information it collects about the file system between builds. Enabled by default on operating systems where Gradle supports this feature
--no-watch-fsToggles watching the file system. When enabled Gradle re-uses information it collects about the file system between builds. Enabled by default on operating systems where Gradle supports this feature
--daemonUse the Gradle Daemon to run the build. Starts the daemon if not running or existing daemon busy. Default is on
--no-daemonDisables --daemon
--foregroundStarts the Gradle Daemon in a foreground process
-Dorg.gradle.daemon.idletimeout <milliseconds>Gradle Daemon will stop itself after this number of milliseconds of idle time
-Dorg.gradle.logging.level <level>Set logging level via Gradle properties
-q, --quietLog errors only
-w, --warnSet log level to warn
-i, --infoSet log level to info
-d, --debugLog in debug mode (includes normal stacktrace)
-Dorg.gradle.console <mode>Specify console mode via Gradle properties
--console <mode>Specifies which type of console output to generate
-Dorg.gradle.warning.mode <mode>Specify warning mode via Gradle properties
--warning-mode <mode>Specifies how to log warning
--include-buildRun the build as a composite, including the specified build
--offlineSpecifies that the build should operate without accessing network resources
--refresh-dependenciesRefresh the state of dependencies
--dry-runRun Gradle with all task actions disabled. Use this to show which task would have executed
--write-locksIndicates that all resolved configurations that are lockable should have their lock state persisted
--update-locks <group:name...>Indicates that versions for the specified modules have to be updated in the lock file
--no-rebuild
  • Dangerous 💥
-b, --build-file <file>Specifies the build file. For example: gradle --build-file=foo.gradle
-c, --settings-file <file>Specifies the settings file. For example: gradle --settings-file=somewhere/else/settings.gradle
-g, --gradle-user-home <directory>Specifies the Gradle user home directory. The default is the .gradle directory in the user’s home directory
-p, --project-dir <directory>Specifies the start directory for Gradle
--project-cache-dir <directory>Specifies the project-specific cache directory. Default value is .gradle in the root project directory
-D, --system-prop <system property>Sets a system property of the JVM, for example -Dmyprop=myvalue
-I, --init-scriptSpecifies an initialization script
-P, --project-prop <system property>Sets a project property of the root project, for example -Pmyprop=myvalue
-Dorg.gradle.jvmargs <arguments>Set JVM arguments
-Dorg.gradle.java.home <directory>Set JDK home dir