Gradle Usage

4.1. Prerequisites

Gradle requires a Java JDK or JRE to be installed. Gradle requires a Java version 6 or higher. Gradle ships with

its own Groovy library, therefore no Groovy needs to be installed. Any existing Groovy installation is ignored

by Gradle.

Gradle uses whichever JDK it finds in your path (to check, use ). Alternatively, java -version you can set

the JAVA_HOME environment variable to point to the install directory of the desired JDK.

4.2. Download

You can download one of the Gradle distributions from the Gradle web site.

4.3. Unpacking

The Gradle distribution comes packaged as a ZIP. The full distribution contains:

The Gradle binaries.

The user guide (HTML and PDF).

The DSL reference guide.

The API documentation (Javadoc and Groovydoc).

Extensive samples, including the examples referenced in the user guide, along with some complete and more

complex builds you can use the starting point for your own build.

The binary sources. This is for reference only. If you want to build Gradle you need to download the source

distribution or checkout the sources from the source repository. See the Gradle web site for details.

4.4. Environment variables

For running Gradle, add GRADLE_HOME/bin to your PATH environment variable. Usually, this is sufficient

to run Gradle.

Page 28 of 423

4.5. Running and testing your installation

You run Gradle via the command. To check if Gradle is properly installed gradle just type gradle -v. The

output shows Gradle version and also local environment configuration (groovy and JVM version, etc.). The

displayed Gradle version should match the distribution you have downloaded.

4.6. JVM options

JVM options for running Gradle can be set via environment variables. You can use GRADLE_OPTS or

JAVA_OPTS. Those variables can be used together. JAVA_OPTS is by convention an environment variable

shared by many Java applications. A typical use case would be to set the HTTP proxy in JAVA_OPTS and the

memory options in GRADLE_OPTS. Those variables can also be set at the beginning of the gradle or gradlew

script.

Page 29 of 423

5

Troubleshooting

This chapter is currently a work in progress.

When using Gradle (or any software package), you can run into problems. You may not understand how to use a

particular feature, or you may encounter a defect. Or, you may have a general question about Gradle.

This chapter gives some advice for troubleshooting problems and explains how to get help with your problems.

5.1. Working through problems

If you are encountering problems, one of the first things to try is using the very latest release of Gradle. New

versions of Gradle are released

...