Gradle requires a Java JDK to be installed. Gradle requires a JDK 1.5 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
java -version). Alternatively, you can set the
JAVA_HOME environment variable to point to the install directory of the desired JDK.
You can download one of the Gradle distributions from the Gradle web site.
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.
For Un*x users
You need a GNU compatible tool to unzip Gradle, if you want the file permissions to be properly set. We mention this as some zip front ends for Mac OS X don't restore the file permissions properly.
For running Gradle, add
GRADLE_HOME/bin to your
PATH environment variable. Usually, this is sufficient to run Gradle.
Running and testing your installation
You run Gradle via the
gradle command. To check if Gradle is properly installed 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.
JVM options for running Gradle can be set via environment variables. You can use
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