OpenCms Documentation

Installing Eclipse and Gradle

 Show GitHub edit links  Hide GitHub edit links
In OpenCms since: 9.0 Documented since: 9.5 Latest revision for: 9.5 Valid for OpenCms: 13.0

Eclipse with Gradle is the preferred environment for OpenCms development when it comes to writing Java code. Find out how to setup Eclipse and add Gradle.

Why is Eclipse with Gradle the preferred setup?

Eclipse and Gradle is used by the OpenCms core developers. And the gradle projects with the OpenCms source are available at GitHub. Moreover, all OpenCms releases are available at MVNrepository. So if you write code depending on the OpenCms source, it's the easiest and most convenient way to stay with Gradle. And Eclipse? Well, it provides a good environment for Java programming and Gradle is integrated easily via a plugin.

Getting Eclipse

You can download the latest Eclipse at For OpenCms development the "Eclipse IDE for Java Developers" is most suitable. If you have already installed another version of Eclipse, you may use it as well.

Adding the Gradle plugin

Once Eclipse is installed, you can start it and add the Gradle plugin. Therefore:

  • Select "Help" from the menu bar
  • Choose "Install new software"
  • Add a new site (repository) setting
  • Select "Extensins / Gradle Integration" -> "Gradle IDE" for installation
  • Press "Next" and continue the installation procedure
  • Restart Eclipse

That's it! You have setup your OpenCms development environment. Read here how to start developing dependent on your development scenario.