Getting started with GitHub Copilot

About GitHub Copilot and Visual Studio Code

GitHub Copilot provides autocomplete-style suggestions from an AI pair programmer as you code. For more information, see "About GitHub Copilot for 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

• To use GitHub Copilot you must have an active GitHub Copilot subscription. For more information, see "About billing for 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 Visual Studio Code extension

To use GitHub Copilot, you must first install the Visual Studio Code 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 provides suggestions for numerous languages and a wide variety of frameworks, but works especially well for Python, JavaScript, TypeScript, Ruby, Go, C# and C++. GitHub Copilot can also assist in query generation for databases. The following samples are in JavaScript, but other languages will work similarly.

1. In Visual Studio Code, create a new JavaScript (*.js) file.

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. To accept the suggestion, press Tab.

Seeing alternative suggestions

For any given input, GitHub Copilot may offer multiple suggestions. You can select which suggestion to use, or reject all suggestions.

1. In Visual Studio Code, create a new JavaScript (*.js) file.

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

   JavaScript

   function calculateDaysBetweenDates(begin, end) {
   

3. Optionally, you can see alternative suggestions, if any are available.

   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. To accept a suggestion, press Tab. To reject all suggestions, press Esc.

Seeing multiple suggestions in a new tab

You may not want any of the initial suggestions GitHub Copilot offers. You can use a keyboard shortcut to prompt GitHub Copilot to show you multiple suggestions in a new tab.

1. In Visual Studio Code, create a new JavaScript (*.js) file.

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

You can describe something you want to do using natural language within a comment, and GitHub Copilot will suggest the code to accomplish your goal.

1. In Visual Studio Code, create a new JavaScript (*.js) file.

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. In Visual Studio Code, create a new JavaScript (*.js) file.

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.

Enabling or disabling GitHub Copilot

You can enable or disable GitHub Copilot from within Visual Studio Code. The GitHub Copilot status icon in the bottom panel of the Visual Studio Code window indicates whether GitHub Copilot is enabled or disabled. When enabled, the background color of the icon will match the color of the status bar. When disabled, the background color of the icon will contrast with the color of the status bar.

1. To enable or disable GitHub Copilot, click the status icon in the bottom panel of the Visual Studio Code window.

   

2. If you are disabling GitHub Copilot, you will be asked whether you want to disable suggestions globally, or for the language of the file you are currently editing.

   • To disable suggestions from GitHub Copilot globally, click Disable Globally.
   • To disable suggestions from GitHub Copilot for the specified language, click Disable for LANGUAGE.