Prerequisites

Gradle requires a Java JDK and a JAVA_HOME environment variable pointing to the JDK. Gradle ships with its own Groovy library. Therefore no Groovy needs to be installed. Any existing Groovy installation is ignored by Gradle.

Unpacking

The Gradle distribution comes only as zip. Additional to the binaries it is shipped with:

• The userguide (HTML and PDF)
• The Javadoc HTML pages.
• The binary sources (If you want to build Gradle you need to download the source distribution or checkout the sources from the source repository)

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.

Environment variables

For running Gradle, the GRADLE_HOME environment variable needs to point to the root directory of your Gradle installation.

Testing your installation

To check if Gradle is properly installed just type

gradle -v

and you should get an output like:

    Modern compiler found.
    Gradle 0.2-080409092233+0200
    Gradle buildtime: Wednesday, April 9, 2008 9:22:33 AM CEST
    Groovy 1.5.5-SNAPSHOT
    JVM 1.5.0_13-121
    JVM Vendor: "Apple Computer, Inc."
    OS Name: Mac OS X

Getting Help

You might check the userguide at GRADLE_HOME/docs/userguide. Typing gradle -h prints the command line help. Typing gradle -t shows all the tasks of a gradle build.