| title | shortTitle | intro | redirect_from | versions | defaultTool | topics | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Getting code suggestions in your IDE with GitHub Copilot |
Get code suggestions |
Use {% data variables.product.prodname_copilot %} to get code suggestions in your editor. |
|
|
vscode |
|
{% jetbrains %}
This guide demonstrates how to get coding suggestions from {% data variables.product.prodname_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. {% data reusables.copilot.supported-languages %}
-
Access to {% data variables.product.prodname_copilot_short %}. To use {% data variables.product.prodname_copilot %} in JetBrains, you need either an active {% data variables.product.prodname_copilot_short %} subscription (such as {% data variables.product.prodname_copilot_pro_short %}, {% data variables.product.prodname_copilot_enterprise_short %}, or {% data variables.product.prodname_copilot_business_short %}) or access through {% data variables.product.prodname_copilot_free_short %}, which provides limited functionality. {% data reusables.copilot.subscription-prerequisite %}
-
Compatible JetBrains IDE. To use {% data variables.product.prodname_copilot %} in JetBrains, you must have a compatible JetBrains IDE installed. {% data variables.product.prodname_copilot %} is compatible with the following IDEs:
{% data reusables.copilot.jetbrains-compatible-ides %}
{% data reusables.copilot.jetbrains-plugin-prerequisites %}
{% data variables.product.prodname_copilot %} offers coding suggestions as you type. For example, in a Java file, create a class by typing class Test.
{% data variables.product.prodname_copilot %} will automatically suggest a class body in grayed text. {% data reusables.copilot.accept-suggestion %}
You can also describe something you want to do using natural language within a comment, and {% data variables.product.prodname_copilot_short %} 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 border
void process () {{% data variables.product.prodname_copilot %} will automatically suggest code. {% 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.
Tip
If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see AUTOTITLE.
{% data reusables.copilot.alternative-suggestions %}
For example, type the following line in a Java file, and press Enter:
{% indented_data_reference reusables.copilot.java-int-snippet spaces=3 %}
{% data variables.product.prodname_copilot %} will show you a suggestion.
Now hover over the suggestion to show the {% data variables.product.prodname_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:
| OS | See next suggestion | See previous suggestion |
|---|---|---|
| macOS | Option+] | Option+[ |
| Windows or Linux | Alt+] | Alt+[ |
{% data reusables.copilot.accept-or-reject-suggestion %}
{% data reusables.copilot.suggestions-new-tab %}
For example, type the following line in a Java file:
{% indented_data_reference reusables.copilot.java-int-snippet spaces=3 %}
{% data variables.product.prodname_copilot %} will show you a suggestion.
To open a new tab with multiple additional suggestions, use the following keyboard shortcut, then click Open {% data variables.product.prodname_copilot %}:
| OS | Open multiple suggestions |
|---|---|
| macOS | Command+Shift+A |
| Windows or Linux | Ctrl+Enter |
To accept a suggestion, below the suggestion, click Accept suggestion NUMBER. To reject all suggestions, close the tab.
If you don't want to accept an entire suggestion from {% data variables.product.prodname_copilot %}, you can accept the next word or the next line of a suggestion.
For example, type the following line in a Java file:
{% indented_data_reference reusables.copilot.java-int-snippet spaces=3 %}
{% data variables.product.prodname_copilot %} will show a suggestion in grayed text. The exact suggestion may vary.
Now hover over the suggestion to show the {% data variables.product.prodname_copilot %} control for choosing suggestions. To accept only the next word of the suggestion, click Accept Word in the control.
Alternatively, you can use a keyboard shortcut to accept the next word of a suggestion:
| OS | Accept Next Word | Accept Next Line |
|---|---|---|
| macOS | Command+→ | Command+Control+→ |
| Windows or Linux | Control+→ | Control+Alt+→ |
If you want to accept the next line of a suggestion, you will need to set a custom keyboard shortcut for the command editor.action.inlineSuggest.acceptNextLine. For more information on setting custom keyboard shortcuts, see AUTOTITLE.
{% endjetbrains %}
{% visualstudio %}
This guide demonstrates how to get coding suggestions from {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %} 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. {% data reusables.copilot.supported-languages %}
- Access to {% data variables.product.prodname_copilot_short %}. To use {% data variables.product.prodname_copilot %} in Visual Studio, you need either an active {% data variables.product.prodname_copilot_short %} subscription (such as {% data variables.product.prodname_copilot_pro_short %}, {% data variables.product.prodname_copilot_enterprise_short %}, or {% data variables.product.prodname_copilot_business_short %}) or access through {% data variables.product.prodname_copilot_free_short %}, which provides limited functionality. {% data reusables.copilot.subscription-prerequisite %}
{% data reusables.copilot.visual-studio-prerequisites %}
{% data variables.product.prodname_copilot %} offers coding suggestions as you type. For example, type this function signature in a C# file:
int CalculateDaysBetweenDates({% data variables.product.prodname_copilot %} will automatically suggest an entire function body in grayed text. {% data reusables.copilot.accept-suggestion %}
You can also describe something you want to do using natural language within a comment, and {% data variables.product.prodname_copilot_short %} 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{% data variables.product.prodname_copilot %} will suggest an implementation of the function. {% data reusables.copilot.accept-suggestion %}
Tip
If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see AUTOTITLE.
{% data reusables.copilot.alternative-suggestions %}
For example, type this function signature in a C# file:
int CalculateDaysBetweenDates({% data variables.product.prodname_copilot %} will show you a suggestion.
Now hover over the suggestion to show the {% data variables.product.prodname_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 pressing Alt+. (or Alt+,) on your keyboard.
{% data reusables.copilot.accept-or-reject-suggestion %}
{% endvisualstudio %}
{% vscode %}
About {% data variables.product.prodname_copilot %} and {% data variables.product.prodname_vscode %}
This guide demonstrates how to get coding suggestions from {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}. To see instructions for other popular coding environments, use the tool switcher at the top of the page.
{% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_vscode_shortname %} provides two kinds of suggestions:
- Code completions. {% data variables.product.prodname_copilot_short %} offers coding suggestions as you type. You can also describe something you want to do using natural language within a comment, and {% data variables.product.prodname_copilot_short %} will suggest the code to accomplish your goal.
- {% data variables.copilot.next_edit_suggestions_caps %} ({% data variables.release-phases.public_preview %}). Based on the edits you are making, {% data variables.product.prodname_copilot_short %} will predict the location of the next edit you are likely to make and suggest a completion for it.
The examples in this guide use JavaScript, however other languages will work similarly. {% data reusables.copilot.supported-languages %}
-
Access to {% data variables.product.prodname_copilot_short %}. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}, you need either an active {% data variables.product.prodname_copilot_short %} subscription (such as {% data variables.product.prodname_copilot_pro_short %}, {% data variables.product.prodname_copilot_enterprise_short %}, or {% data variables.product.prodname_copilot_business_short %}) or access through {% data variables.product.prodname_copilot_free_short %}, which provides limited functionality. {% data reusables.copilot.subscription-prerequisite %}
-
{% data variables.product.prodname_vscode %}. To use {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}, you must have {% data variables.product.prodname_vscode %} installed. For more information, see the {% data variables.product.prodname_vscode %} download page.
-
{% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_vscode %}. When you set up {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %} for the first time, the required extensions are installed automatically. You don't need to download or install them manually. For detailed instructions, see Set up {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %} in the {% data variables.product.prodname_vscode %} documentation.
{% data variables.product.prodname_copilot %} offers coding suggestions as you type. For example, type this function header in a JavaScript file:
function calculateDaysBetweenDates(begin, end) {{% data variables.product.prodname_copilot %} will automatically suggest the rest of the function. {% data reusables.copilot.accept-suggestion %}
You can also describe something you want to do using natural language within a comment, and {% data variables.product.prodname_copilot_short %} 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{% data variables.product.prodname_copilot %} will automatically suggest code. {% data reusables.copilot.accept-suggestion %}
Tip
If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see AUTOTITLE.
{% data reusables.copilot.alternative-suggestions %}
For example, type this function header in a JavaScript file, and press Enter:
function calculateDaysBetweenDates(begin, end) {{% data variables.product.prodname_copilot %} will show you a suggestion.
Now hover over the suggestion to show the {% data variables.product.prodname_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:
| OS | See next suggestion | See previous suggestion |
|---|---|---|
| macOS | Option (⌥) or Alt+] | Option (⌥) or Alt+[ |
| Windows or Linux | Alt+] | Alt+[ |
{% data reusables.copilot.accept-or-reject-suggestion %}
{% data reusables.copilot.suggestions-new-tab %}
For example, type this function header in a JavaScript file, and press Enter:
function calculateDaysBetweenDates(begin, end) {{% data variables.product.prodname_copilot %} will show you a suggestion. Now press Ctrl+Enter to open a new tab with multiple additional options.
To accept a suggestion, below the suggestion, click Accept suggestion NUMBER. To reject all suggestions, close the tab.
If you don't want to accept an entire suggestion from {% data variables.product.prodname_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 press Enter:
function calculateDaysBetweenDates(begin, end) {{% data variables.product.prodname_copilot %} will automatically suggest an entire function body in grayed text. The exact suggestion may vary.
Now hover over the suggestion to show the {% data variables.product.prodname_copilot %} control for choosing suggestions. To accept only the next word of the suggestion, click Accept Word in the control.
Alternatively, you can use a keyboard shortcut to accept the next word of a suggestion:
| OS | Accept Next Word |
|---|---|
| macOS | Command+→ |
| Windows or Linux | Control+→ |
If you want to accept the next line of a suggestion, you will need to set a custom keyboard shortcut for the command editor.action.inlineSuggest.acceptNextLine. For more information on setting custom keyboard shortcuts, see AUTOTITLE.
[!NOTE] {% data variables.copilot.next_edit_suggestions_caps %} is currently in {% data variables.release-phases.public_preview %} and is subject to change.
Inline suggestions autocomplete code, but many development tasks involve editing existing code. {% data variables.copilot.next_edit_suggestions_caps %} assists with edits both at the cursor and in other relevant parts of the code, helping maintain consistency and streamline changes.
{% data variables.copilot.next_edit_suggestions_caps %} predicts where and what edits may be needed based on ongoing changes. Suggestions may span a single symbol, an entire line, or multiple lines, depending on the scope of the potential change.
To enable {% data variables.copilot.next_edit_suggestions %}, see AUTOTITLE.
You can navigate suggested code changes using Tab, making it easier to find the next relevant edit without manually searching through files or references. Press Tab 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, see Code completions with {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode_shortname %} in the {% data variables.product.prodname_vscode %} documentation.
You can change the large language model that's used to generate code completion suggestions. For more information, see AUTOTITLE.
{% endvscode %}
{% vimneovim %}
This guide demonstrates how to get coding suggestions from {% data variables.product.prodname_copilot %} in Vim/Neovim. To see instructions for other popular coding environments, use the tool switcher at the top of the page.
-
Access to {% data variables.product.prodname_copilot_short %}. To use {% data variables.product.prodname_copilot %} in Vim/Neovim, you need either an active {% data variables.product.prodname_copilot_short %} subscription (such as {% data variables.product.prodname_copilot_pro_short %}, {% data variables.product.prodname_copilot_enterprise_short %}, or {% data variables.product.prodname_copilot_business_short %}) or access through {% data variables.product.prodname_copilot_free_short %}, which provides limited functionality. {% data reusables.copilot.subscription-prerequisite %}
-
Compatible version of Vim/Neovim. To use {% data variables.product.prodname_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 the Vim / Neovim documentation and the Node.js website.
-
{% data variables.product.prodname_copilot %} extension for Vim/Neovim. To use {% data variables.product.prodname_copilot %} in Vim/Neovim, you must install the {% data variables.product.prodname_copilot %} plugin. For more information, see AUTOTITLE.
{% data variables.product.prodname_copilot %} provides suggestions inline as you type in Vim/Neovim. To accept a suggestion, press the tab key.
For more information and guidance on using {% data variables.product.prodname_copilot %} in Vim/Neovim run the following command to view the plugin documentation:
:help copilot{% endvimneovim %}
{% azure_data_studio %}
This guide demonstrates how to get coding suggestions from {% data variables.product.prodname_copilot %} in Azure Data Studio. To see instructions for other popular coding environments, use the tool switcher at the top of the page.
-
Access to {% data variables.product.prodname_copilot_short %}. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you need either an active {% data variables.product.prodname_copilot_short %} subscription (such as {% data variables.product.prodname_copilot_pro_short %}, {% data variables.product.prodname_copilot_enterprise_short %}, or {% data variables.product.prodname_copilot_business_short %}) or access through {% data variables.product.prodname_copilot_free_short %}, which provides limited functionality. {% data reusables.copilot.subscription-prerequisite %}
-
Compatible version of Azure Data Studio. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you must have Azure Data Studio version 1.44.0 or later installed. For more information, see the Azure Data Studio download page in the Azure Data Studio documentation.
-
{% data variables.product.prodname_copilot %} extension for Azure Data Studio. To use {% data variables.product.prodname_copilot %} in Azure Data Studio, you must install the {% data variables.product.prodname_copilot %} extension. For more information, see AUTOTITLE.
{% data variables.product.prodname_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, {% data variables.product.prodname_copilot_short %} 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{% data variables.product.prodname_copilot %} will automatically suggest a join condition in grayed text. The exact suggestion may vary. {% data reusables.copilot.accept-suggestion %}
You can also describe something you want to do using natural language within a comment, and {% data variables.product.prodname_copilot_short %} will suggest the code to accomplish your goal. For example, type this comment in a SQL file:
SELECT TokenColor, COUNT(UserID) AS UserCount
FROM Tag.Users
GROUP BY TokenColor
-- pivot that query on tokencolor for Purple, Blue, Green, Yellow, Orange, Red
-- and rename the columns to match the colors
SELECT [Purple], [Blue], [Green], [Yellow], [Orange], [Red]{% data variables.product.prodname_copilot %} will automatically suggest code. {% data reusables.copilot.accept-suggestion %}
Tip
If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information on duplication detection, see AUTOTITLE.
For some suggestions, {% data variables.product.prodname_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{% data variables.product.prodname_copilot %} will show you a suggestion.
Now hover over the suggestion to show the {% data variables.product.prodname_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:
| OS | See next suggestion | See previous suggestion |
|---|---|---|
| macOS | Option+[ | Option+] |
| Windows or Linux | Alt+[ | Alt+] |
To accept a suggestion, click "Accept" in the {% data variables.product.prodname_copilot_short %} control, or press Tab. To reject all suggestions, press Esc.
If you don't want to accept an entire suggestion from {% data variables.product.prodname_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{% data variables.product.prodname_copilot %} will show you a suggestion in grayed text. The exact suggestion may vary.
Now hover over the suggestion to show the {% data variables.product.prodname_copilot %} control for choosing suggestions. To accept only the next word of the suggestion, click Accept Word in the control.
Alternatively, you can use a keyboard shortcut to accept the next word of a suggestion:
| OS | Accept Next Word |
|---|---|
| macOS | Command+→ |
| Windows or Linux | Control+→ |
If you want to accept the next line of the suggestion, you will need to set a custom keyboard shortcut for the command editor.action.inlineSuggest.acceptNextLine. For more information on setting custom keyboard shortcuts, see Keyboard shortcuts in Azure Data Studio in the Microsoft documentation.
{% endazure_data_studio %}
{% xcode %}
This guide demonstrates how to get coding suggestions from {% data variables.product.prodname_copilot %} in Xcode. To see instructions for other popular coding environments, use the tool switcher at the top of the page.
To use {% data variables.product.prodname_copilot %} for Xcode, you must install the {% data variables.product.prodname_copilot %} for Xcode extension. See AUTOTITLE.
{% data variables.product.prodname_copilot %} offers coding suggestions as you type. For example, type this function signature in a Swift file:
func calculateDaysBetweenDates({% data variables.product.prodname_copilot %} will automatically suggest an entire function body in grayed text. To accept the first line of a suggestion, press Tab. To view the full suggestion, hold Option, and to accept the full suggestion, press Option+Tab.
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 {% data variables.product.prodname_copilot_short %}: If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information on duplication detection, see AUTOTITLE.
- Check for updates and restart Xcode: Ensure you have the latest version of {% data variables.product.prodname_copilot_short %} for Xcode in the extension application and restart Xcode.
You can also open an issue in the {% data variables.product.prodname_copilot_short %} for Xcode repository.
{% endxcode %}
{% eclipse %}
{% data reusables.copilot.eclipse-public-preview-note %}
This guide demonstrates how to get coding suggestions from {% data variables.product.prodname_copilot %} in Eclipse. To see instructions for other popular coding environments, use the tool switcher at the top of the page.
To use {% data variables.product.prodname_copilot %} in Eclipse, you must install the {% data variables.product.prodname_copilot %} extension. See AUTOTITLE.
{% data variables.product.prodname_copilot %} offers coding suggestions as you type. For example, type this function header in a Java file:
public int getDiff(int a, int b){% data variables.product.prodname_copilot %} will automatically suggest the rest of the function. {% data reusables.copilot.accept-suggestion %} To discard the suggestion, press Esc.
You can also describe something you want to do using natural language within a comment, and {% data variables.product.prodname_copilot_short %} will suggest the code to accomplish your goal. For example, type this comment in a Java file:
/*
* Return the difference between two different integers.
*/{% data variables.product.prodname_copilot %} will automatically suggest code.
Tip
If you receive limited or no suggestions from {% data variables.product.prodname_copilot_short %}, you may have duplication detection enabled. For more information about duplication detection, see AUTOTITLE.
You can also use keyboard shortcuts to trigger code completion.
| OS | Trigger code completion |
|---|---|
| macOS | Option+Command+/ |
| Windows or Linux | Ctrl+Alt+/ |
If you don't want to accept an entire suggestion from {% data variables.product.prodname_copilot_short %}, you can accept the next word of a suggestion.
| OS | Accept next word |
|---|---|
| macOS | Command+→ |
| Windows or Linux | Ctrl+→ |
{% endeclipse %}
- Learn how to write effective prompts - See AUTOTITLE.
- Configure {% data variables.product.prodname_copilot_short %} in your editor - You can enable or disable {% data variables.product.prodname_copilot %} from within your editor, and create your own preferred keyboard shortcuts for {% data variables.product.prodname_copilot_short %}. See AUTOTITLE.
- Get started with {% data variables.product.prodname_copilot_chat %} - Learn how to ask {% data variables.product.prodname_copilot_short %} for information and assistance, using {% data variables.product.prodname_copilot_chat %}. See AUTOTITLE{% ifversion ghec %} and AUTOTITLE{% endif %}.
- Troubleshoot issues - Learn more about how to troubleshoot common issues with {% data variables.product.prodname_copilot %}. See AUTOTITLE.