The GitLab Docs website is now available in Japanese!

Install and set up the GitLab plugin for JetBrains IDEs

Download the plugin from the JetBrains Plugin Marketplace and install it.

Prerequisites:

  • JetBrains IDEs: 2023.2.X and later.
  • GitLab version 16.8 or later.

If you use an older version of a JetBrains IDE, download a version of the plugin compatible with your IDE:

  1. On the GitLab Duo plugin page, select Versions.
  2. Select Compatibility, then select your JetBrains IDE.
  3. Select a Channel to filter for stable releases or alpha releases.
  4. In the compatibility table, find your IDE version and select Download.

Enable the plugin

To enable the plugin:

  1. In your IDE, on the top bar, select your IDE’s name, then select Settings.
  2. On the left sidebar, select Plugins.
  3. Select the GitLab Duo plugin, and select Install.
  4. Select OK or Save.

Connect to GitLab

After you install the extension, connect it to your GitLab account.

Create a personal access token

If you are on GitLab Self-Managed, create a personal access token.

  1. In GitLab, in the upper-right corner, select your avatar.
  2. Select Edit profile.
  3. On the left sidebar, select Personal access tokens.
  4. Select Add new token.
  5. Enter a name, description, and expiration date.
  6. Select the api scope.
  7. Select Create personal access token.

Authenticate with GitLab

After you configure the plugin in your IDE, connect it to your GitLab account:

  1. In your IDE, on the top bar, select your IDE’s name, then select Settings.
  2. On the left sidebar, expand Tools, then select GitLab Duo. If you don’t see the plugin listed, restart your IDE.
  3. Provide the URL to GitLab instance. For GitLab.com, use https://gitlab.com.
  4. Select an authentication method:
    • For GitLab.com, select OAuth and follow the prompts to authenticate.
    • For GitLab Self-Managed and GitLab Dedicated, select PAT and paste your personal access token. The token value is not displayed or accessible to others.
  5. Select Verify setup.
  6. Select OK or Save.

Configure GitLab Duo

Prerequisites:

  • You have the GitLab Duo add-on and a seat assigned.
  • You open a project that is linked to a remote repository on GitLab, or you set a default GitLab Duo namespace.

To enable GitLab Duo Chat and GitLab Duo Code Suggestions, review the prerequisites and setup steps for each feature:

Set the default namespace

The GitLab Duo Agent Platform uses the Default Namespace value when the plugin can’t determine the current GitLab project. To configure this value:

  1. In your IDE, on the top bar, select your IDE’s name, then select Settings.
  2. On the left sidebar, expand Tools, then select GitLab Duo.
  3. Enter a value for Default Namespace.
  4. Select OK or Save.

Install alpha versions of the plugin

GitLab publishes pre-release (alpha) builds of the plugin to the Alpha release channel in the JetBrains Marketplace.

To install a pre-release build, either:

  • Download the build from JetBrains Marketplace and install it from disk.

  • Add the alpha plugin repository to your IDE. For the repository URL, use https://plugins.jetbrains.com/plugins/alpha/list.

    To see the alpha release after adding the alpha plugin repository, you might need to uninstall and reinstall the GitLab Duo plugin.

For a video tutorial of this process, see Install alpha releases of the GitLab Duo plugin for JetBrains.