Introduction

This guide demonstrates how to get coding suggestions from GitHub Copilot in a JetBrains IDE. To see instructions for other popular coding environments, use the tool switcher at the top of the page.

The examples in this guide use Java, however other languages will work similarly.

For more information, seeGitHub Copilot code suggestions in your IDE.

Prerequisites

• Access to Copilot. To use GitHub Copilot in JetBrains, you need either limited access through Copilot Free or a paid Copilot plan for full access. SeeWhat is GitHub Copilot?.

• Compatible JetBrains IDE. To use GitHub Copilot in JetBrains, you must have a compatible JetBrains IDE installed. GitHub Copilot is compatible with the following IDEs:

  • IntelliJ IDEA (Ultimate, Community, Educational)
  • Android Studio
  • AppCode
  • CLion
  • Code With Me Guest
  • DataGrip
  • DataSpell
  • GoLand
  • JetBrains Client
  • MPS
  • PhpStorm
  • PyCharm (Professional, Community, Educational)
  • Rider
  • RubyMine
  • RustRover
  • WebStorm
  • Writerside

  See theJetBrains IDEs tool finder to download.

• Latest version of the GitHub Copilot extension. See theGitHub Copilot plugin in the JetBrains Marketplace. For installation instructions, seeInstalling the GitHub Copilot extension in your environment.

• Sign in to GitHub in your JetBrains IDE. For authentication instructions, seeInstalling the GitHub Copilot extension in your environment.

Getting code suggestions

GitHub Copilot offers coding suggestions as you type. For example, in a Java file, create a class by typingclass Test.

GitHub Copilot will automatically suggest a class body in grayed text. To accept the suggestion, pressTab.

You can also describe something you want to do using natural language within a comment, and Copilot will suggest the code to accomplish your goal. For example, type this comment in a Java file:

// find all images without alternate text// and give them a red bordervoid process () {

// find all images without alternate text// and give them a red bordervoidprocess() {

GitHub Copilot will automatically suggest code. To accept the suggestion, pressTab.

GitHub Copilot will attempt to match the context and style of your code. You can always edit the suggested code.

Showing alternative suggestions

For any given input, GitHub Copilot may offer multiple suggestions. You can select which suggestion to use, or reject all suggestions.

For example, type the following line in a Java file, and pressEnter:

