Install and set up the GitLab Duo 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, in the top bar, select your IDE's name, then select Settings.
2. In 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.

Authenticate with GitLab

Prerequisites:

• For GitLab Self-Managed and GitLab Dedicated authentication using OAuth:
  • GitLab Duo plugin for JetBrains 3.30.30 and later.
  • The application ID for an instance-wide OAuth application for JetBrains IDEs.
• For authentication using PAT, a personal access token with the api scope.
• For authentication with 1Password, completion of the steps to integrate with 1Password and the secret reference.

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

1. In your IDE, in the top bar, select your IDE's name, then select Settings.
2. In 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, OAuth, PAT, or 1Password CLI.
   • For OAuth, follow the prompts to sign in and authenticate.
   • For PAT, enter your personal access token. The token value is not displayed or accessible to others.
   • For 1Password, select Integrate with 1Password CLI, select your account, and, optionally, enter the secret reference.
5. Select Verify setup.
6. Select OK or Save.

Configure GitLab Duo

Prerequisites:

• For agentic features, you meet the prerequisites for GitLab Duo Agent Platform.
• You have GitLab Duo turned on.
• For flows, you have foundational flows turned on.
• For agents, you have foundational agents turned on and custom agents enabled, as needed.
• You have a default GitLab Duo namespace set or have a project open that has GitLab Duo access.

To enable GitLab Duo features:

1. In your JetBrains IDE, go to Settings > Tools > GitLab Duo.
2. Find the feature you want to enable and select the checkbox.
3. Restart your IDE, if prompted.

For GitLab Duo Code Suggestions, review the additional prerequisites and setup steps.

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.

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

<i class="fa-youtube-play" aria-hidden="true"></i> For a video tutorial of this process, see Install alpha releases of the GitLab Duo plugin for JetBrains.

<!-- Video published on 2024-04-04 -->