ContextQMD
Back to Gitlabhq

GitLab Duo plugin for JetBrains IDEs

doc/editor_extensions/jetbrains_ide/_index.md

19.1.06.5 KB
Original Source

The GitLab Duo plugin integrates GitLab Duo with JetBrains IDEs like IntelliJ, PyCharm, GoLand, Webstorm, and Rubymine.

The plugin includes the following features:

  • On the right tool window bar, GitLab Duo Agent Platform ({{< icon name="duo-agentic-chat" >}}):
    • The chat tab: Interact with GitLab Duo Agentic Chat, or use the New chat ({{< icon name="duo-chat-new" >}}) dropdown list to select a foundational or custom agent to work with.
    • The flows tab: Use the Software Development Flow. Learn more about the difference between Chat and the flow.
  • In the status bar, Duo ({{< icon name="tanuki-ai" >}}): Check the feature status of GitLab Duo Code Suggestions and review suggestions in your file as you author code.
  • On the right tool window bar, GitLab Duo Non-Agentic Chat ({{< icon name="duo-chat" >}}): Interact with GitLab Duo Non-Agentic Chat. Or select some code and then, in the floating toolbar, select GitLab Duo Quick Chat ({{< icon name="tanuki-ai" >}}) for in-line conversations.

To get started, install and configure the plugin.

Use with remote development

The GitLab Duo plugin works with JetBrains Remote Development when installed on the host machine (remote server).

[!warning] If you use remote development, install the plugin on the host machine only. If you install the plugin on the client (local) machine as well, GitLab Duo features will not work in your IDE. For information about installing plugins in remote development environments, see the JetBrains documentation:

Enable experimental or beta features

Some features in the plugin are in experiment or beta status. To use them, you must opt in:

  1. Go to your IDE's top menu bar and select Settings, or:
    • MacOS: press <kbd>Command</kbd>+<kbd>,</kbd>
    • Windows or Linux: press <kbd>Control</kbd>+<kbd>Alt</kbd>+<kbd>S</kbd>
  2. In the left sidebar, expand Tools, then select GitLab Duo.
  3. Select Enable Experiment or BETA features.
  4. To apply the changes, restart your IDE.

Update the extension

To update your extension to the latest version:

  1. In your JetBrains IDE, go to Settings > Plugins.
  2. From Marketplace, select GitLab Duo published by GitLab, Inc..
  3. Select Update to update to the latest plugin version.

Enable telemetry

The GitLab Duo plugin uses the telemetry settings in your JetBrains IDE to send usage and error information to GitLab. To enable telemetry in your JetBrains IDE:

  1. Go to your IDE's top menu bar and select Settings. For example, in PyCharm, select PyCharm > Settings.
  2. In the left sidebar, expand Tools, then select GitLab Duo.
  3. Under Advanced, select the Enable telemetry checkbox.
  4. Select OK or Apply to save your changes.

Integrate with 1Password CLI

{{< details >}}

  • Tier: Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

{{< history >}}

  • Introduced in GitLab Duo 2.1 for GitLab 16.11 and later.

{{< /history >}}

You can configure the plugin to use 1Password secret references for authentication instead of hard-coding personal access tokens.

Prerequisites:

To integrate the GitLab Duo plugin for JetBrains IDEs with the 1Password CLI:

  1. Authenticate with GitLab. Either:

  2. Open the 1Password item.

  3. Copy the secret reference.

    If you use the gitlab 1Password shell plugin, the token is stored as a password under "op://Private/GitLab Personal Access Token/token".

From the IDE:

  1. Go to your IDE's top menu bar and select Settings.
  2. In the left sidebar, expand Tools, then select GitLab Duo.
  3. Under Authentication, select the 1Password CLI tab.
  4. Select Integrate with 1Password CLI.
  5. Optional. For Secret reference, paste the secret reference you copied from 1Password.
  6. Optional. To verify your credentials, select Verify setup.
  7. Select OK or Save.

Report issues with the plugin

You can report any issues, bugs, or feature requests in the gitlab-jetbrains-plugin issue tracker. Use the Bug or Feature Proposal template.

If you encounter an error while using GitLab Duo, you can also report it with your IDE's built-in error reporting tool:

  1. To access the tool, either:
    • When an error occurs, in the error message, select See details and submit report.
    • In the status bar, on the bottom right, select the exclamation mark.
  2. In the IDE Internal Errors dialog, describe the error.
  3. Select Report and clear all.
  4. Your browser opens a GitLab issue form, pre-populated with debug information.
  5. Follow the prompts in the issue template to fill out the description, providing as much context as you can.
  6. Select Create issue to file the bug report.