Using GitHub Copilot code suggestions in your editor

About GitHub Copilot and JetBrains IDEs

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. GitHub Copilot 为多种语言和各种框架提供建议，但尤其适用于 Python、JavaScript、TypeScript、Ruby、Go、C# 和 C++。 GitHub Copilot 还可以帮助生成数据库的查询。

Prerequisites

• Subscription to Copilot. To use GitHub Copilot in JetBrains, you must have an active GitHub Copilot subscription. - 若要使用 GitHub Copilot，必须拥有有效的 GitHub Copilot 订阅。 有关详细信息，请参阅“关于 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

  For more information, see the JetBrains IDEs tool finder.

• GitHub Copilot plugin for JetBrains. To use GitHub Copilot in JetBrains, you must install the GitHub Copilot plugin. For more information, see "Installing 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 typing class Test.

GitHub Copilot will automatically suggest a class body in grayed text. 1. 要接受建议，请按 Tab。

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 border
void process () {

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

GitHub Copilot will automatically suggest code. 1. 要接受建议，请按 Tab。

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

Showing alternative suggestions

对于任何给定的输入，GitHub Copilot 可以提供多个建议。 可以选择要使用的建议，或拒绝所有建议。

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

private int calculateDaysBetweenDates(Date date1,

private int calculateDaysBetweenDates(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:

1. 若要接受建议，请按 Tab。若要拒绝所有建议，请按 Esc。

Showing multiple suggestions in a new tab

你可能不想获得 GitHub Copilot 提供的任何初始建议。 可以使用键盘快捷方式来提示 GitHub Copilot 在新选项卡中显示多个建议。

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

private int calculateDaysBetweenDates(Date date1,

private int calculateDaysBetweenDates(Date date1,

GitHub Copilot will show you a suggestion.

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

To accept a suggestion, below the suggestion, click Accept 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,

private int calculateDaysBetweenDates(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, click Accept 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 command editor.action.inlineSuggest.acceptNextLine. For more information on setting custom keyboard shortcuts, see "在环境中配置 GitHub Copilot."