Getting started with GitHub Copilot

About GitHub Copilot and Visual Studio Code

GitHub Copilot unterbreitet dir während des Programmierens als KI-Paarprogrammierer AutoVervollständigen-Vorschläge. Weitere Informationen findest du unter Informationen über 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

• Um GitHub Copilot verwenden zu können, benötigst du ein aktives GitHub Copilot-Abonnement. Weitere Informationen findest du unter Informationen zur Abrechnung für 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 bietet Vorschläge für zahlreiche Sprachen und eine vielzahl von Frameworks, funktioniert aber besonders gut für Python, JavaScript, TypeScript, Ruby, Go, C# und C++. GitHub Copilot kann auch bei der Abfragegenerierung für Datenbanken helfen. The following samples are in JavaScript, but other languages will work similarly.

1. Erstelle in Visual Studio Code eine neue JavaScript-Datei ( *.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. Um den Vorschlag zu akzeptieren, drücke die TAB-TASTE.

Seeing alternative suggestions

Für jede Eingabe kann GitHub Copilot mehrere Vorschläge anbieten. Du kannst auswählen, welche Vorschläge verwendet werden sollen, oder alle Vorschläge ablehnen.

1. Erstelle in Visual Studio Code eine neue JavaScript-Datei ( *.js).

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

   JavaScript

   function calculateDaysBetweenDates(begin, end) {
   

3. Optional kannst du dir, falls vorhanden, alternative Vorschläge anzeigen lassen.

   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. Um einen Vorschlag anzunehmen, drücke die TAB-TASTE. Um alle Vorschläge abzulehnen, drücke 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. Erstelle in Visual Studio Code eine neue JavaScript-Datei ( *.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 "Konfigurieren von GitHub Copilot in deiner Umgebung."

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

Es kann sein, dass du keinen der anfänglichen Vorschläge von GitHub Copilot befolgen möchtest. Mittels einer Tastenkombination kannst du GitHub Copilot dazu auffordern, dir mehrere Vorschläge in einer neuen Registerkarte anzuzeigen.

1. Erstelle in Visual Studio Code eine neue JavaScript-Datei ( *.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

Sie können in einem Kommentar Ihre Absicht in natürlicher Sprache beschreiben, woraufhin GitHub Copilot den Code vorschlägt, mit dem Sie Ihr Ziel erreichen.

1. Erstelle in Visual Studio Code eine neue JavaScript-Datei ( *.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. Erstelle in Visual Studio Code eine neue JavaScript-Datei ( *.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.

Aktivieren oder Deaktivieren von GitHub Copilot

Du kannst GitHub Copilot in Visual Studio Code aktivieren oder deaktivieren. Das Statussymbol GitHub Copilot im unteren Bereich des Visual Studio Code-Fensters gibt an, ob GitHub Copilot aktiviert oder deaktiviert ist. Wenn es aktiviert ist, stimmt die Hintergrundfarbe des Symbols mit der Farbe der Statusleiste überein. Ist es deaktiviert, kontrastiert die Hintergrundfarbe des Symbols mit der Farbe der Statusleiste.

1. Zum Aktivieren oder Deaktivieren von GitHub Copilot klicke im unteren Bereich des Visual Studio Code-Fensters auf das Statussymbol.

   

2. Wenn du GitHub Copilot deaktivierst, wirst du gefragt, ob du Vorschläge global oder für die Sprache der aktuell bearbeiteten Datei deaktivieren möchtest.

   • Um Vorschläge von GitHub Copilot global zu deaktivieren, klicke auf Global deaktivieren.
   • Wenn du Vorschläge von GitHub Copilot für die angegebene Sprache deaktivieren möchtest, klicke auf Für SPRACHE deaktivieren.