1
0
mirror of synced 2025-12-21 19:06:49 -05:00
Files
docs/content/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-jetbrains.md

5.2 KiB

title, shortTitle, intro, product, versions, topics
title shortTitle intro product versions topics
Getting started with GitHub Copilot in JetBrains JetBrains Learn how to install {% data variables.product.prodname_copilot %} in JetBrains, and start seeing suggestions as you write comments and code. {% data reusables.gated-features.copilot %}
feature
copilot
Copilot

Prerequisites

  • To use {% data variables.product.prodname_copilot %} in JetBrains, you must have JetBrains IDEs installed. For more information, see the JetBrains IDEs documentation.

Installing the JetBrains extension

Seeing your first suggestion

{% data reusables.copilot.supported-languages %} The following samples are in Java, but other languages will work similarly.

{% data reusables.copilot.create-java-file %}

  1. In the Java file, create a class by typing class Test. {% data variables.product.prodname_copilot %} will automatically suggest a class body in grayed text, as shown below. The exact suggestion may vary. Screenshot of the Java class body suggestion {% data reusables.copilot.accept-suggestion %}
  2. To prompt {% data variables.product.prodname_copilot %} to suggest a function body, type the following line below the bracket of the main function. The exact suggestion may vary.
    int calculateDaysBetweenDates
    
    Screenshot of the Java function body suggestion {% data reusables.copilot.accept-suggestion %}

{% data variables.product.prodname_copilot %} will attempt to match the context and style of your code. You can always edit the suggested code.

Seeing alternative suggestions

{% data reusables.copilot.alternative-suggestions %}

{% data reusables.copilot.create-java-file %}

  1. To prompt {% data variables.product.prodname_copilot %} to show you a suggestion, type the following line in the Java file.

     int calculateDaysBetweenDates(
    
  2. Optionally, you can see alternative suggestions.

    OS See next suggestion See previous suggestion
    macOS Option+] Option+[
    Windows Alt+] Alt+[
    Linux Alt+] Alt+[
  3. To accept a suggestion, press Tab. To reject all suggestions, press Esc.

Seeing multiple suggestions in a new tab

{% data reusables.copilot.suggestions-new-tab %}

{% data reusables.copilot.create-java-file %}

  1. In the Java file, type the following:
    int calculateDaysBetweenDates(
    

{% data variables.product.prodname_copilot %} will show you a suggestion.

  1. Open a new tab with multiple additional suggestions.
    • On macOS, press Option+Enter, then click Open GitHub Copilot.
    • On Windows or Linux, press Ctrl+Enter, then click Open GitHub Copilot. Screenshot of dialogue to open Copilot
  2. To accept a suggestion, above the suggestion, click Accept Solution. To reject all suggestions, close the tab.

Generating code suggestions from comments

{% data variables.product.prodname_copilot %} can also generate code suggestions from comments.

{% data reusables.copilot.create-java-file %}

  1. To prompt {% data variables.product.prodname_copilot %} to suggest an implementation of a function in the Java file, type the following lines.
    // find all images without alternate text
    // and give them a red border
    void process () {
    

Screenshot of the Java function body suggestion

Enabling and disabling {% data variables.product.prodname_copilot %}

You can enable or disable {% data variables.product.prodname_copilot %} from within JetBrains. The {% data variables.product.prodname_copilot %} status icon in the bottom panel of the JetBrains window indicates whether {% data variables.product.prodname_copilot %} is enabled or disabled. When enabled, the icon is highlighted. When disabled, the icon is grayed out.

  1. To enable or disable {% data variables.product.prodname_copilot %}, click the status icon in the bottom panel of the JetBrains window. Screenshot of the status icon in JetBrains
  2. If you are disabling {% data variables.product.prodname_copilot %}, you will be asked whether you want to disable it globally, or for the language of the file you are currently editing. To disable globally, click Disable Completions. Alternatively, click the language-specific button to disable completions for the specified language. Screenshot of option to disable {% data variables.product.prodname_copilot %} globally or for the current language

Further reading