Skip to main content

環境での GitHub Copilot の構成

サポートされている IDE で GitHub Copilot を有効化、構成、または無効化することができます。

この機能を使用できるユーザーについて

GitHub Copilot Individual、 GitHub Copilot Business、または GitHub Copilot Enterprise。

JetBrains IDE の GitHub Copilot について

JetBrains IDE を使う場合、GitHub Copilot は、入力時にコードをオートコンプリートできます。 インストール後、GitHub Copilot を有効または無効にしたり、IDE または GitHub.com で詳細設定を構成したりできます。 この記事では、IntelliJ IDE で GitHub Copilot を構成する方法について説明しますが、他の JetBrains IDE のユーザー インターフェイスは異なる場合があります。

前提条件

JetBrains IDE で GitHub Copilot を構成するには、GitHub Copilot プラグインをインストールする必要があります。 詳しくは、「エディターで GitHub Copilot コードの提案を使用する」を参照してください。

GitHub Copilot のキーボード ショートカットの使用または再バインド

GitHub Copilot を使う場合、JetBrains IDE のインライン候補には既定のキーボード ショートカットを使用できます。 また、特定のコマンドごとに、ショートカットを任意のキーボード ショートカットに再バインドすることもできます。 JetBrains IDE でキーボード ショートカットを再バインドする方法の詳細については、JetBrains のドキュメントを参照してください。 たとえば、IntelliJ IDEA のドキュメントなどがあります。

macOS のキーボード ショートカット

