Getting code suggestions in your IDE with GitHub Copilot

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 は、データベースのクエリ生成や、API とフレームワークの候補の生成にも役立ちます。

Prerequisites

• Subscription to Copilot. To use GitHub Copilot in JetBrains, you must have an active GitHub Copilot subscription. 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 ゲスト
  • DataGrip
  • DataSpell
  • GoLand
  • JetBrains クライアント
  • MPS
  • PhpStorm
  • PyCharm (Professional、Community、Educational)
  • Rider
  • RubyMine
  • RustRover
  • WebStorm

  ダウンロードするには、JetBrains IDE のツール ファインダーを参照してください。

• GitHub Copilot プラグイン。 JetBrains Marketplace で「GitHub Copilot プラグイン」を確認してください。 インストール手順については、「環境へのGitHub Copilot 拡張機能のインストール」をご覧ください。

• JetBrains IDE で GitHub にログインします。 認証手順については、「環境へのGitHub Copilot 拡張機能のインストール」を参照してください。

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. 候補を受け入れるには、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. 候補を受け入れるには、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:

提案を受け入れるには、Copilot コマンド パレットで [承諾する] をクリックするか、Tab キーを押します。すべての提案を拒否するには、Esc キーを押します。

Showing multiple suggestions in a new tab

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 の構成."