docs/content/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide.md

title, shortTitle, intro, product, versions, topics

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

About {% data variables.product.prodname_copilot %} and JetBrains IDEs

{% data reusables.copilot.procedural-intro %}

If you use a JetBrains IDE, you can view and incorporate suggestions from {% data variables.product.prodname_copilot %} directly within the editor. This guide demonstrates how to use {% data variables.product.prodname_copilot %} within a JetBrains IDE for macOS, Windows, or Linux.

Prerequisites

{% data reusables.copilot.jetbrains-ides %}

Installing the JetBrains extension

To use {% data variables.product.prodname_copilot %} in a JetBrains IDE, you must install the {% data variables.product.prodname_copilot %} extension.

1. In your JetBrains IDE, under the File menu, click Settings.
2. At the top of the "Settings" dialogue box, click Marketplace. In the search bar, search for {% data variables.product.prodname_copilot %} and click Install.
3. Once {% data variables.product.prodname_copilot %} is installed, click Restart IDE.
4. Once your JetBrains IDE has restarted, in the Tools menu, under {% data variables.product.prodname_copilot %}, click Login to {% data variables.product.prodname_dotcom %}.
5. In the "Sign in to {% data variables.product.prodname_dotcom %}" dialogue box, to copy the device code and open the device activation window, click Copy and Open.
6. A device activation window will open in your browser. Press Ctrl+V to paste the device code and click Continue.
7. {% data variables.product.prodname_dotcom %} will request the necessary permissions for {% data variables.product.prodname_copilot %}. To approve these permissions, click Authorize {% data variables.product.prodname_copilot %} Plugin To refuse the permissions, click Cancel.
8. Once the permissions have been approved, your JetBrains IDE will show a confirmation. Click OK to begin using {% data variables.product.prodname_copilot %}.

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. {% 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. {% data reusables.copilot.java-int-snippet %} {% 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. {% data reusables.copilot.java-int-snippet %} {% data reusables.copilot.see-alternative-suggestions %}

   OS	See next suggestion	See previous suggestion
   macOS	Option+]	Option+[
   Windows	Alt+]	Alt+[
   Linux	Alt+]	Alt+[
   {% data reusables.copilot.accept-or-reject-suggestion %}

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: {% data reusables.copilot.java-int-snippet %} {% data variables.product.prodname_copilot %} will show you a suggestion.
2. Open a new tab with multiple additional suggestions.
   • On macOS, press Command+Shift+A, then click Open GitHub Copilot, or press Command+Shift+</kbd> to open the new tab immediately.
   • On Windows or Linux, press Ctrl+Enter, then click Open GitHub Copilot.
3. To accept a suggestion, above the suggestion, click Accept Solution. To reject all suggestions, close the tab.

Generating code suggestions from comments

{% data reusables.copilot.generating-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 () {
   

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

You can enable or disable {% data variables.product.prodname_copilot %} for all languages, or for individual languages. The {% data variables.product.prodname_copilot %} status icon in the bottom panel of your JetBrains IDE 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.

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 suggestions from {% data variables.product.prodname_copilot %} globally, click Disable Completions.
   • To disable suggestions from {% data variables.product.prodname_copilot %} for the specified language, click Disable Completions for LANGUAGE.

Further reading

• The {% data variables.product.prodname_copilot %} website
• {% data variables.product.prodname_copilot %} Licensing Information for JetBrains Plugin