アクションショートカット
インライン候補を受け入れるタブ
インライン候補を無視するEsc
次のインライン候補を表示するOption (⌥) または Alt+]
前のインライン候補を表示するOption (⌥) または Alt+[
インライン候補をトリガーするOption (⌥)+\
GitHub Copilot を開く (別のペインに追加の候補)Option (⌥) または Alt+Return

Windows のキーボード ショートカット

アクションショートカット
インライン候補を受け入れるタブ
インライン候補を無視するEsc
次のインライン候補を表示するAlt+]
前のインライン候補を表示するAlt+[
インライン候補をトリガーするAlt+\
GitHub Copilot を開く (別のペインに追加の候補)Alt+Enter

Linux のキーボード ショートカット

アクションショートカット
インライン候補を受け入れるタブ
インライン候補を無視するEsc
次のインライン候補を表示するAlt+]
前のインライン候補を表示するAlt+[
インライン候補をトリガーするAlt+\
GitHub Copilot を開く (別のペインに追加の候補)Alt+Enter

GitHub Copilot の有効化または無効化

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

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

    JetBrains IDE の下部パネルのスクリーンショット。 GitHub Copilot の状態アイコンが濃いオレンジの枠線で囲まれています。

  2. GitHub Copilot を無効にする場合、グローバルに無効にするか、または現在編集しているファイルの言語に対して無効にするかを確認されます。 グローバルに無効にするには、 Disable Completions をクリックします。 または、言語固有のボタンをクリックして、指定された言語の GitHub Copilot を無効にします。

    GitHub Copilot をグローバルに、または JetBrains IDE の現在の言語に対して無効にするオプメニューのスクリーンショット。

GitHub Copilot の高度な構成を設定する

JetBrains IDE では、コードの入力候補の表示方法や、GitHub Copilotで有効にする言語、無効にする言語など、GitHub Copilot の詳細設定を管理できます。

  1. JetBrains IDE で、ファイル メニュー (Windows) またはメニュー バー (macOS) のアプリケーションの名前をクリックし、設定 をクリックします。
  2. Languages & Frameworks で、 [GitHub Copilot] をクリックします。
  3. 自分の好みに合わせて設定を編集します。
    • コード候補の動作と外観、および更新を自動的に確認するかどうかを調整するには、対応するチェックボックスを選択または選択解除してください。
    • 自動更新を受信するように選んだ場合、安定版の更新プログラム (ただし頻度は低い) か、または夜間版の更新プログラム (安定性が低い場合がある) を受け取るかを選択できます。 [Update channel](更新プログラム チャネル) ドロップダウンをクリックして、安定版の更新を受け取る場合は Stable を、夜間版の更新を受け取る場合は Nightly を選びます。

GitHub Copilot の言語構成を設定する

IDE またはファイルを編集して、GitHub Copilot をアクティブ化または非アクティブ化する言語を github-copilot.xml 指定できます。 IDE で言語設定を変更する場合は、アクティブ化または非アクティブ化する言語を個別に選択および選択解除できます。

ファイル内のgithub-copilot.xml言語設定を変更する場合は、個々の言語を指定するか、ワイルドカードを使用して、すべての言語の GitHub Copilot をアクティブ化または非アクティブ化できます。 また、例外を指定することもできます。これは、指定した言語の野生のカード設定をオーバーライドします。 たとえば、Python と YAML を除くすべての言語で GitHub Copilot を非アクティブ化できます。 既定では、GitHub Copilot 拡張機能をインストールすると、すべての言語で GitHub Copilot がアクティブになります。

IDE での言語設定の構成

  1. JetBrains IDE で、ファイル メニュー (Windows) またはメニュー バー (macOS) のアプリケーションの名前をクリックし、設定 をクリックします。
  2. Languages & Frameworks で、 [GitHub Copilot] をクリックします。
  3. [言語]で、GitHub Copilotをアクティブまたは非アクティブにしたい言語のチェックボックスを選択または選択解除します。
  4. 適用をクリックし、OK をクリックします。
  5. 変更を有効にするには、JetBrains IDEを再起動します。

github-copilot.xml ファイルの編集

github-copilot.xmlファイル内の言語設定を構成するには、languageAllowListを編集する必要があります。 languageAllowListに追加するすべての行には、エントリ キーと値が含まれている必要があります。 エントリ キーは言語の名前、または ワイルドカード (*) です。 値は true または false です。 値がtrueの場合、指定した言語に対してGitHub Copilotがアクティブ化されます。 値がfalseの場合、指定した言語に対してGitHub Copilotが非アクティブ化されます。

このファイルは、次のディレクトリに格納されます。

  • macOS: ~/Library/Application Support/JetBrains/<product><version>/options/github-copilot.xml
  • Windows: %APPDATA%\JetBrains\<product><version>\options\github-copilot.xml
  • Linux: ~/.config/JetBrains/<product><version>/options/github-copilot.xml

たとえば、macOS で IntelliJ IDEA 2021.1 を使用している場合、ファイルは~/Library/Application Support/JetBrains/IdeaIC2021.1/options/github-copilot.xmlにあります。

IDE の設定で既定の言語構成を変更するまで、github-copilot.xmlファイルは生成されない場合があります。 ファイルが見つからない場合は、IDE で既定の言語設定を変更してみてください。 詳細については、「IDE での言語設定の構成」を参照してください。

または、ファイルを手動で作成し、上記のオペレーティング システムの場所に保存することもできます。 詳細については、「言語設定の例」を参照してください。

  1. テキスト エディターで github-copilot.xml ファイルを開きます。

  2. <map>タグの間に、GitHub Copilot をアクティブ化または非アクティブ化する言語の行または行を追加します。 たとえば、すべての言語で GitHub Copilot を非アクティブ化するには、次のようにします。

    XML
    <entry key="*" value="false" />
    
  3. github-copilot.xml ファイルに加えた変更を保存します。

  4. 変更を有効にするには、JetBrains IDEを再起動します。

言語構成の例

すべての言語でGitHub Copilot を有効にする github-copilot.xml ファイルの既定の構成は次のとおりです。

XML
<application>
  <component name="github-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

すべての言語で GitHub Copilot を非アクティブ化するには、ワイルドカード (*)の値がfalseに変更されます。

XML
<application>
  <component name="github-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="false" />
      </map>
    </languageAllowList>
  </component>
</application>

言語を個別に指定するには、GitHub Copilot をアクティブ化または非アクティブ化する言語ごとにエントリを追加します。 特定の言語設定は、ワイルドカードをオーバーライドします。 たとえば、Python と YAML に対して GitHub Copilot をアクティブ化し、他のすべての言語で GitHub Copilot を非アクティブ化するには、次のエントリを追加します。

XML
<application>
  <component name="github-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="false" />
        <entry key="Python" value="true" />
        <entry key="YAML" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

IDE の設定で読み取り languageAllowList 専用にする構成を追加することもできます。 これにより、IDE の言語設定は変更できなくなります。 次に例を示します。

XML
<application>
  <component name="github-copilot">
    <option name="languageAllowListReadOnly" value="true" />
    <languageAllowList>
      <map>
        <entry key="*" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

GitHub Copilot の設定を GitHub.com

で構成する

GitHub Copilot Individual サブスクリプションを使用している場合は、一般公開されているコードに一致するコード補完候補を許可またはブロックすることができます。 これを設定するには、GitHub.com の個人用の設定を使用します。 「個人のサブスクライバーとしての Copilot ポリシーの管理」をご覧ください。

参考資料

Visual Studio の GitHub Copilot について

Visual Studio を使用する場合、GitHub Copilot では、入力時にコードをオートコンプリートできます。 インストール後、GitHub Copilot を有効または無効にしたり、Visual Studio または GitHub.com で詳細設定を構成したりできます。

前提条件

Visual Studio で GitHub Copilot を構成するには、GitHub Copilot プラグインをインストールする必要があります。 詳しくは、「エディターで GitHub Copilot コードの提案を使用する」を参照してください。

GitHub Copilot のキーボード ショートカットの使用または再バインド

GitHub Copilot を使用する場合は、Visual Studio の既定のキーボード ショートカットを使用できます。 または、特定のコマンドごとに任意のキーボード ショートカットを使用して、Visual Studio の [ツール] 設定でショートカットを再バインドすることもできます。 各キーボード ショートカットは、キーボード ショートカット エディターのコマンド名で検索できます。

既定のキーボード ショートカットの使用

アクションショートカット[コマンド名]
次のインライン候補を表示するAlt+.Edit.NextSuggestion
前のインライン候補を表示するAlt+,Edit.PreviousSuggestion
インライン候補をトリガーするCtrl+Alt+\Edit.Copilot.TriggerInlineSuggestion

キーボード ショートカットの再バインド

GitHub Copilot を使用するときに Visual Studio の既定のキーボード ショートカットを使用しない場合は、特定のコマンドごとに任意のキーボード ショートカットを使用してキーボード エディターでショートカットを再バインドできます。

  1. Visual Studio メニュー バーの [ツール] で、 [オプション] をクリックします。

    Visual Studio メニュー バーのスクリーンショット。 [ツール] メニューが展開され、[オプション] 項目がオレンジ色の枠線で強調表示されています。

  2. [オプション] ダイアログの [環境] で、 [キーボード] をクリックします。

  3. [以下の文字列を含むコマンドを表示] で、再バインドするコマンドを検索します。

    [以下の文字列を含むコマンドを表示] 検索バーのスクリーンショット。 検索フィールドに文字列 "tools.next" が入力されています。

  4. [ショートカット キー] で、コマンドに割り当てるショートカットを入力し、 [割り当て] をクリックします。

    新しいキーボード ショートカット割り当てを入力するためのフィールドのスクリーンショット。

GitHub Copilot の有効化または無効化

Visual Studio ウィンドウの下部パネルにある GitHub Copilot 状態アイコンは、GitHub Copilot が有効であるか無効であるかを示します。 有効にすると、アイコンの背景色はステータス バーの色と一致します。 無効にすると、異なるものになります。

  1. GitHub Copilot を有効または無効にするには、Visual Studio ウィンドウの下部パネルにある GitHub Copilot アイコンをクリックします。

    GitHub Copilot アイコンが強調された Visual Studio のエディターの余白のスクリーンショット。

  2. GitHub Copilot を無効にする場合は、候補をグローバルに無効にするか、現在編集中のファイルの言語に対して無効にするかを確認するメッセージが表示されます。

    • GitHub Copilot からの候補をグローバルに無効にするには、 [グローバルに有効にする] をクリックします。
    • 指定された言語に対して GitHub Copilot からの候補を無効にするには、 [言語に対して有効にする] をクリックします。

GitHub Copilot の ReSharper の構成

ReSharper を使用する場合、GitHub Copilot は、GitHub Copilot のネイティブ IntelliSense を使用するように ReSharper を構成すると最適に動作できます。 ReSharper について詳しくは、ReSharper のドキュメントを参照してください。

  1. Visual Studio のメニュー バーの [拡張機能] 内で、[ReSharper] をクリックして、続いて、[オプション] をクリックします。
  2. [オプション] ダイアログの [環境] で、 [IntelliSense] をクリックし、 [全般] をクリックします。
  3. [全般] で [Visual Studio] を選択してから、 [保存] をクリックします。

GitHub Copilot の設定を GitHub.com

で構成する

GitHub Copilot Individual サブスクリプションを使用している場合は、一般公開されているコードに一致するコード補完候補を許可またはブロックすることができます。 これを設定するには、GitHub.com の個人用の設定を使用します。 「個人のサブスクライバーとしての Copilot ポリシーの管理」をご覧ください。

参考資料

Visual Studio Code のGitHub Copilot について

Visual Studio Code を使用する場合、GitHub Copilot を使用して次のことができます。

  • コードを生成する
  • Copilot が生成するコードから学習する
  • エディターの構成に関するヘルプ

シナリオとセットアップの詳細については、VS Code のドキュメントを参照してください。

GitHub Copilot 拡張機能をインストールした後、それを有効または無効にしたり、Visual Studio Code 内または GitHub.com で詳細設定を構成したりできます。

前提条件

Visual Studio Code で GitHub Copilot を構成するには、GitHub Copilot 拡張機能をインストールする必要があります。 詳しくは、「エディターで GitHub Copilot コードの提案を使用する」を参照してください。

GitHub Copilot のキーボード ショートカット

GitHub Copilot で Visual Studio Code のデフォルトのキーボード ショートカットを使用できます。 キーボード ショートカット エディターでは、コマンド名でキーボード ショートカットを検索します。

また、キーボード ショートカットで、コマンドごとにショートカットを再バインドすることもできます。 キー バインドの詳細については、VS Code のドキュメントを参照してください。

macOS のキーボード ショートカット

アクションショートカット[コマンド名]
インライン候補を受け入れるタブeditor.action.inlineSuggest.commit
インライン候補を無視するEsceditor.action.inlineSuggest.hide
次のインライン候補を表示するOption (⌥)+]
editor.action.inlineSuggest.showNext
前のインライン候補を表示するOption (⌥)+[
editor.action.inlineSuggest.showPrevious
インライン候補をトリガーするOption (⌥)+\
editor.action.inlineSuggest.trigger
GitHub Copilot を開く (別のペインに追加の候補)Ctrl+Returngithub.copilot.generate
GitHub Copilot のオン/オフを切り替える"既定のショートカットなし"github.copilot.toggleCopilot

Windows のキーボード ショートカット

アクションショートカット[コマンド名]
インライン候補を受け入れるタブeditor.action.inlineSuggest.commit
インライン候補を無視するEsceditor.action.inlineSuggest.hide
次のインライン候補を表示するAlt+]editor.action.inlineSuggest.showNext
前のインライン候補を表示するAlt+[editor.action.inlineSuggest.showPrevious
インライン候補をトリガーするAlt+\editor.action.inlineSuggest.trigger
GitHub Copilot を開く (別のペインに追加の候補)Ctrl+Entergithub.copilot.generate
GitHub Copilot のオン/オフを切り替える"既定のショートカットなし"github.copilot.toggleCopilot

Linux のキーボード ショートカット

アクションショートカット[コマンド名]
インライン候補を受け入れるタブeditor.action.inlineSuggest.commit
インライン候補を無視するEsceditor.action.inlineSuggest.hide
次のインライン候補を表示するAlt+]editor.action.inlineSuggest.showNext
前のインライン候補を表示するAlt+[editor.action.inlineSuggest.showPrevious
インライン候補をトリガーするAlt+\editor.action.inlineSuggest.trigger
GitHub Copilot を開く (別のペインに追加の候補)Ctrl+Entergithub.copilot.generate
GitHub Copilot のオン/オフを切り替える"既定のショートカットなし"github.copilot.toggleCopilot

GitHub Copilot の有効化または無効化

Visual Studio Code 内から GitHub Copilot を有効または無効にすることができます。 Visual Studio Code ウィンドウの下部パネルにある GitHub Copilot 状態アイコンは、GitHub Copilot が有効であるか無効であるかを示します。 有効にすると、アイコンの背景色はステータス バーの色と一致します。 無効にすると、アイコンの背景色はステータス バーの色と異なります。

  1. GitHub Copilot を有効または無効にするには、Visual Studio Code ウィンドウの下部パネルにある状態アイコンをクリックします。

    Visual Studio Code の下部パネルのスクリーンショット。 GitHub Copilot アイコンが濃いオレンジ色の枠線で囲まれています。

  2. GitHub Copilot を無効にする場合は、候補をグローバルに無効にするか、現在編集中のファイルの言語に対して無効にするかを確認するメッセージが表示されます。

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

インライン候補の有効化または無効化

Visual Studio Code で GitHub Copilot のインライン候補を有効にするか無効にするかを選択できます。

  1. File メニューで Preferences に移動し、 Settings をクリックします。

    Visual Studio Code 設定のスクリーンショット。

  2. [設定] タブの左側のパネルで、 [拡張機能] をクリックし [Copilot] を選びます。

  3. [インライン候補:有効] の下にあるチェックボックスをオンまたはオフにして、インライン候補の有効または無効を設定します。

特定の言語に対する GitHub Copilot の有効化または無効化

どの言語に対して GitHub Copilot を有効にするか無効にするかを指定できます。

  1. Visual Studio Code から Extensions タブをクリックし、 [Copilot] セクションに移動します。 詳細については、「インライン候補の有効化または無効化」をご覧ください。

  2. [指定した言語に対して Copilot を有効または無効にする] で、 [settings.json で編集] をクリックします。

  3. settings.json ファイルで、GitHub Copilot を有効または無効にする言語を、追加または削除します。 たとえば、GitHub Copilotで Python を有効にするには、リストに "python": true を追加し、最後以外のすべてのリスト項目の末尾にコンマがあることを確認します。

    {
        "editor.inlineSuggest.enabled": true,
        "github.copilot.enable": {
            "*": true,
            "yaml": false,
            "plaintext": false,
            "markdown": true,
            "javascript": true,
            "python": true
        }
    }
    

GitHub Copilot 承認の取り消し

Visual Studio Code は、特定の GitHub アカウントを介して GitHub Copilot を使用するための承認を保持します。 アクセスできなくなったデバイスで GitHub アカウントが GitHub Copilot に使用されないようにするには、承認を取り消してから、もう一度承認プロセスを実行します。 以前に使用したデバイスには、新しい承認がありません。

  1. GitHub で、任意のページの右上隅にある自分のプロフィール写真をクリックしてから、 [設定] をクリックします。

  2. サイドバーの [統合] セクションで、[ アプリケーション] を選択します。

  3. [認可された OAuth アプリ] タブをクリックします。

    [アプリケーション] ページのスクリーンショット。 "認可された OAuth アプリ" というラベルの付いたタブが、オレンジ色の枠線で強調表示されています。

  4. [GitHub for VS Code] の横の [...] をクリックし、 [取り消し] をクリックします。

  5. [承認されている GitHub Apps] タブをクリックします。

  6. [GitHub Copilot] 拡張機能が一覧表示されている場合は、 [取り消し] をクリックします。

承認を取り消すと、Visual Studio Code は現在のセッションで最大 30 分間、GitHub Copilot を引き続き使用できるようになります。 その後、Visual Studio Code で使用するために GitHub Copilot をもう一度承認する必要があります。

GitHub Copilot の再承認

承認を取り消した後、GitHub Copilot を引き続き使用する場合は、再承認プロセスを完了する必要があります。

  1. Visual Studio Code の左下隅にある [アカウント] アイコンをクリックし、ユーザー名をポイントして、 [サインアウト] をクリックします。

    Visual Studio Code のメニューのスクリーンショット。 [サインアウト] オプションが濃いオレンジ色の枠線で囲まれています。

  2. [Visual Studio Code] ポップアップで、 [サインアウト] をクリックします。

  3. Visual Studio Code の左下隅にある [アカウント] アイコンをクリックし、ユーザー名をポイントし、 [GitHub でサインインして GitHub Copilot を使用] をクリックします。

    Visual Studio Code のアカウント メニューのスクリーンショット。 [GitHub でサインインして GitHub Copilot を使用 (1)] オプションが濃いオレンジ色の外枠で囲まれています。

  4. ブラウザーで、GitHub から、GitHub Copilot に必要なアクセス許可が要求されます。 これらのアクセス許可を承認するには、 [続行] をクリックします。

  5. [Visual Studio Code を開きますか?] ポップアップで、 [Visual Studio Code を開く] をクリックします。

GitHub Copilot の設定を GitHub.com

で構成する

GitHub Copilot Individual サブスクリプションを使用している場合は、一般公開されているコードに一致するコード補完候補を許可またはブロックすることができます。 これを設定するには、GitHub.com の個人用の設定を使用します。 「個人のサブスクライバーとしての Copilot ポリシーの管理」をご覧ください。

参考資料

Vim/Neovim での GitHub Copilot の構成

Vim/Neovim での GitHub Copilot の構成に関するガイダンスについては、次のコマンドを実行し、Vim/Neovim で GitHub Copilot ドキュメントを呼び出します。

:help copilot

キーボード ショートカットの再バインド

GitHub Copilot を使って、特定のコマンドごとに好みのキーボード ショートカットを使っているときは、Vim/Neovim でキーボード ショートカットを再バインドできます。 詳しくは、Neovim のドキュメントの記事「マップ」をご覧ください。

GitHub Copilot の設定を GitHub.com

で構成する

GitHub Copilot Individual サブスクリプションを使用している場合は、一般公開されているコードに一致するコード補完候補を許可またはブロックすることができます。 これを設定するには、GitHub.com の個人用の設定を使用します。 「個人のサブスクライバーとしての Copilot ポリシーの管理」をご覧ください。

参考資料