Nuxeo Core Developer Guide

Eclipse Setup

Updated: November 7, 2021

Install Eclipse

Download and install Eclipse from Eclipse website.

Import Nuxeo Source Code in Eclipse

Before importing Nuxeo source code in Eclipse, you need to generate Eclipse project files in terminal. Compared to doing it in Eclipse, using the command-line makes the process much faster. Please launch the following command at the root of the Git repository.

Generate Eclipse's project files with maven-eclipse-plugin

mvn eclipse:clean eclipse:eclipse \
    -Paddons,distrib -fae -nsu -T 1C \
  [ -DdownloadSources=true ] \
  [ -DdownloadJavadocs=true ] \
  [ -Declipse.useProjectReferences=true ] \
  [ -Declipse.workspace=/path/to/eclipse/workspace ]

You should then run the following script to make Eclipse use different build directories than Maven:

Linux and OS X



python scripts/

Now, you can import Nuxeo modules into Eclipse:

File -> Import -> General -> Existing Projects into Workspace

Configure Eclipse

See Java Code Style to configure Eclipse with the Nuxeo conventions on the formatting, code style and other coding preferences.

We'd love to hear your thoughts!

All fields required