Getting started with GitHub Copilot

About GitHub Copilot and Visual Studio Code

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

If you use Visual Studio Code, you can view and incorporate suggestions from GitHub Copilot directly within the editor. This guide demonstrates how to use GitHub Copilot within Visual Studio Code for macOS, Windows, or Linux.

Prerequisites

• GitHub Copilot を使用するには、アクティブな GitHub Copilot サブスクリプションが必要です。 詳しくは、「GitHub Copilot の課金について」を参照してください。

• To use GitHub Copilot in Visual Studio Code, you must have Visual Studio Code installed. For more information, see the Visual Studio Code download page.

Installing the GitHub Copilot extension in Visual Studio Code

To use GitHub Copilot, you must first install the GitHub Copilot extension.

1. In the Visual Studio Code Marketplace, go to the GitHub Copilot extension page and click Install.

2. A popup will appear, asking to open Visual Studio Code. Click Open Visual Studio Code.

3. In the "Extension: GitHub Copilot" tab in Visual Studio Code, click Install.

4. If you have not previously authorized Visual Studio Code in your GitHub account, you will be prompted to sign in to GitHub in Visual Studio Code.

   • If you have previously authorized Visual Studio Code for your account on GitHub, GitHub Copilot will be automatically authorized.

   • If you don't get the prompt to authorize, click the bell icon in the bottom panel of the Visual Studio Code window.

     

5. In your browser, GitHub will request the necessary permissions for GitHub Copilot. To approve these permissions, click Authorize Visual Studio Code.

6. To confirm the authentication, in Visual Studio Code, in the "Visual Studio Code" dialog box, click Open.

Seeing your first suggestion

GitHub Copilot は、多数の言語とさまざまなフレームワークに対する候補を提示しますが、特に Python、JavaScript、TypeScript、Ruby、Go、C#、C++ に適しています。 GitHub Copilot は、データベースのクエリ生成にも役立ちます。 The following samples are in JavaScript, but other languages will work similarly.

1. Visual Studio Code で、新しい JavaScript ( *.js) のファイルを作成します。

2. In the JavaScript file, type the following function header. GitHub Copilot will automatically suggest an entire function body in grayed text, as shown below. The exact suggestion may vary.

   JavaScript

   function calculateDaysBetweenDates(begin, end) {
   

3. 候補を受け入れるには、Tab キーを押します。

Seeing alternative suggestions

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

1. Visual Studio Code で、新しい JavaScript ( *.js) のファイルを作成します。

2. In the JavaScript file, type the following function header. GitHub Copilot will show you a suggestion.

   JavaScript

   function calculateDaysBetweenDates(begin, end) {
   

3. 必要に応じて、使用可能な場合は、代替候補を表示できます。

   OS	See next suggestion	See previous suggestion
   macOS	Option (⌥) or Alt+]	Option (⌥) or Alt+[
   Windows	Alt+]	Alt+[
   Linux	Alt+]	Alt+[

4. Alternatively, you can hover over the suggestion to see the GitHub Copilot command palette for choosing suggestions.

5. 候補を受け入れるには、Tab キーを押します。すべての候補を拒否するには、Esc キーを押します。

Partially accepting suggestions

You may not want to accept an entire suggestion from GitHub Copilot. You can use keyboard shortcuts to accept either the next word of a suggestion, or the next line.

1. Visual Studio Code で、新しい JavaScript ( *.js) のファイルを作成します。

2. In the JavaScript file, type the following function header. GitHub Copilot will automatically suggest an entire function body in grayed text, as shown below. The exact suggestion may vary.

   JavaScript

   function calculateDaysBetweenDates(begin, end) {
   

3. If you want to accept only the next word of the suggestion, use one of the following keyboard shortcuts.

   OS	Accept Next Word
   macOS	Command+→
   Windows	Control+→
   Linux	Control+→

4. If you want to accept the next line of the 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 の構成."

5. Alternatively, you can hover over the suggestion to see the GitHub Copilot command palette for choosing suggestions.

Seeing multiple suggestions in a new tab

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

1. Visual Studio Code で、新しい JavaScript ( *.js) のファイルを作成します。

2. In the JavaScript file, type the following function header. GitHub Copilot will show you a suggestion.

   JavaScript

   function calculateDaysBetweenDates(begin, end) {
   

3. To open a new tab with multiple additional options, press Ctrl+Enter.

4. To accept a suggestion, above the suggestion, click Accept Solution. To reject all suggestions, close the tab.

Generating code suggestions from comments

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

1. Visual Studio Code で、新しい JavaScript ( *.js) のファイルを作成します。

2. In the JavaScript file, type the following comment. GitHub Copilot will suggest an implementation of the function.

   JavaScript

   // find all images without alternate text
   // and give them a red border
   function process() {
   

Using a framework

You can also use GitHub Copilot to generate suggestions for APIs and frameworks. The following example uses GitHub Copilot to create a simple Express server that returns the current time.

1. Visual Studio Code で、新しい JavaScript ( *.js) のファイルを作成します。

2. In the JavaScript file, type the following comment and then press Enter. GitHub Copilot will suggest an implementation of the Express app.

   JavaScript

   // Express server on port 3000
   

3. To accept each line, press Tab, then Enter.

4. Type the following comment and then press Enter. GitHub Copilot will suggest an implementation for the default handler.

   JavaScript

   // Return the current time
   

5. To accept each line, press Tab.

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

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

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

   

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

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