Skip to main content

JetBrains IDE で GitHub Copilot の使用を開始する

GitHub Copilot を JetBrains IDE にインストールし、コメントやコードを記述するときに候補が表示されるようにする方法について説明します。

GitHub のお客様は、GitHub.com の個人アカウントで GitHub Copilot を利用できます。 Managed user accountsでは、GitHub Copilot を使うことができません。

確認が取れている学生、教師、およびパブリックのオープン ソース プロジェクトのメンテナンス担当者は、GitHub Copilot を無料で使うことができます。 学生、教師、または一般的なオープンソース プロジェクトのメンテナンス担当者ではない場合にも、1 回限りの 60 日間の試用版で GitHub Copilot を無料で試すことができます。 無料試用期間の後、継続して使うには有料サブスクリプションが必要になります。 詳しくは、「GitHub Copilot の課金について」をご覧ください。

GitHub Copilot と JetBrains IDE について

GitHub Copilot では、コーディング時に AI ペア プログラマーからオートコンプリート スタイルの候補が提示されます。 詳細については、「GitHub Copilot について」を参照してください。

JetBrains IDE を使用すると、GitHub Copilot からの候補をエディター内で直接表示し、取り入れることができます。 このガイドでは、macOS、Windows、or Linux 用の JetBrains IDE 内で GitHub Copilot を使用する方法を示します。

前提条件

JetBrains で GitHub Copilot を使用するには、互換性のある JetBrains IDE がインストールされている必要があります。 GitHub Copilot は、次の IDE と互換性があります。

  • IntelliJ IDEA (Ultimate、Community、Educational)
  • Android Studio
  • AppCode
  • CLion
  • Code With Me ゲスト
  • DataGrip
  • DataSpell
  • GoLand
  • JetBrains クライアント
  • MPS
  • PhpStorm
  • PyCharm (Professional、Community、Educational)
  • Rider
  • RubyMine
  • WebStorm

詳しくは、JetBrains IDE ツール ファインダーを参照してください。

JetBrains IDE での GitHub Copilot 拡張機能のインストール

JetBrains IDE で GitHub Copilot を使用するには、GitHub Copilot 拡張機能をインストールする必要があります。 次の手順では、GitHub Copilot プラグインを IntelliJ IDEA にインストールする手順について説明します。 サポートされている別の IDE にインストールする場合、手順が異なる可能性があります。

  1. JetBrains IDE の [ファイル] メニュー (Windows の場合) または IDE for Mac の名前 (たとえば、PyCharmIntelliJ など) で、 [設定] (Windows の場合) または [環境設定] (Mac の場合) をクリックします。

  2. [設定] または [環境設定] ダイアログ ボックスの左側のメニューで、 [プラグイン] をクリックします。

  3. [設定] または [環境設定] ダイアログ ボックスの上部にある [Marketplace] をクリックします。 検索バーで、「 GitHub Copilot 」を検索し、 [インストール] をクリックします。 Marketplace の検索のスクリーンショット

  4. GitHub Copilot がインストールされたら、 [IDE を再起動する] をクリックします。

  5. JetBrains IDE が再起動したら、 [ツール] メニューをクリックします。 [GitHub Copilot][GitHub にログイン] の順にクリックします。 JetBrains の [ツール] メニューのスクリーンショット

  6. デバイス コードをコピーしてデバイスの有効化ウィンドウを開くには、[GitHub にサインイン] ダイアログ ボックスで、 [コピーして開く] をクリックします。 デバイス コードの [コピーして開く] のスクリーンショット

  7. ブラウザーでデバイスの有効化ウィンドウが開きます。 デバイス コードを貼り付け、 [続行] をクリックします。

    • Windows または Linux でコードを貼り付けるには、Ctrl + v キーを押します。
    • macOS でコードを貼り付けるには、command + v キーを押します。
  8. GitHub から、GitHub Copilot に必要なアクセス許可が要求されます。 これらのアクセス許可を承認するには、 [GitHub Copilot プラグインの承認] をクリックします。

  9. アクセス許可が承認されたら、JetBrains IDE によって確認が表示されます。 GitHub Copilot の使用を開始するには、 [OK] をクリックします。 JetBrains IDE によるアクセス許可の確認のスクリーンショット

最初の候補を表示する

Note: If you have duplication detection enabled for GitHub Copilot, you may receive limited suggestions, or no suggestions, when using the code examples provided. As an alternative, you can start by typing your own code to see suggestions from GitHub Copilot. For more information on duplication detection, see "Enabling or disabling duplication detection."

