Announcing the Gradle Summit 2017! Take $300 off when you register by May 1st! close

Installation

Prerequisites

Gradle runs on all major operating systems and requires only a Java JDK or JRE version 7 or higher to be installed. To check, run java -version:

$ java -version
java version "1.8.0_60"

Zero-installation with the Gradle Wrapper

If you’re working with an existing Gradle-based build that uses the Gradle Wrapper, you don’t need to install anything up front. Just run the gradlew shell script on Unix-based systems, or run the gradlew.bat script on Windows.

These wrapper scripts will locate and use the correct version of Gradle if it is already installed on your system, and will otherwise download and install the correct version of Gradle on your behalf. For example, on a system that does not yet have Gradle installed, gradlew tasks will produce the following output:

$ ./gradlew tasks
Downloading https://services.gradle.org/distributions/gradle-3.5-bin.zip
...

Install with a package manager

SDKMAN!

SDKMAN! is a tool for managing parallel versions of multiple Software Development Kits on most Unix-based systems.

$ sdk install gradle 3.5

Homebrew

Homebrew is “the missing package manager for macOS”.

$ brew install gradle

Scoop

Scoop is a command-line installer for Windows inspired by Homebrew.

$ scoop install gradle

Install manually

Step 1. Download the latest Gradle distribution

The current Gradle release is version 3.5, released on 10 Apr 2017. The distribution zip file comes in two flavors:

If in doubt, choose the binary-only version and browse docs and sources online.

Need to work with an older version? See the releases page.

Step 2. Unpack the distribution

Linux & MacOS users

Unzip the distribution zip file in the directory of your choosing, e.g.:

$ mkdir /opt/gradle
$ unzip -d /opt/gradle gradle-3.5-bin.zip
$ ls /opt/gradle/gradle-3.5
LICENSE  NOTICE  bin  getting-started.html  init.d  lib  media

Microsoft Windows users

Create a new directory C:\Gradle with File Explorer.

Open a second File Explorer window and go to the directory where the Gradle distribution was downloaded. Double-click the ZIP archive to expose the content. Drag the content folder gradle-3.5 to your newly created C:\Gradle folder.

Alternatively you can unpack the Gradle distribution ZIP into C:\Gradle using an archiver tool of your choice.

Step 3. Configure your system environment

Linux & MacOS users

Configure your PATH environment variable to include the bin directory of the unzipped distribution, e.g.:

 $ export PATH=$PATH:/opt/gradle/gradle-3.5/bin

Microsoft Windows users

In File Explorer right-click on the This PC (or Computer) icon, then click Properties -> Advanced System Settings -> Environmental Variables.

Under System Variables select Path, then click Edit. Add an entry for C:\Gradle\gradle-3.5\bin. Click OK to save.

Step 4. Verify your installation

Open a console (or a Windows command prompt) and run gradle -v to run gradle and display the version, e.g.:

$ gradle -v

------------------------------------------------------------
Gradle 3.5
------------------------------------------------------------

Next Steps

Read the docs

Browse our reference documentation, follow our getting started guides, and see other resources.

Visualize your Gradle builds

Build scans give you a beautiful, visual way to explore your build. See an example.

Build Scan timeline

Command-line completion

Officially supported Bash and Zsh tab completion scripts are available at git.io/gradle-completion.