1
0
mirror of synced 2025-12-21 10:57:10 -05:00
Files
docs/content/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-jetbrains.md
2022-06-08 19:47:03 +02:00

5.5 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. Below the bracket of the main function, type the following function header:
    int calculateDaysBetweenDates
    
    {% data variables.product.prodname_copilot %} will automatically suggest a function body in grayed text, as shown below. The exact suggestion may vary. 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 edit the suggested code as is necessary.

Seeing alternative suggestions

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

{% 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. To see alternative suggestions:
    • On macOS, press Option+] for the next suggestion, or Option+[ for the previous suggestion.
    • On Windows or Linux, press Alt+] for the next suggestion, or Alt+[ for the previous suggestion.
  2. If {% data variables.product.prodname_copilot %} offers a suggestion you want to accept, press Tab.
  3. Alternatively, to reject all suggestions, press Esc.

Getting more suggestions

{% 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. To open a new tab with multiple additional options:
    • On macOS, press Option+Enter, and select Open Copilot.
    • On Windows or Linux, press Ctrl+Enter, and select Open Copilot. Screenshot of dialogue to open Copilot {% data variables.product.prodname_copilot %} will open a new tab and suggest multiple options.
  2. If you want to accept one of the suggestions, above that suggestion, click Accept Solution. Screenshot of Accept Solution button
  3. Alternatively, to reject all suggestions, close the suggestions 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. In the Java file, type the following:
    // find all images without alternate text
    // and give them a red border
    void process () {
    

{% data variables.product.prodname_copilot %} will suggest an implementation of the function. 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