GitHub Copilot は、多数の言語とさまざまなフレームワークに対する候補を提示しますが、特に Python、JavaScript、TypeScript、Ruby、Go、C#、C++ に適しています。 次のサンプルは Java で記述されていますが、他の言語も同様に動作します。

  1. JetBrains IDE で、新しい Java ( *.java) のファイルを作成します。

  2. Java ファイルで、「class Test」と入力してクラスを作成します。 GitHub Copilot によって、次に示すように、クラス本文の候補が灰色のテキストで自動的に表示されます。 実際に表示される候補はこのとおりではない場合があります。 Java クラス本文の候補のスクリーンショット 1. 候補を受け入れるには、Tab キーを押します。

  3. 関数本文の候補を表示するように GitHub Copilot に要求するには、main 関数の角かっこの下に次の行を入力します。 実際に表示される候補はこのとおりではない場合があります。

    Java
    int calculateDaysBetweenDates(

    Java 関数本文の候補のスクリーンショット 1. 候補を受け入れるには、Tab キーを押します。

GitHub Copilot は、コードのコンテキストとスタイルの一致を試みます。 提案されたコードはいつでも編集できます。

代替候補の表示

特定の入力に対して、GitHub Copilot が複数の候補を提示することがあります。 使う候補を選択するか、すべての候補を拒否できます。

  1. JetBrains IDE で、新しい Java ( *.java) のファイルを作成します。

  2. 候補を表示するように GitHub Copilot に要求するには、Java ファイルに次の行を入力します。

    Java
    int calculateDaysBetweenDates(
    ``` 1. 必要に応じて、使用可能な場合は、代替候補を表示できます。
    
    | OS | 次の候補を表示 | 前の候補を表示 |
    | :- | :- | :- |
    | macOS | <kbd>Option</kbd>+<kbd>]</kbd> | <kbd>Option</kbd>+<kbd>[</kbd> |
    | Windows | <kbd>Alt</kbd>+<kbd>]</kbd> | <kbd>Alt</kbd>+<kbd>[</kbd> |
    | Linux | <kbd>Alt</kbd>+<kbd>]</kbd> | <kbd>Alt</kbd>+<kbd>[</kbd> |
  3. 候補を受け入れるには、Tab キーを押します。すべての候補を拒否するには、Esc キーを押します。

新しいタブに複数の候補を表示する

GitHub Copilot が提示する最初の候補はどれも必要ないかもしれません。 キーボード ショートカットを使って、GitHub Copilot で新しいタブに複数の候補を表示するように指示できます。

  1. JetBrains IDE で、新しい Java ( *.java) のファイルを作成します。
  2. 候補を表示するように GitHub Copilot に要求するには、Java ファイルに次の行を入力します。
    Java
    int calculateDaysBetweenDates(
  3. 複数の追加候補を表示した新しいタブが開きます。
    • macOS では、Command+Shift+Aキーを押して [GitHub Copilot を開く] をクリックするか、Command+Shift+\ キーを押して新しいタブをすぐに開きます。
    • Windows または Linux では、Ctrl+Enter キーを押して、 [GitHub Copilot を開く] をクリックします。 Copilot を開くためのダイアログのスクリーンショット
  4. 候補を受け入れるには、候補の上にある [ソリューションの受入] をクリックします。 すべての候補を拒否するには、タブを閉じます。

コメントからコード候補を生成する

コメント内で自然言語を使用して実行する操作を記述できます。GitHub Copilot では、目標を達成するためのコードの候補が示されます。

  1. JetBrains IDE で、新しい Java ( *.java) のファイルを作成します。
  2. Java ファイル内の関数の実装を提案するように GitHub Copilot に要求するには、次の行を入力します。
    Java
    // find all images without alternate text
    // and give them a red border
    void process () {
    Java 関数本文の候補のスクリーンショット

GitHub Copilot の有効化と無効化

すべての言語、または個々の言語の GitHub Copilot を有効または無効にすることができます。 JetBrains IDE ウィンドウの下部パネルにある GitHub Copilot 状態アイコンは、GitHub Copilot が有効であるか、または無効であるかを示します。 有効の場合、アイコンが強調表示されます。 無効の場合、アイコンは淡色表示されます。

  1. GitHub Copilot を有効または無効にするには、JetBrains ウィンドウの下部パネルにある状態アイコンをクリックします。 IntelliJ IDEA の状態アイコンのスクリーンショット

  2. GitHub Copilot を無効にする場合、グローバルに無効にするか、または現在編集しているファイルの言語に対して無効にするかを確認されます。

    • GitHub Copilot からの候補をグローバルに無効にするには、 [入力候補を無効にする] をクリックします。
    • 指定した言語に対して GitHub Copilot からの候補を無効にするには、 ["言語" の入力候補を無効にする] をクリックします。 GitHub Copilot をグローバルに、または現在の言語に対して無効にするためのオプションのスクリーンショット

参考資料