Getting started with GitHub Copilot

About GitHub Copilot and Visual Studio Code

O GitHub Copilot oferece sugestões de preenchimento automático de um programador de par de IA à medida que você cria o código. Para obter mais informações, confira "Sobre o GitHub Copilot Individual".

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

• Para usar o GitHub Copilot, é preciso ter uma assinatura ativa do GitHub Copilot. Para obter mais informações, confira "Sobre a cobrança para o 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

O GitHub Copilot oferece sugestões para várias linguagens e uma ampla variedade de estruturas, mas funciona melhor para Python, JavaScript, TypeScript, Ruby, Go, C# e C++. GitHub Copilot também pode ajudar na geração de consultas para bancos de dados. The following samples are in JavaScript, but other languages will work similarly.

1. No Visual Studio Code, crie um novo arquivo 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. Para aceitar a sugestão, pressione Tab.

Seeing alternative suggestions

Para qualquer entrada fornecida, GitHub Copilot podem oferecer várias sugestões. Você pode selecionar qual sugestão usar ou rejeitar todas as sugestões.

1. No Visual Studio Code, crie um novo arquivo 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. Opcionalmente, você pode ver sugestões alternativas, quando há alguma disponível.

   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. Para aceitar uma sugestão, pressione Tab. Para rejeitar todas as sugestões, pressione 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. No Visual Studio Code, crie um novo arquivo 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 "Como configurar o GitHub Copilot no seu ambiente."

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

Você pode não querer nenhuma das sugestões iniciais que o GitHub Copilot oferece. Você pode usar um atalho de teclado para solicitar que GitHub Copilot mostre várias sugestões em uma nova guia.

1. No Visual Studio Code, crie um novo arquivo 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

Você pode descrever algo que deseja fazer usando linguagem natural em um comentário e o GitHub Copilot sugerirá o código para atingir sua meta.

1. No Visual Studio Code, crie um novo arquivo 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. No Visual Studio Code, crie um novo arquivo 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.

Como habilitar ou desabilitar o GitHub Copilot

Você pode habilitar ou desabilitar o GitHub Copilot de dentro do Visual Studio Code. O ícone de status do GitHub Copilot no painel inferior da janela do Visual Studio Code indica se o GitHub Copilot está habilitado ou desabilitado. Quando ele estiver habilitado, a cor da tela de fundo do ícone corresponderá à cor da barra de status. Quando ele estiver desabilitado, a cor da tela de fundo do ícone se contrastará com a cor da barra de status.

1. Para habilitar ou desabilitar o GitHub Copilot, clique no ícone de status no painel inferior da janela do Visual Studio Code.

   

2. Quando você estiver desabilitando o GitHub Copilot, será perguntado se deseja desabilitar as sugestões globalmente ou para a linguagem do arquivo em edição no momento.

   • Para desabilitar as sugestões do GitHub Copilot globalmente, clique em Desabilitar Globalmente.
   • Para desabilitar as sugestões do GitHub Copilot para a linguagem especificada, clique em Desabilitar para a LINGUAGEM.