GitHub Copilot と JetBrains IDE について
GitHub Copilot では、コーディング時に AI ペア プログラマーからオートコンプリート スタイルの候補が提示されます。 詳しくは、「GitHub Copilot for Individuals について」をご覧ください。
JetBrains IDE を使用すると、GitHub Copilot からの候補をエディター内で直接表示し、取り入れることができます。 このガイドでは、macOS、Windows、or Linux 用の JetBrains IDE 内で GitHub Copilot を使用する方法を示します。
前提条件
-
GitHub Copilot を使用するには、アクティブな GitHub Copilot サブスクリプションが必要です。 詳しくは、「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 にインストールする場合、手順が異なる可能性があります。
-
JetBrains IDE の [ファイル] メニュー (Windows の場合) または IDE for Mac の名前 (たとえば、PyCharm、IntelliJなど) で、 [設定] (Windows の場合) または [環境設定] (Mac の場合) をクリックします。
-
[設定] または [環境設定] ダイアログ ボックスの左側のメニューで、 [プラグイン] をクリックします。
-
[設定] または [環境設定] ダイアログ ボックスの上部にある [Marketplace] をクリックします。 検索バーで、「 GitHub Copilot 」を検索し、 [インストール] をクリックします。
-
GitHub Copilot がインストールされたら、 [IDE を再起動する] をクリックします。
-
JetBrains IDE が再起動したら、 [ツール] メニューをクリックします。 [GitHub Copilot] 、 [GitHub にログイン] の順にクリックします。
-
デバイス コードをコピーしてデバイスの有効化ウィンドウを開くには、[GitHub にサインイン] ダイアログ ボックスで、 [コピーして開く] をクリックします。
-
ブラウザーにデバイスのアクティブ化ウィンドウが表示されます。 デバイス コードを貼り付け、 [続行] をクリックします。
-
GitHub から、GitHub Copilot に必要なアクセス許可が要求されます。 これらのアクセス許可を承認するには、 [GitHub Copilot プラグインの承認] をクリックします。
-
アクセス許可が承認されたら、JetBrains IDE によって確認が表示されます。 GitHub Copilot の使用を開始するには、 [OK] をクリックします。
最初の候補を表示する
注: GitHub Copilot の重複検出を有効にしている場合、用意されているコード例を使うと、受け取る提案数が少ない場合、または提案がまったくない場合があります。 または、自作のコードを入力して GitHub Copilot からの提案を確認することから始めることもできます。 重複検出の詳細については、「GitHub.com での GitHub Copilot 設定の構成」を参照してください。
GitHub Copilot は、多数の言語とさまざまなフレームワークに対する候補を提示しますが、特に Python、JavaScript、TypeScript、Ruby、Go、C#、C++ に適しています。 GitHub Copilot は、データベースのクエリ生成にも役立ちます。 次のサンプルは Java で記述されていますが、他の言語も同様に動作します。
- JetBrains IDE で、新しい Java ( *.java) のファイルを作成します。
- Java ファイルで、「
class Test
」と入力してクラスを作成します。 GitHub Copilot によって、クラス本文の候補が灰色のテキストで自動的に表示されます。 実際に表示される候補はこのとおりではない場合があります。 - 候補を受け入れるには、Tab キーを押します。
- 関数本文の候補を表示するように GitHub Copilot に要求するには、
main
関数の角かっこの下に次の行を入力します。 実際に表示される候補はこのとおりではない場合があります。Java int calculateDaysBetweenDates(
int calculateDaysBetweenDates(
- 候補を受け入れるには、Tab キーを押します。
GitHub Copilot は、コードのコンテキストとスタイルの一致を試みます。 提案されたコードはいつでも編集できます。
代替候補の表示
特定の入力に対して、GitHub Copilot が複数の候補を提示することがあります。 使う候補を選択するか、すべての候補を拒否できます。
-
JetBrains IDE で、新しい Java ( *.java) のファイルを作成します。
-
候補を表示するように GitHub Copilot に要求するには、Java ファイルに次の行を入力します。
Java int calculateDaysBetweenDates(
int calculateDaysBetweenDates(
-
必要に応じて、使用可能な場合は、代替候補を表示できます。
OS 次の候補を表示 前の候補を表示 macOS Option+] Option+[ Windows Alt+] Alt+[ Linux Alt+] Alt+[ -
候補を受け入れるには、Tab キーを押します。すべての候補を拒否するには、Esc キーを押します。
新しいタブに複数の候補を表示する
GitHub Copilot が提示する最初の候補はどれも必要ないかもしれません。 キーボード ショートカットを使って、GitHub Copilot で新しいタブに複数の候補を表示するように指示できます。
-
JetBrains IDE で、新しい Java ( *.java) のファイルを作成します。
-
候補を表示するように GitHub Copilot に要求するには、Java ファイルに次の行を入力します。
Java int calculateDaysBetweenDates(
int calculateDaysBetweenDates(
-
複数の追加候補を表示した新しいタブが開きます。
- macOS では、Command+Shift+Aキーを押して [GitHub Copilot を開く] をクリックするか、Command+Shift+</kbd> キーを押して新しいタブをすぐに開きます。
- Windows または Linux では、Ctrl+Enter キーを押して、 [GitHub Copilot を開く] をクリックします。
-
候補を受け入れるには、候補の上にある [ソリューションの受入] をクリックします。 すべての候補を拒否するには、タブを閉じます。
コメントからコード候補を生成する
コメント内で自然言語を使用して実行する操作を記述できます。GitHub Copilot では、目標を達成するためのコードの候補が示されます。
-
JetBrains IDE で、新しい Java ( *.java) のファイルを作成します。
-
Java ファイル内の関数の実装を提案するように GitHub Copilot に要求するには、次の行を入力します。
Java // 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 の有効化と無効化
すべての言語、または個々の言語の GitHub Copilot を有効または無効にすることができます。 JetBrains IDE ウィンドウの下部パネルにある GitHub Copilot 状態アイコンは、GitHub Copilot が有効であるか、または無効であるかを示します。 有効の場合、アイコンが強調表示されます。 無効の場合、アイコンは淡色表示されます。
-
GitHub Copilot を有効または無効にするには、JetBrains ウィンドウの下部パネルにある状態アイコンをクリックします。
-
GitHub Copilot を無効にする場合、グローバルに無効にするか、または現在編集しているファイルの言語に対して無効にするかを確認されます。
- GitHub Copilot からの候補をグローバルに無効にするには、 [入力候補を無効にする] をクリックします。
- 指定した言語に対して GitHub Copilot からの候補を無効にするには、 ["言語" の入力候補を無効にする] をクリックします。
参考資料
Visual Studio と GitHub Copilot について
GitHub Copilot では、コーディング時に AI ペア プログラマーからオートコンプリート スタイルの候補が提示されます。 詳しくは、「GitHub Copilot for Individuals について」をご覧ください。
Visual Studio を使うと、エディター内に GitHub Copilot による候補が直接表示されるので、取り入れることができます。 このガイドでは、Visual Studio for Windows 内で GitHub Copilot を使う方法について説明します。
前提条件
-
GitHub Copilot を使用するには、アクティブな GitHub Copilot サブスクリプションが必要です。 詳しくは、「GitHub Copilot の課金について」を参照してください。
-
Visual Studio で GitHub Copilot を使うには、Visual Studio 2022 17.6 以降がインストールされている必要があります。 詳しい情報については、Visual Studio IDE のドキュメントをご覧ください。
注: GitHub Copilot は現在、Visual Studio for Mac で使うことはできません。
Visual Studio 拡張機能をインストールする
GitHub Copilot を使うには、最初に Visual Studio 拡張機能をインストールする必要があります。
-
Visual Studio のメニュー バーの [拡張機能] をクリックしてから、 [拡張機能の管理] をクリックします。
-
[拡張機能の管理] ウィンドウで、Visual Studio Marketplace をクリックし、GitHub Copilot 拡張機能を検索して、 [ダウンロード] をクリックします。
-
[拡張機能の管理] ウィンドウを閉じ、Visual Studio を終了してもう一度起動します。
-
必要に応じて、GitHub Copilot がインストールされ、有効になっていることを確認するには、 [拡張機能の管理] に戻り、 [インストール済み] をクリックして現在インストールされている拡張機能を表示し、 GitHub Copilot をクリックして状態情報を表示します。
-
Visual Studio で新しいプロジェクトを開くか、作成します。
-
デバイスのアクティブ化コードをコピーするには、[Microsoft Visual Studio] ダイアログ ボックスの [OK] をクリックします。
-
ブラウザーにデバイスのアクティブ化ウィンドウが表示されます。 デバイス コードを貼り付け、 [続行] をクリックします。
-
GitHub から、GitHub Copilot に必要なアクセス許可が要求されます。 これらのアクセス許可を承認するには、 [GitHub Copilot プラグインの認可] をクリックします。
-
アクセス許可を承認すると、Visual Studio に確認が表示されます。
最初の候補を表示する
注: GitHub Copilot の重複検出を有効にしている場合、用意されているコード例を使うと、受け取る提案数が少ない場合、または提案がまったくない場合があります。 または、自作のコードを入力して GitHub Copilot からの提案を確認することから始めることもできます。 重複検出の詳細については、「GitHub.com での GitHub Copilot 設定の構成」を参照してください。
-
Visual Studio で、新しい C# ( *.cs) ファイルを作成します。
-
C# ファイルに、次の関数シグネチャを入力します。 次に示すように、GitHub Copilot による関数本体全体の候補が自動的に灰色のテキストで表示されます。 実際に表示される候補はこのとおりではない場合があります。
C# int CalculateDaysBetweenDates(
int CalculateDaysBetweenDates(
-
候補を受け入れるには、Tab キーを押します。
代替候補を表示する
特定の入力に対して、GitHub Copilot が複数の候補を提示することがあります。 使う候補を選択するか、すべての候補を拒否できます。
-
Visual Studio で、新しい C# ( *.cs) ファイルを作成します。
-
C# ファイルに、次の関数シグネチャを入力します。 GitHub Copilot による候補が表示されます。
C# int CalculateDaysBetweenDates(
int CalculateDaysBetweenDates(
-
代替候補が利用可能な場合、これらの代替候補は、Alt + . (または Alt + ,) キーを押して表示できます。
-
必要に応じて、候補の上にマウス ポインターを置くと、候補を選べるように GitHub Copilot コマンド パレットが表示されます。
-
候補を受け入れるには、Tab キーを押します。すべての候補を拒否するには、Esc キーを押します。
コメントからコード候補を生成する
コメント内で自然言語を使用して実行する操作を記述できます。GitHub Copilot では、目標を達成するためのコードの候補が示されます。
-
Visual Studio で、新しい C# ( *.cs) ファイルを作成します。
-
C# ファイルに、次のコメントを入力します。 GitHub Copilot による関数の実装の候補が表示されます。
C# using System.Xml.Linq; var doc = XDocument.Load("index.xhml"); // find all images
using System.Xml.Linq; var doc = XDocument.Load("index.xhml"); // find all images
-
候補を受け入れるには、Tab キーを押します。
GitHub Copilot の有効化または無効化
Visual Studio ウィンドウの下部パネルにある GitHub Copilot 状態アイコンは、GitHub Copilot が有効であるか無効であるかを示します。 有効にすると、アイコンの背景色はステータス バーの色と一致します。 無効にすると、異なるものになります。
-
GitHub Copilot を有効または無効にするには、Visual Studio ウィンドウの下部パネルにある GitHub Copilot アイコンをクリックします。
-
GitHub Copilot を無効にする場合は、候補をグローバルに無効にするか、現在編集中のファイルの言語に対して無効にするかを確認するメッセージが表示されます。
- GitHub Copilot からの候補をグローバルに無効にするには、 [グローバルに有効にする] をクリックします。
- 指定された言語に対して GitHub Copilot からの候補を無効にするには、 [言語に対して有効にする] をクリックします。
参考資料
GitHub Copilot と Visual Studio Code について
GitHub Copilot では、コーディング時に AI ペア プログラマーからオートコンプリート スタイルの候補が提示されます。 詳しくは、「GitHub Copilot for Individuals について」をご覧ください。
Visual Studio Code を使う場合、エディター内に GitHub Copilot の候補を直接表示し、取り入れることができます。 このガイドでは、macOS、Windows、Linux 用の Visual Studio Code 内で GitHub Copilot を使う方法について説明します。
前提条件
-
GitHub Copilot を使用するには、アクティブな GitHub Copilot サブスクリプションが必要です。 詳しくは、「GitHub Copilot の課金について」を参照してください。
-
Visual Studio Code で GitHub Copilot を使うには、Visual Studio Code がインストールされている必要があります。 詳細については、Visual Studio Code のダウンロード ページを参照してください。
Visual Studio Code 拡張機能をインストールする
GitHub Copilot を使うには、最初に Visual Studio Code 拡張機能をインストールする必要があります。
-
Visual Studio Code Marketplace で、GitHub Copilot 拡張機能ページに移動し、 [インストール] をクリックします。
-
ポップアップが表示され、Visual Studio Code を開くように求められます。 [Open Visual Studio Code] をクリックします。
-
Visual Studio Code の [Extension: GitHub Copilot] タブの Install をクリックします。
-
GitHub アカウントで Visual Studio Code を以前に認可していない場合は、Visual Studio Code で GitHub にサインインするように求められます。
-
GitHub のアカウントで Visual Studio Code を以前に認可している場合は、GitHub Copilot は自動的に認可されます。
-
認可のプロンプトが表示されない場合は、Visual Studio Code ウィンドウの下部パネルにあるベル アイコンをクリックします。
-
-
ブラウザーで、GitHub から、GitHub Copilot に必要なアクセス許可が要求されます。 これらのアクセス許可を承認するには、 [Visual Studio Code の認可] をクリックします。
-
認証を確認するには、Visual Studio Code の [Visual Studio Code] ダイアログ ボックスで、 [開く] をクリックします。
最初の候補を表示する
注: GitHub Copilot の重複検出を有効にしている場合、用意されているコード例を使うと、受け取る提案数が少ない場合、または提案がまったくない場合があります。 または、自作のコードを入力して GitHub Copilot からの提案を確認することから始めることもできます。 重複検出の詳細については、「GitHub.com での GitHub Copilot 設定の構成」を参照してください。
GitHub Copilot は、多数の言語とさまざまなフレームワークに対する候補を提示しますが、特に Python、JavaScript、TypeScript、Ruby、Go、C#、C++ に適しています。 GitHub Copilot は、データベースのクエリ生成にも役立ちます。 次のサンプルは JavaScript で記述されていますが、他の言語も同様に動作します。
-
Visual Studio Code で、新しい JavaScript ( *.js) のファイルを作成します。
-
JavaScript ファイルで、次の関数ヘッダーを入力します。 次に示すように、GitHub Copilot から自動的に関数本文全体の候補が灰色のテキストで表示されます。 実際に表示される候補はこのとおりではない場合があります。
JavaScript function calculateDaysBetweenDates(begin, end) {
function calculateDaysBetweenDates(begin, end) {
-
候補を受け入れるには、Tab キーを押します。
代替候補の表示
特定の入力に対して、GitHub Copilot が複数の候補を提示することがあります。 使う候補を選択するか、すべての候補を拒否できます。
-
Visual Studio Code で、新しい JavaScript ( *.js) のファイルを作成します。
-
JavaScript ファイルで、次の関数ヘッダーを入力します。 GitHub Copilot による候補が表示されます。
JavaScript function calculateDaysBetweenDates(begin, end) {
function calculateDaysBetweenDates(begin, end) {
-
必要に応じて、使用可能な場合は、代替候補を表示できます。
OS 次の候補を表示 前の候補を表示 macOS Option (⌥) または Alt+] Option (⌥) または Alt+[ Windows Alt+] Alt+[ Linux Alt+] Alt+[ -
または、候補の上にマウス ポインターを置くと、候補を選択するためのGitHub Copilot コマンド パレットが表示されます。
-
候補を受け入れるには、Tab キーを押します。すべての候補を拒否するには、Esc キーを押します。
新しいタブに複数の候補を表示する
GitHub Copilot が提示する最初の候補はどれも必要ないかもしれません。 キーボード ショートカットを使って、GitHub Copilot で新しいタブに複数の候補を表示するように指示できます。
-
Visual Studio Code で、新しい JavaScript ( *.js) のファイルを作成します。
-
JavaScript ファイルで、次の関数ヘッダーを入力します。 GitHub Copilot による候補が表示されます。
JavaScript function calculateDaysBetweenDates(begin, end) {
function calculateDaysBetweenDates(begin, end) {
-
複数の追加オプションを含む新しいタブを開くには、Ctrl+Enter キーを押します。
-
候補を受け入れるには、候補の上にある Accept Solution をクリックします。 すべての候補を拒否するには、タブを閉じます。
コメントからコード候補を生成する
コメント内で自然言語を使用して実行する操作を記述できます。GitHub Copilot では、目標を達成するためのコードの候補が示されます。
-
Visual Studio Code で、新しい JavaScript ( *.js) のファイルを作成します。
-
JavaScript ファイルで、次のコメントを入力します。 GitHub Copilot による関数の実装の候補が表示されます。
JavaScript // find all images without alternate text // and give them a red border function process() {
// find all images without alternate text // and give them a red border function process() {
フレームワークの使用
GitHub Copilot を使うと、API やフレームワークの候補を生成することもできます。 次の例では、GitHub Copilot を使って、現在の時刻を返す単純な Express サーバーを作成しています。
-
Visual Studio Code で、新しい JavaScript ( *.js) のファイルを作成します。
-
JavaScript ファイルで、次のコメントを入力し、Enter キーを押します。 GitHub Copilot による Express アプリの実装の候補が表示されます。
JavaScript // Express server on port 3000
// Express server on port 3000
-
各行を受け入れるには、Tab キーを押し、それから Enter キーを押します。
-
次のコメントを入力して、Enter キーを押します。 GitHub Copilot により、デフォルトのハンドラーの実装が推奨されます。
JavaScript // Return the current time
// Return the current time
-
各行を受け入れるには、Tab キーを押します。
GitHub Copilot の有効化または無効化
Visual Studio Code 内から GitHub Copilot を有効または無効にすることができます。 Visual Studio Code ウィンドウの下部パネルにある GitHub Copilot 状態アイコンは、GitHub Copilot が有効であるか無効であるかを示します。 有効にすると、アイコンの背景色はステータス バーの色と一致します。 無効にすると、アイコンの背景色はステータス バーの色と異なります。
-
GitHub Copilot を有効または無効にするには、Visual Studio Code ウィンドウの下部パネルにある状態アイコンをクリックします。
-
GitHub Copilot を無効にする場合は、候補をグローバルに無効にするか、現在編集中のファイルの言語に対して無効にするかを確認するメッセージが表示されます。
- GitHub Copilot からの候補をグローバルに無効にするには、 [グローバルに無効にする] をクリックします。
- 指定された言語に対して GitHub Copilot からの候補を無効にするには、 [言語に対して無効にする] をクリックします。
参考資料
GitHub Copilot と Vim/Neovim について
GitHub Copilot では、コーディング時に AI ペア プログラマーからオートコンプリート スタイルの候補が提示されます。 詳しくは、「GitHub Copilot for Individuals について」をご覧ください。
Vim/Neovim を使用すると、GitHub Copilot からの候補をエディター内で直接表示し、取り入れることができます。
前提条件
-
GitHub Copilot を使用するには、アクティブな GitHub Copilot サブスクリプションが必要です。 詳しくは、「GitHub Copilot の課金について」を参照してください。
-
Vim/Neovim で GitHub Copilot を使うには、Vim バージョン 9.0.0185 / Neovim バージョン 0.6 以降と Node.js バージョン 17 以降をインストールする必要があります。 詳細については、Vim / Neovim のドキュメントと Node.js の Web サイトを参照してください。
macOS への Vim/Neovim 拡張機能のインストール
-
GitHub は、Vim/Neovim の組み込みプラグイン マネージャーを使って GitHub Copilot プラグインをインストールすることをお勧めします。 または、任意のプラグイン マネージャーを使って
github/copilot.vim
をインストールすることもできます。-
Vim の組み込みプラグイン マネージャーを使って GitHub Copilot をインストールするには、ターミナルで次のコマンドを入力します。
git clone https://github.com/github/copilot.vim \ ~/.vim/pack/github/start/copilot.vim
-
Neovim の組み込みプラグイン マネージャーを使って GitHub Copilot をインストールするには、ターミナルで次のコマンドを入力します。
git clone https://github.com/github/copilot.vim \ ~/.config/nvim/pack/github/start/copilot.vim
-
-
GitHub Copilot を構成するには、Vim または Neovim を開き、次のコマンドを入力します。
:Copilot setup
-
Vim または Neovim の構成で、または Vim または Neovim コマンドを使って GitHub Copilot を有効にします。
:Copilot enable
Windows への Vim/Neovim 拡張機能のインストール
-
GitHub は、Vim/Neovim の組み込みプラグイン マネージャーを使って GitHub Copilot プラグインをインストールすることをお勧めします。 または、任意のプラグイン マネージャーを使って
github/copilot.vim
をインストールすることもできます。-
Vim の組み込みプラグイン マネージャーを使って GitHub Copilot をインストールするには、Git Bash で次のコマンドを入力します。
git clone https://github.com/github/copilot.vim.git \ $HOME/vimfiles/pack/github/start/copilot.vim
-
Neovim の組み込みプラグイン マネージャーを使って GitHub Copilot をインストールするには、Git Bash で次のコマンドを入力します。
git clone https://github.com/github/copilot.vim.git \ $HOME/AppData/Local/nvim/pack/github/start/copilot.vim
-
-
GitHub Copilot を構成するには、Vim または Neovim を開き、次のコマンドを入力します。
:Copilot setup
-
Vim または Neovim の構成で、または Vim または Neovim コマンドを使って GitHub Copilot を有効にします。
:Copilot enable
Linux での Vim/Neovim 拡張機能のインストール
-
GitHub は、Vim/Neovim の組み込みプラグイン マネージャーを使って GitHub Copilot プラグインをインストールすることをお勧めします。 または、任意のプラグイン マネージャーを使って
github/copilot.vim
をインストールすることもできます。-
Vim の組み込みプラグイン マネージャーを使って GitHub Copilot をインストールするには、次のコマンドを入力します。
git clone https://github.com/github/copilot.vim \ ~/.vim/pack/github/start/copilot.vim
-
Neovim の組み込みプラグイン マネージャーを使って GitHub Copilot をインストールするには、次のコマンドを入力します。
git clone https://github.com/github/copilot.vim \ ~/.config/nvim/pack/github/start/copilot.vim
-
-
GitHub Copilot を構成するには、Vim または Neovim を開き、次のコマンドを入力します。
:Copilot setup
-
Vim または Neovim の構成で、または Vim または Neovim コマンドを使って GitHub Copilot を有効にします。
:Copilot enable
Vim/Neovim で GitHub Copilot を使う方法を学習する
Vim/Neovim での GitHub Copilot の使用に関するガイダンスについては、プラグインのドキュメントを参照してください。 ドキュメントを表示するには、Vim/Neovim を開いて次のコマンドを実行します。
:help copilot