× Home Tutorials Training Consulting Products Books Company Donate Contact us









NOW Hiring

Quick links

Share

This article describes how to use the Gradle tooling in Eclipse.

1. Eclipse Gradle support

Gradle Inc., the company behind the Gradle build framework provides Gradle tooling for the Eclipse IDE. This tooling allows to create and import Gradle enabled projects into the Eclipse IDE. It also allows to run Gradle tasks and monitor it execution.

The Eclipse project itself is called Buildship. It is available on Buildship on Github.

2. Install Eclipse Gradle (Buildship) tooling

2.1. Installation via the Marketplace

The easiest way to install the Eclipse Gradle tooling is by using the Marketplace client. Search for Buildship.

Eclipse Gradle installation via the Marketplace

2.2. Installation via the Eclipse update manager

You also can use the Help ▸ Install New Software menu path to install the Gradle tooling.

For example, the following URL can be used for the Eclipse 4.6 (Neon) release: http://download.eclipse.org/releases/neon

Eclipse Gradle installation via the update manager

The Eclipse Gradle project provides also other updates sites, e.g., for developer builds. See the Buildship download page for details: https://projects.eclipse.org/projects/tools.buildship/downloads

3. Create a new Gradle project

The Eclipse Gradle tooling provides a wizard for the creation of Java based Gradle projects. You can reach it via the File ▸ New ▸ Other…​ menu entry.

New Gradle project wizard

Click on the Next > button.

New Gradle project configuration page

Press the Finish button to create the project. This triggers the gradle init --type java-library command and imports the project. Press the Next > button to get a preview of the configuration before the projects created.

New Gradle project preview page

The created project looks similar to the following screenshot.

New Gradle project wizard result

4. Import an existing Gradle project

You can also import existing Gradle projects into Eclipse. Select the File ▸ Import…​ ▸ Gradle ▸ Gradle Project menu entry for this.

Gradle import wizard

After pressing the Next > button, you need to specify the root directory of your Gradle project.

Import Gradle project

You may now press Finish button and use the default settings for the import or press the Next button and specify the Gradle runtime settings.

Import Gradle project

Afterwards the import preview is shown.

Import Gradle project review

5. Updating the Gradle build path and project conversion

5.1. Updating Eclipse with the latest changes in the Gradle build file

Eclipse does not automatically update the classpath, if the build.gradle file is updated. Select Gradle ▸ Refresh Gradle Project from the context menu of the project or from your build.gradle file for that.

Refresh Gradle buildpath in Eclipse

5.2. Add Gradle support to existing Eclipse project

To convert a Java project to use Gradle, select Gradle ▸ Add Gradle Nature from the context menu of the project.

addgradlenature10

Run the 'gradle init' task to create the initial Gradle files, in case you do not have them yet.

6. Using the Gradle Tasks view

After successfully importing a Gradle project, the project is shown in the Gradle Tasks view.

The Gradle task view

By right clicking on a certain Gradle task in the Gradle Tasks view, you can run the selected Gradle task.

Run Gradle task

By default the result is displayed in the Gradle Executions view. It is also displayed in the Console view similar to the output you would get if you run the task via the command line.

The Gradle Executions view can only be used, if you use Gradle 2.4 or higher.

7. Android support

Currently the Buildship tooling does not support setting up the classpath for Android project. But you can already import Android projects into Eclipse and run the Gradle tasks via the Gradle Task view.

8. Contribute to the buildship project

After you installed the Buildship tooling, you can help the project by reporting issues in the Gradle Forum or by contributing code.

8.1. Reporting bugs and feature requests

To help the Buildship project, please report all issues with the tooling via: New Bug report for Buildship You can report bugs or feature requests.

8.2. Get the sourcecode

Since the project is hosted on Github, you can obtain the source by cloning it from the following URL:

git@github.com:eclipse/buildship.git

The project also provides a Oomph setup for the development, which is explained further in the Buildship Docs.

9. About this website

10. Eclipse Gradle (Buildship) resources

10.1. vogella GmbH training and consulting support

TRAINING SERVICE & SUPPORT

The vogella company provides comprehensive training and education services from experts in the areas of Eclipse RCP, Android, Git, Java, Gradle and Spring. We offer both public and inhouse training. Whichever course you decide to take, you are guaranteed to experience what many before you refer to as “The best IT class I have ever attended”.

The vogella company offers expert consulting services, development support and coaching. Our customers range from Fortune 100 corporations to individual developers.

Copyright © 2012-2016 vogella GmbH. Free use of the software examples is granted under the terms of the EPL License. This tutorial is published under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Germany license.

See Licence.