GitHub Copilot の設定、構成、トラブルシューティング

  • 7 分

このユニットでは、GitHub Copilot にサインアップする方法、VS Code を使って GitHub Copilot を構成する方法、VS Code を使って GitHub Copilot のトラブルシューティングを行う方法について説明します。

GitHub Copilot にサインアップする

GitHub Copilot を使い始める前に、自身のアカウント用の無料試用版またはサブスクリプションを設定する必要があります。

開始するには、GitHub のプロフィール写真を選び、[設定] を選択します。 Copilot は左のメニューの [コード、計画、自動化] にあります。

サインアップ後、お好みの環境用の拡張機能をインストールする必要があります。 GitHub Copilot では、GitHub.com (拡張機能は不要)、VS Code、Visual Studio、JetBrains IDE、Neovim が控えめな拡張機能としてサポートされています。

このモジュールでは、VS Code の拡張機能と構成のみを取り上げます。 次のユニットで完了する演習では、VS Code を使用します。

別の環境をお使いの場合は、このモジュールの最後にある「リファレンス」セクションで、他の環境を設定するための特定のリンクを見つけることができます。

VS Code の GitHub Copilot を構成する

GitHub Copilot 用 VS Code 拡張機能を追加する

  1. Visual Studio Marketplace で、GitHub Copilot 拡張機能のページに移動し、[インストール] を選択します。
  2. ポップアップ ダイアログで、VS Code を開くよう求められます。 [Open] を選択します。
  3. VS Code の[拡張機能: GitHub Copilot] タブで [インストール] を選択します。
  4. お使いの GitHub アカウントで VS Code を以前に承認していない場合は、VS Code で GitHub にサインインするように求められます。 [GitHub にサインイン] を選択します。

GitHub Copilot により、VS Code を使うときに入力したコードをオートコンプリートできます。 インストール後は、GitHub Copilot を有効または無効にしたり、VS Code 内で詳細設定を構成したりできます。

VS Code 内で GitHub Copilot を有効または無効にする

  1. VS Code ウィンドウの下部ペインで、状態アイコンを選択してから、[有効にする] または [無効にする] を選択します。

    Visual Studio Code 内の GitHub Copilot の状態アイコンのスクリーンショット。GitHub Copilot が有効になると、背景色がステータス バーの色と一致します。

  2. GitHub Copilot を無効にすると、補完機能の無効化をグローバルに行うか、現在編集しているファイルの言語に対して行うかを VS Code から尋ねられます。

    • GitHub Copilot の補完機能をグローバルに無効にするには、[Disable completions] (補完機能を無効にする) を選択します。
    • 指定した言語に対して GitHub Copilot の補完機能を無効にするには、[Disable completions for LANGUAGE] (言語に対して補完機能を無効にする) を選択します。

VS Code でインライン候補を有効または無効にする

  1. [ファイル] メニューで、[ユーザー設定]>[設定] を選びます。

    Visual Studio Code の [ファイル] メニューのスクリーンショット。[ユーザー設定] ドロップダウン サブメニューが開き、[設定] コマンドが選択されています。

  2. [設定] タブの左側のペインで、[拡張機能] を選択し、[GitHub Copilot] を選択します。

  3. [エディター: オートコンプリートを有効にする] の下にあるチェックボックスをオンまたはオフにして、インライン候補を有効または無効にします。

さらに、インライン候補を有効または無効にし、どの言語に対して GitHub Copilot を有効または無効にするかを指定することもできます。

VS Code で GitHub Copilot のトラブルシューティングを行う

VS Code では、接続の問題を診断するのにログ ファイルが役立ちます。 GitHub Copilot 拡張機能は、VS Code 拡張機能の標準的なログの場所にログ ファイルを格納します。 ログ ファイルは、コマンド パレットを開き、「開発者: ログ ファイルを開く」または「開発者: 拡張機能のログ フォルダーを開く」と入力することで見つかります。

まれに、エラーが通常の場所にログされない場合があります。 エラーが発生したのにログに何も出力されていない場合は、VS Code と拡張機能を実行しているプロセスからログを確認してみてください。 このプロセスを使うと、Electron ログを表示できます。 これらのログは、VS Code 内の [ヘルプ]>[開発者ツールの切り替え] を選択することで見つかります。

GitHub Copilot に接続するときに、ネットワーク制限、ファイアウォール、プロキシによって問題が発生する恐れがあります。 問題が発生した場合は、次の手順に従って新しいエディターを開き、関連する情報を自分で検査したり、サポート チームと共有したりできます。

  1. VS Code コマンド パレットを開き、

    • Mac の場合は、Shift+Command+P を使用します。
    • Windows または Linux の場合は、Ctrl+Shift+P を使用します。

  2. 「Diagnostics」と入力し、一覧から [GitHub Copilot: 診断情報の収集] を選択します。

他の環境でトラブルシューティングを行う方法についての詳細は、モジュールの最後にある「リファレンス」セクションを確認してください。