Install and set up GitLab for Eclipse

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
  • Status: Beta
This page contains information related to upcoming products, features, and functionality. It is important to note that the information presented is for informational purposes only. Please do not rely on this information for purchasing or planning purposes. The development, release, and timing of any products, features, or functionality may be subject to change or delay and remain at the sole discretion of GitLab Inc.

Install the GitLab for Eclipse plugin

Prerequisites:

  • Eclipse 4.33 and later.
  • GitLab version 16.8 or later.

To install GitLab for Eclipse:

  1. Open your Eclipse IDE and your preferred web browser.
  2. In your web browser, go to the page for the GitLab for Eclipse plugin in the Eclipse Marketplace.
  3. On the plugin’s page, select Install, and drag your mouse over to your Eclipse IDE.
  4. In the Eclipse Marketplace window, select the GitLab For Eclipse category.
  5. Select Confirm >, then select Finish.
  6. If the Trust Authorities window appears, select the https://gitlab.com update site and select Trust Selected.
  7. Select Restart Now.

If the Eclipse Marketplace is unavailable, follow the Eclipse installation instructions for adding a new software site. For Work with, use https://gitlab.com/gitlab-org/editor-extensions/gitlab-eclipse-plugin/-/releases/permalink/latest/downloads/.

Authenticate with GitLab

After you install the plugin, authenticate and connect it to your GitLab account.

Prerequisites:

To authenticate with GitLab:

  1. In your IDE, open preferences:
    • For macOS, select Eclipse > Settings.
    • For Windows or Linux, select Window > Preferences.
  2. In the left sidebar, select GitLab Duo.
  3. Under Connection, enter the URL for your GitLab instance. For GitLab.com, use https://gitlab.com.
  4. Under Authentication, enter your personal access token. Your token is hidden and stored using Eclipse secure storage.
  5. Select Verify Setup.
  6. Select Apply and Close.

Configure Code Suggestions

Prerequisites:

  • You meet the prerequisites for Code Suggestions.
  • You open an Eclipse project instead of a single file.

Code Suggestions is on by default. To verify:

  1. In Eclipse, open your GitLab project.
  2. In the Eclipse bottom toolbar, select the GitLab icon.
  3. Check the status of Code Suggestions.

To turn off Code Suggestions for a project:

  1. In the Eclipse bottom toolbar, select the GitLab icon.
  2. Select Disable Code Suggestions.

To turn off Code Suggestions for a specific language:

  1. In the Eclipse bottom toolbar, select the GitLab icon.
  2. Select Show Settings.
  3. Under Code Suggestions Enabled Languages, clear the checkbox for the language you want to turn off.

You can also add support for more languages.