private int calculateDaysBetweenDates(Date date1,

privateintcalculateDaysBetweenDates(Date date1,

GitHub Copilot will show you a suggestion.

Now hover over the suggestion to show the GitHub Copilot control for choosing suggestions. To display next or previous suggestions, click the forward or back arrow button in the control.

You can also use keyboard shortcuts to show alternative suggestions:

To accept a suggestion, click "Accept" in the Copilot command palette, or pressTab. To reject all suggestions, pressEsc.

Showing multiple suggestions in a new tab

If you don't want to use any of the initial suggestions GitHub Copilot offers, you can show multiple suggestions in a new tab.

For example, type the following line in a Java file:

private int calculateDaysBetweenDates(Date date1,

privateintcalculateDaysBetweenDates(Date date1,

GitHub Copilot will show you a suggestion.

To open a new tab with multiple additional suggestions, use the following keyboard shortcut, then clickOpen GitHub Copilot:

To accept a suggestion, below the suggestion, clickAccept suggestion NUMBER. To reject all suggestions, close the tab.

Accepting partial suggestions

If you don't want to accept an entire suggestion from GitHub Copilot, you can accept the next word or the next line of a suggestion.

For example, type the following line in a Java file:

private int calculateDaysBetweenDates(Date date1,

privateintcalculateDaysBetweenDates(Date date1,

GitHub Copilot will show a suggestion in grayed text. The exact suggestion may vary.

Now hover over the suggestion to show the GitHub Copilot control for choosing suggestions. To accept only the next word of the suggestion, clickAccept Word in the control.

Alternatively, you can use a keyboard shortcut to accept the next word of a suggestion:

If you want to accept the next line of a suggestion, you will need to set a custom keyboard shortcut for the commandeditor.action.inlineSuggest.acceptNextLine. For more information on setting custom keyboard shortcuts, seeConfiguring GitHub Copilot in your environment.

Introduction

This guide demonstrates how to get coding suggestions from GitHub Copilot in Visual Studio for Windows. To see instructions for other popular coding environments, use the tool switcher at the top of the page.

The examples in this guide use C#, however other languages will work similarly.

For more information, seeGitHub Copilot code suggestions in your IDE.

Prerequisites

• Access to Copilot. To use GitHub Copilot in GitHub Copilot in Visual Studio, you need either limited access through Copilot Free or a paid Copilot plan for full access. SeeWhat is GitHub Copilot?.

• Compatible version of Visual Studio. To use GitHub Copilot in Visual Studio, you must have version 2022 17.8 or later of Visual Studio for Windows installed. For more information, seeInstall Visual Studio in the Microsoft documentation.

• GitHub Copilot extension for Visual Studio. For instructions on how to install the Copilot extension, seeInstall GitHub Copilot in Visual Studio in the Microsoft documentation.

• Add your GitHub account to Visual Studio. SeeAdd your GitHub accounts to your Visual Studio keychain in the Microsoft documentation.

Getting code suggestions

GitHub Copilot offers coding suggestions as you type. For example, type this functionsignature in a C# file:

int CalculateDaysBetweenDates(

intCalculateDaysBetweenDates(

GitHub Copilot will automatically suggest an entire function body in grayed text. To accept the suggestion, pressTab.

You can also describe something you want to do using natural language within a comment, and Copilot will suggest the code to accomplish your goal. For example, type this comment in the C# file:

using System.Xml.Linq;var doc = XDocument.Load("index.xhml");// find all images

using System.Xml.Linq;var doc = XDocument.Load("index.xhml");// find all images

GitHub Copilot will suggest an implementation of the function. To accept the suggestion, pressTab.

Showing alternative suggestions

For any given input, GitHub Copilot may offer multiple suggestions. You can select which suggestion to use, or reject all suggestions.

For example, type this function signature in a C# file:

int CalculateDaysBetweenDates(

intCalculateDaysBetweenDates(

GitHub Copilot will show you a suggestion.

Now hover over the suggestion to show the GitHub Copilot control for choosing suggestions. To display next or previous suggestions, click the forward or back arrow button in the control.

Alternatively, you can show alternate suggestions by pressingAlt+. (orAlt+,) on your keyboard.

To accept a suggestion, click "Accept" in the Copilot command palette, or pressTab. To reject all suggestions, pressEsc.

Getting comment suggestions

GitHub Copilot can suggest comments for your code, by analyzing the code you write and generating comments that describe what the code does. For Copilot Free users, comment suggestions count towards your monthly Copilot Chat usage, not your code suggestions usage.

Comment suggestions are available in the following languages:

• C#
• C++

Enabling comment suggestions

To enable comment suggestions, you need to configure the comment style in Visual Studio.

For C++

1. In Visual Studio, in theTools menu, clickOptions.
2. In the left-side panel, clickText Editor.
3. ClickC++, thenCode Style, thenGeneral.
4. Under "Comments," selectXml Doc Comments from the dropdown.
5. SelectInsert existing comment style at the start of new lines when writing comments andContinue single line comments.

For C#

1. In Visual Studio, in theTools menu, clickOptions.
2. In the left-side panel, clickText Editor.
3. ClickC#, thenAdvanced.
4. Under "Comments," selectGenerate XML documentation comments for ///,Insert // at the start of new lines when writing // comments, andInsert * at the start of new lines when writing /* */ comments.

Using comment suggestions

To initiate comment suggestions, type the standard comment initiator for the language you are writing in (for example,///), before the code you want to comment, and wait for the suggestion to appear.

To accept the suggestion, pressTab. To modify the suggestion, pressAlt+/. To reject the suggestion, pressEsc.

Navigating and accepting next edit suggestions

Based on the edits you are making, Copilot will predict the location of the next edit you are likely to make and suggest a completion for it.

You can navigate suggested code changes usingTab, making it easier to find the next relevant edit without manually searching through files or references. PressTab again to accept a suggestion.

An arrow in the gutter indicates an available edit suggestion. Click the arrow to access the edit suggestion menu, which provides keyboard shortcuts. If an edit suggestion is outside the current editor view, the arrow will point up or down to indicate where the next suggestion is.

Introduction

This guide demonstrates how to get coding suggestions from GitHub Copilot in Visual Studio Code. To see instructions for other popular coding environments, use the tool switcher at the top of the page.

The examples in this guide use JavaScript, however other languages will work similarly.

For more information, seeGitHub Copilot code suggestions in your IDE.

Prerequisites

• Access to Copilot. To use GitHub Copilot in Visual Studio Code, you need either limited access through Copilot Free or a paid Copilot plan for full access. SeeWhat is GitHub Copilot?.

• Sign in to GitHub in Visual Studio Code. SeeSet up GitHub Copilot in Visual Studio Code in the VS Code documentation..

• Visual Studio Code. To use GitHub Copilot in Visual Studio Code, you must have Visual Studio Code installed. For more information, see theVisual Studio Code download page.

• Copilot in Visual Studio Code. When you set up GitHub Copilot in Visual Studio Code for the first time, the required extensions are installed automatically. You don't need to download or install them manually. For detailed instructions, seeSet up GitHub Copilot in Visual Studio Code in the Visual Studio Code documentation.

Getting code suggestions

GitHub Copilot offers coding suggestions as you type. For example, type this function header in a JavaScript file:

function calculateDaysBetweenDates(begin, end) {

functioncalculateDaysBetweenDates(begin, end) {

GitHub Copilot will automatically suggest the rest of the function. To accept the suggestion, pressTab.

You can also describe something you want to do using natural language within a comment, and Copilot will suggest the code to accomplish your goal. For example, type this comment in a JavaScript file:

// write a function to// find all images without alternate text// and give them a red border

// write a function to// find all images without alternate text// and give them a red border

GitHub Copilot will automatically suggest code. To accept the suggestion, pressTab.

Showing alternative suggestions

For any given input, GitHub Copilot may offer multiple suggestions. You can select which suggestion to use, or reject all suggestions.

For example, type this function header in a JavaScript file, and pressEnter:

function calculateDaysBetweenDates(begin, end) {

functioncalculateDaysBetweenDates(begin, end) {

GitHub Copilot will show you a suggestion.

Now hover over the suggestion to show the GitHub Copilot control for choosing suggestions. To display next or previous suggestions, click the forward or back arrow button in the control.

You can also use keyboard shortcuts to show alternative suggestions:

To accept a suggestion, click "Accept" in the Copilot command palette, or pressTab. To reject all suggestions, pressEsc.

Showing multiple suggestions in a new tab

If you don't want to use any of the initial suggestions GitHub Copilot offers, you can show multiple suggestions in a new tab.

For example, type this function header in a JavaScript file, and pressEnter:

function calculateDaysBetweenDates(begin, end) {

functioncalculateDaysBetweenDates(begin, end) {

GitHub Copilot will show you a suggestion. Now pressCtrl+Enter to open a new tab with multiple additional options.

To accept a suggestion, below the suggestion, clickAccept suggestion NUMBER. To reject all suggestions, close the tab.

Accepting partial suggestions

If you don't want to accept an entire suggestion from GitHub Copilot, you can accept the next word or the next line of a suggestion.

For example, type this function header in a JavaScript file, and pressEnter:

function calculateDaysBetweenDates(begin, end) {

functioncalculateDaysBetweenDates(begin, end) {

GitHub Copilot will automatically suggest an entire function body in grayed text. The exact suggestion may vary.

Now hover over the suggestion to show the GitHub Copilot control for choosing suggestions. To accept only the next word of the suggestion, clickAccept Word in the control.

Alternatively, you can use a keyboard shortcut to accept the next word of a suggestion:

If you want to accept the next line of a suggestion, you will need to set a custom keyboard shortcut for the commandeditor.action.inlineSuggest.acceptNextLine. For more information on setting custom keyboard shortcuts, seeConfiguring GitHub Copilot in your environment.

Navigating and accepting next edit suggestions

Next edit suggestions predicts where and what edits may be needed based on ongoing changes.

You can navigate suggested code changes usingTab, making it easier to find the next relevant edit without manually searching through files or references. PressTab again to accept a suggestion.

An arrow in the gutter indicates an available edit suggestion. Hover over the arrow to access the edit suggestion menu, which provides keyboard shortcuts and settings options. If an edit suggestion is outside the current editor view, the arrow will point up or down to indicate where the next suggestion is.

For more details and examples, seeCode completions with GitHub Copilot in VS Code in the Visual Studio Code documentation.

Changing the AI model

You can change the large language model that's used to generate code completion suggestions. For more information, seeChanging the AI model for GitHub Copilot code completion.

Introduction

This guide demonstrates how to get coding suggestions from GitHub Copilot in Vim/Neovim. To see instructions for other popular coding environments, use the tool switcher at the top of the page.

Prerequisites

• Access to Copilot. To use GitHub Copilot in Vim/Neovim, you need either limited access through Copilot Free or a paid Copilot plan for full access. SeeWhat is GitHub Copilot?.

• Compatible version of Vim/Neovim. To use GitHub Copilot in Vim/Neovim you must have Vim version 9.0.0185 / Neovim version 0.6 or above and Node.js version 18 or above installed. For more information, see theVim /Neovim documentation and theNode.js website.

• GitHub Copilot extension for Vim/Neovim. To use GitHub Copilot in Vim/Neovim, you must install the GitHub Copilot plugin. For more information, seeInstalling the GitHub Copilot extension in your environment.

Learning to use GitHub Copilot in Vim/Neovim

GitHub Copilot provides suggestions inline as you type in Vim/Neovim. To accept a suggestion, press thetab key.

For more information and guidance on using GitHub Copilot in Vim/Neovim run the following command to view the plugin documentation:

:help copilot

:help copilot

Introduction

This guide demonstrates how to get coding suggestions from GitHub Copilot in Azure Data Studio. To see instructions for other popular coding environments, use the tool switcher at the top of the page.

Prerequisites

• Access to Copilot. To use GitHub Copilot in Azure Data Studio, you need either limited access through Copilot Free or a paid Copilot plan for full access. SeeWhat is GitHub Copilot?.

• Compatible version of Azure Data Studio. To use GitHub Copilot in Azure Data Studio, you must have Azure Data Studio version 1.44.0 or later installed. For more information, see theAzure Data Studio download page in the Azure Data Studio documentation.

• GitHub Copilot extension for Azure Data Studio. To use GitHub Copilot in Azure Data Studio, you must install the GitHub Copilot extension. For more information, seeInstalling the GitHub Copilot extension in your environment.

Getting code suggestions

GitHub Copilot can provide you with inline suggestions as you create SQL databases in Azure Data Studio. For example, if you're writing a query that joins two tables, Copilot may suggest the join condition from columns in the open editor, other files in the workspace, and common syntax patterns.

In a SQL file, type the following query:

SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow]FROM [Tag].[Scoreboard]INNER JOIN

SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow]FROM [Tag].[Scoreboard]INNERJOIN

GitHub Copilot will automatically suggest a join condition in grayed text. The exact suggestion may vary. To accept the suggestion, pressTab.

You can also describe something you want to do using natural language within a comment, and Copilot will suggest the code to accomplish your goal. For example, type this comment in a SQL file:

SELECT TokenColor, COUNT(UserID) AS UserCountFROM Tag.UsersGROUP BY TokenColor-- pivot that query on tokencolor for Purple, Blue, Green, Yellow, Orange, Red-- and rename the columns to match the colorsSELECT [Purple], [Blue], [Green], [Yellow], [Orange], [Red]

SELECT TokenColor,COUNT(UserID)AS UserCountFROM Tag.UsersGROUPBY TokenColor-- pivot that query on tokencolor for Purple, Blue, Green, Yellow, Orange, Red-- and rename the columns to match the colorsSELECT [Purple], [Blue], [Green], [Yellow], [Orange], [Red]

GitHub Copilot will automatically suggest code. To accept the suggestion, pressTab.

Showing alternative suggestions

For some suggestions, GitHub Copilot may provide multiple alternatives. You can select which suggestion you want to use, or reject all suggestions.

For example, type this query in a SQL file:

SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow]FROM [Tag].[Scoreboard]INNER JOIN

SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow]FROM [Tag].[Scoreboard]INNERJOIN

GitHub Copilot will show you a suggestion.

Now hover over the suggestion to show the GitHub Copilot control for choosing suggestions. To display next or previous suggestions, click the forward or back arrow button in the control.

You can also use keyboard shortcuts to show alternative suggestions:

To accept a suggestion, click "Accept" in the Copilot control, or pressTab. To reject all suggestions, pressEsc.

Accepting partial suggestions

If you don't want to accept an entire suggestion from GitHub Copilot, you can accept the next word or the next line of a suggestion.

For example, type this query in a SQL file:

SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow]FROM [Tag].[Scoreboard]INNER JOIN

SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow]FROM [Tag].[Scoreboard]INNERJOIN

GitHub Copilot will show you a suggestion in grayed text. The exact suggestion may vary.

Now hover over the suggestion to show the GitHub Copilot control for choosing suggestions. To accept only the next word of the suggestion, clickAccept Word in the control.

Alternatively, you can use a keyboard shortcut to accept the next word of a suggestion:

If you want to accept the next line of the suggestion, you will need to set a custom keyboard shortcut for the commandeditor.action.inlineSuggest.acceptNextLine. For more information on setting custom keyboard shortcuts, seeKeyboard shortcuts in Azure Data Studio in the Microsoft documentation.

Introduction

This guide demonstrates how to get coding suggestions from GitHub Copilot in Xcode. To see instructions for other popular coding environments, use the tool switcher at the top of the page.

Prerequisites

• Access to Copilot. To use GitHub Copilot in Xcode, you need either limited access through Copilot Free or a paid Copilot plan for full access. SeeWhat is GitHub Copilot?.

• GitHub Copilot extension for Xcode. To use GitHub Copilot for Xcode, you must install the GitHub Copilot for Xcode extension. SeeInstalling the GitHub Copilot extension in your environment.

Getting code suggestions

GitHub Copilot offers coding suggestions as you type. For example, type this functionsignature in a Swift file:

func calculateDaysBetweenDates(

funccalculateDaysBetweenDates(

GitHub Copilot will automatically suggest an entire function body in grayed text. To accept the first line of a suggestion, pressTab. To view the full suggestion, holdOption, and to accept the full suggestion, pressOption+Tab.

Improving code suggestions

If you encounter issues with code suggestions, such as conflicting or missing suggestions, you can try the following:

• Disable Xcode's native predictive text completion: To avoid receiving two sets of code suggestions, you can disable Xcode's native predictive text completion. You can find this setting in the Xcode settings in the "Editing" tab under "Text Editing."
• Check for duplication detection in Copilot: If you receive limited or no suggestions from Copilot, you may have duplication detection enabled. For more information on duplication detection, seeManaging GitHub Copilot policies as an individual subscriber.
• Check for updates and restart Xcode: Ensure you have the latest version of Copilot for Xcode in the extension application and restart Xcode.

You can also open an issue in theCopilot for Xcode repository.

Introduction

This guide demonstrates how to get coding suggestions from GitHub Copilot in Eclipse. To see instructions for other popular coding environments, use the tool switcher at the top of the page.

Prerequisites

• Access to Copilot. To use GitHub Copilot in Eclipse, you need either limited access through Copilot Free or a paid Copilot plan for full access. SeeWhat is GitHub Copilot?.

• GitHub Copilot extension for Eclipse.To use GitHub Copilot in Eclipse, you must install the GitHub Copilot extension. SeeInstalling the GitHub Copilot extension in your environment.

Getting code suggestions

GitHub Copilot offers coding suggestions as you type. For example, type this function header in a Java file:

public int getDiff(int a, int b)

publicintgetDiff(int a,int b)

GitHub Copilot will automatically suggest the rest of the function. To accept the suggestion, pressTab.To discard the suggestion, pressEsc.

You can also describe something you want to do using natural language within a comment, and Copilot will suggest the code to accomplish your goal. For example, type this comment in a Java file:

/* * Return the difference between two different integers. */

/* * Return the difference between two different integers. */

GitHub Copilot will automatically suggest code.

Manually triggering code completion

You can also use keyboard shortcuts to trigger code completion.

Accepting partial suggestions

If you don't want to accept an entire suggestion from Copilot, you can accept the next word of a suggestion.