About GitHub Copilot and JetBrains IDEs
GitHub Copilot fournit des suggestions de type autocomplétion de la part d’un programmeur en binôme d’IA pendant que vous codez. Pour plus d’informations, consultez « À propos de GitHub Copilot Individual ».
If you use a JetBrains IDE, you can view and incorporate suggestions from GitHub Copilot directly within the editor. This guide demonstrates how to use GitHub Copilot within a JetBrains IDE for macOS, Windows, or Linux.
Prerequisites
-
Pour utiliser GitHub Copilot, vous devez disposer d’un abonnement GitHub Copilot actif. Pour plus d’informations, consultez « À propos de la facturation de GitHub Copilot ».
-
To use GitHub Copilot in JetBrains, you must have a compatible JetBrains IDE installed. GitHub Copilot is compatible with the following IDEs:
- IntelliJ IDEA (Ultimate, Community, Educational)
- Android Studio
- AppCode
- CLion
- Code With Me Guest
- DataGrip
- DataSpell
- GoLand
- JetBrains Client
- MPS
- PhpStorm
- PyCharm (Professional, Community, Educational)
- Rider
- RubyMine
- RustRover
- WebStorm
For more information, see the JetBrains IDEs tool finder.
Installing the GitHub Copilot plugin in your JetBrains IDE
To use GitHub Copilot in a JetBrains IDE, you must install the GitHub Copilot extension. The following procedure will guide you through installation of the GitHub Copilot plugin in IntelliJ IDEA. Steps to install the plugin in another supported IDE may differ.
-
In your JetBrains IDE, under the File menu for Windows, or under the name of your IDE for Mac (for example, PyCharm or IntelliJ), click Settings.
-
In the left-side menu of the Settings dialog box, click Plugins.
-
At the top of the Settings dialog box, click Marketplace. In the search bar, search for
copilot
, then click Install. -
After GitHub Copilot is installed, click Restart IDE.
-
After your JetBrains IDE has restarted, click the Tools menu. Click GitHub Copilot, then click Login to GitHub.
-
In the "Sign in to GitHub" dialog box, to copy the device code and open the device activation window, click Copy and Open.
-
A device activation window will open in your browser. Paste the device code, then click Continue.
-
GitHub will request the necessary permissions for GitHub Copilot. To approve these permissions, click Authorize GitHub Copilot Plugin.
-
After the permissions have been approved, your JetBrains IDE will show a confirmation. To begin using GitHub Copilot, click OK.
Seeing your first suggestion
Remarque : Si la détection de duplication est activée pour GitHub Copilot, vous pouvez recevoir des suggestions limitées ou aucune suggestion lors de l’utilisation des exemples de code fournis. Vous pouvez également commencer par taper votre propre code pour voir les suggestions de GitHub Copilot. Pour plus d’informations sur la détection des doublons, consultez « Configuration des paramètres GitHub Copilot sur GitHub.com ».
GitHub Copilot fournit des suggestions pour de nombreux langages et un large éventail d’infrastructures, mais fonctionnent particulièrement bien pour Python, JavaScript, TypeScript, Ruby, Go, C# et C++. GitHub Copilot peut également aider à générer des requêtes pour les bases de données. The following samples are in Java, but other languages will work similarly.
-
Dans votre IDE JetBrains, créez un nouveau fichier Java ( *.java).
-
In the Java file, create a class by typing
class Test
. GitHub Copilot will automatically suggest a class body in grayed text. The exact suggestion may vary. -
Pour accepter la suggestion, appuyez sur Tab.
-
To prompt GitHub Copilot to suggest a function body, type the following line below the bracket of the
main
function. The exact suggestion may vary.Java int calculateDaysBetweenDates(
int calculateDaysBetweenDates(
-
Pour accepter la suggestion, appuyez sur Tab.
GitHub Copilot will attempt to match the context and style of your code. You can always edit the suggested code.
Seeing alternative suggestions
Pour n’importe quelle entrée donnée, GitHub Copilot peut proposer plusieurs suggestions. Vous pouvez sélectionner la suggestion à utiliser ou rejeter toutes les suggestions.
-
Dans votre IDE JetBrains, créez un nouveau fichier Java ( *.java).
-
To prompt GitHub Copilot to show you a suggestion, type the following line in the Java file.
Java int calculateDaysBetweenDates(
int calculateDaysBetweenDates(
- Vous pouvez éventuellement voir les suggestions alternatives, si elles sont disponibles.
OS See next suggestion See previous suggestion macOS Option+] Option+[ Windows Alt+] Alt+[ Linux Alt+] Alt+[ -
Pour accepter une suggestion, appuyez sur Tab. Pour rejeter toutes les suggestions, appuyez sur Échap.
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.
-
Dans votre IDE JetBrains, créez un nouveau fichier Java ( *.java).
-
To prompt GitHub Copilot to show you a suggestion, type the following line in the Java file.
Java int calculateDaysBetweenDates(
int calculateDaysBetweenDates(
-
To accept a part of the suggestion, use one of the following keyboard shortcuts.
OS Accept Next Word Accept Next Line macOS Command+→ Command+Control+→ Windows Control+→ Control+Alt+→ Linux Control+→ Control+Alt+→ -
Alternatively, you can hover over the suggestion to see the GitHub Copilot command palette for choosing suggestions.
Seeing multiple suggestions in a new tab
Il se peut que vous ne vouliez aucune des suggestions initiales proposées par GitHub Copilot. Vous pouvez utiliser un raccourci clavier pour demander à GitHub Copilot de vous montrer plusieurs suggestions dans un nouvel onglet.
-
Dans votre IDE JetBrains, créez un nouveau fichier Java ( *.java).
-
To prompt GitHub Copilot to show you a suggestion, type the following line in the Java file.
Java int calculateDaysBetweenDates(
int calculateDaysBetweenDates(
-
Open a new tab with multiple additional suggestions.
- On macOS, press Command+Shift+A, then click Open GitHub Copilot, or press Command+Shift+</kbd> to open the new tab immediately.
- On Windows or Linux, press Ctrl+Enter, then click Open GitHub Copilot.
-
To accept a suggestion, above the suggestion, click Accept Solution. To reject all suggestions, close the tab.
Generating code suggestions from comments
Vous pouvez décrire quelque chose que vous voulez faire en utilisant du langage naturel dans un commentaire : GitHub Copilot va alors suggérer le code pour réaliser votre objectif.
-
Dans votre IDE JetBrains, créez un nouveau fichier Java ( *.java).
-
To prompt GitHub Copilot to suggest an implementation of a function in the Java file, type the following lines.
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 () {
Enabling and disabling GitHub Copilot
You can enable or disable GitHub Copilot for all languages, or for individual languages. The GitHub Copilot status icon in the bottom panel of your JetBrains IDE window indicates whether GitHub Copilot is enabled or disabled. When enabled, the icon is highlighted. When disabled, the icon is grayed out.
-
To enable or disable GitHub Copilot, click the status icon in the bottom panel of the JetBrains window.
-
If you are disabling GitHub Copilot, you will be asked whether you want to disable it globally, or for the language of the file you are currently editing.
- To disable suggestions from GitHub Copilot globally, click Disable Completions.
- To disable suggestions from GitHub Copilot for the specified language, click Disable Completions for LANGUAGE.
About GitHub Copilot and Visual Studio
GitHub Copilot fournit des suggestions de type autocomplétion de la part d’un programmeur en binôme d’IA pendant que vous codez. Pour plus d’informations, consultez « À propos de GitHub Copilot Individual ».
If you use Visual Studio, you can view and incorporate suggestions from GitHub Copilot directly within the editor. This guide demonstrates how to use GitHub Copilot within Visual Studio for Windows.
Prerequisites
-
Pour utiliser GitHub Copilot, vous devez disposer d’un abonnement GitHub Copilot actif. Pour plus d’informations, consultez « À propos de la facturation de GitHub Copilot ».
-
To use GitHub Copilot in Visual Studio, you must have Visual Studio 2022 17.6 or later installed. For more information, see the Visual Studio IDE documentation.
Remarque : GitHub Copilot ne peut pas être utilisé avec Visual Studio pour Mac.
Installing the GitHub Copilot extension in Visual Studio
To use GitHub Copilot, you must first install the GitHub Copilot extension.
-
Dans la barre de menus Visual Studio, cliquez sur Extensions, puis sur Gérer les extensions.
-
In the "Manage Extensions" window, click Visual Studio Marketplace, search for the GitHub Copilot extension, then click Download.
-
Fermez la fenêtre « Gérer les extensions », puis quittez et relancez Visual Studio.
-
Optionally, to check that GitHub Copilot is installed and enabled, go back to Manage Extensions, click Installed to view your currently installed extensions, then click GitHub Copilot to see status information.
-
Open or create a new project in Visual Studio.
-
To enable GitHub Copilot, ensure you have added your GitHub account to Visual Studio. For more information, see Work with GitHub accounts in Visual Studio in the Microsoft documentation.
Seeing your first suggestion
Remarque : Si la détection de duplication est activée pour GitHub Copilot, vous pouvez recevoir des suggestions limitées ou aucune suggestion lors de l’utilisation des exemples de code fournis. Vous pouvez également commencer par taper votre propre code pour voir les suggestions de GitHub Copilot. Pour plus d’informations sur la détection des doublons, consultez « Configuration des paramètres GitHub Copilot sur GitHub.com ».
-
Dans Visual Studio, créez un fichier C# ( *.cs).
-
In the C# file, type the following function signature. GitHub Copilot will automatically suggest an entire function body in grayed text, as shown below. The exact suggestion may vary.
C# int CalculateDaysBetweenDates(
int CalculateDaysBetweenDates(
-
Pour accepter la suggestion, appuyez sur Tab.
Seeing alternative suggestions
Pour n’importe quelle entrée donnée, GitHub Copilot peut proposer plusieurs suggestions. Vous pouvez sélectionner la suggestion à utiliser ou rejeter toutes les suggestions.
-
Dans Visual Studio, créez un fichier C# ( *.cs).
-
In the C# file, type the following function signature. GitHub Copilot will show you a suggestion.
C# int CalculateDaysBetweenDates(
int CalculateDaysBetweenDates(
-
If alternative suggestions are available, you can see these alternatives by pressing Alt+. (or Alt+,).
-
Optionally, you can hover over the suggestion to see the GitHub Copilot command palette for choosing suggestions.
- Pour accepter une suggestion, appuyez sur Tab. Pour rejeter toutes les suggestions, appuyez sur Échap.
Generating code suggestions from comments
Vous pouvez décrire quelque chose que vous voulez faire en utilisant du langage naturel dans un commentaire : GitHub Copilot va alors suggérer le code pour réaliser votre objectif.
-
Dans Visual Studio, créez un fichier C# ( *.cs).
-
In the C# file, type the following comment. GitHub Copilot will suggest an implementation of the function.
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
-
Pour accepter la suggestion, appuyez sur Tab.
Activation ou désactivation de GitHub Copilot
L’icône d’état de GitHub Copilot dans le panneau inférieur de la fenêtre Visual Studio indique si GitHub Copilot est activé ou désactivé. Quand il est activé, la couleur d’arrière-plan de l’icône correspond à la couleur de la barre d’état. Quand il est désactivé, elle comporte une ligne en diagonal.
-
Pour activer ou désactiver GitHub Copilot, cliquez sur l’icône GitHub Copilot dans le panneau inférieur de la fenêtre Visual Studio.
-
Si vous désactivez GitHub Copilot, il vous sera demandé si vous souhaitez désactiver les suggestions de façon globale ou pour le langage du fichier que vous êtes en train de modifier.
- Pour désactiver les suggestions de GitHub Copilot globalement, cliquez sur Activer globalement.
- Pour désactiver les suggestions de GitHub Copilot pour le langage spécifié, cliquez sur Activer pour LANGAGE.
About GitHub Copilot and Visual Studio Code
GitHub Copilot fournit des suggestions de type autocomplétion de la part d’un programmeur en binôme d’IA pendant que vous codez. Pour plus d’informations, consultez « À propos de 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
-
Pour utiliser GitHub Copilot, vous devez disposer d’un abonnement GitHub Copilot actif. Pour plus d’informations, consultez « À propos de la facturation de 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.
-
In the Visual Studio Code Marketplace, go to the GitHub Copilot extension page and click Install.
-
A popup will appear, asking to open Visual Studio Code. Click Open Visual Studio Code.
-
In the "Extension: GitHub Copilot" tab in Visual Studio Code, click Install.
-
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.
-
-
In your browser, GitHub will request the necessary permissions for GitHub Copilot. To approve these permissions, click Authorize Visual Studio Code.
-
To confirm the authentication, in Visual Studio Code, in the "Visual Studio Code" dialog box, click Open.
Seeing your first suggestion
Remarque : Si la détection de duplication est activée pour GitHub Copilot, vous pouvez recevoir des suggestions limitées ou aucune suggestion lors de l’utilisation des exemples de code fournis. Vous pouvez également commencer par taper votre propre code pour voir les suggestions de GitHub Copilot. Pour plus d’informations sur la détection des doublons, consultez « Configuration des paramètres GitHub Copilot sur GitHub.com ».
GitHub Copilot fournit des suggestions pour de nombreux langages et un large éventail d’infrastructures, mais fonctionnent particulièrement bien pour Python, JavaScript, TypeScript, Ruby, Go, C# et C++. GitHub Copilot peut également aider à générer des requêtes pour les bases de données. The following samples are in JavaScript, but other languages will work similarly.
-
Dans Visual Studio Code, créez un fichier JavaScript ( *.js).
-
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) {
function calculateDaysBetweenDates(begin, end) {
-
Pour accepter la suggestion, appuyez sur Tab.
Note: If you don't see a suggestion, make sure GitHub Copilot is enabled. You should see the Copilot icon at the bottom right of the Visual Studio Code window.
Si un fichier a été configuré comme contenu exclu pour GitHub Copilot, l’icône de la barre d’état a une ligne diagonale à travers celle-ci. Survolez l’icône pour afficher une info-bulle qui vous indique quels paramètres ont appliqué cette restriction.
Pour plus d’informations, consultez « Configuration des exclusions de contenu pour GitHub Copilot ».
Seeing alternative suggestions
Pour n’importe quelle entrée donnée, GitHub Copilot peut proposer plusieurs suggestions. Vous pouvez sélectionner la suggestion à utiliser ou rejeter toutes les suggestions.
-
Dans Visual Studio Code, créez un fichier JavaScript ( *.js).
-
In the JavaScript file, type the following function header. GitHub Copilot will show you a suggestion.
JavaScript function calculateDaysBetweenDates(begin, end) {
function calculateDaysBetweenDates(begin, end) {
-
Vous pouvez éventuellement voir les suggestions alternatives, si elles sont disponibles.
OS See next suggestion See previous suggestion macOS Option (⌥) or Alt+] Option (⌥) or Alt+[ Windows Alt+] Alt+[ Linux Alt+] Alt+[ -
Alternatively, you can hover over the suggestion to see the GitHub Copilot command palette for choosing suggestions.
-
Pour accepter une suggestion, appuyez sur Tab. Pour rejeter toutes les suggestions, appuyez sur Échap.
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.
-
Dans Visual Studio Code, créez un fichier JavaScript ( *.js).
-
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) {
function calculateDaysBetweenDates(begin, end) {
-
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+→ -
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 "Configuration de GitHub Copilot dans votre environnement." -
Alternatively, you can hover over the suggestion to see the GitHub Copilot command palette for choosing suggestions.
Seeing multiple suggestions in a new tab
Il se peut que vous ne vouliez aucune des suggestions initiales proposées par GitHub Copilot. Vous pouvez utiliser un raccourci clavier pour demander à GitHub Copilot de vous montrer plusieurs suggestions dans un nouvel onglet.
-
Dans Visual Studio Code, créez un fichier JavaScript ( *.js).
-
In the JavaScript file, type the following function header. GitHub Copilot will show you a suggestion.
JavaScript function calculateDaysBetweenDates(begin, end) {
function calculateDaysBetweenDates(begin, end) {
-
To open a new tab with multiple additional options, press Ctrl+Enter.
-
To accept a suggestion, above the suggestion, click Accept Solution. To reject all suggestions, close the tab.
Generating code suggestions from comments
Vous pouvez décrire quelque chose que vous voulez faire en utilisant du langage naturel dans un commentaire : GitHub Copilot va alors suggérer le code pour réaliser votre objectif.
-
Dans Visual Studio Code, créez un fichier JavaScript ( *.js).
-
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() {
// 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.
-
Dans Visual Studio Code, créez un fichier JavaScript ( *.js).
-
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
// Express server on port 3000
-
To accept each line, press Tab, then Enter.
-
Type the following comment and then press Enter. GitHub Copilot will suggest an implementation for the default handler.
JavaScript // Return the current time
// Return the current time
-
To accept each line, press Tab.
Activation ou désactivation de GitHub Copilot
Vous pouvez activer ou désactiver GitHub Copilot à partir de Visual Studio Code. L’icône d’état de GitHub Copilot dans le panneau inférieur de la fenêtre Visual Studio Code indique si GitHub Copilot est activé ou désactivé. Lorsque cette option est activée, la couleur d’arrière-plan de l’icône correspond à la couleur de la barre d’état. Lorsqu’elle est désactivée, la couleur d’arrière-plan de l’icône contraste avec la couleur de la barre d’état.
-
Pour activer ou désactiver GitHub Copilot, cliquez sur l’icône d’état dans le panneau inférieur de la fenêtre Visual Studio Code.
-
Si vous désactivez GitHub Copilot, il vous sera demandé si vous souhaitez désactiver les suggestions de manière globale ou pour le langage du fichier que vous êtes en train de modifier.
- Pour désactiver les suggestions de GitHub Copilot globalement, cliquez sur Désactiver globalement.
- Pour désactiver les suggestions de GitHub Copilot pour le langage spécifié, cliquez sur Désactiver pour LANGAGE.
About GitHub Copilot and Vim/Neovim
GitHub Copilot fournit des suggestions de type autocomplétion de la part d’un programmeur en binôme d’IA pendant que vous codez. Pour plus d’informations, consultez « À propos de GitHub Copilot Individual ».
If you use Vim/Neovim, you can view and incorporate suggestions from GitHub Copilot directly within the editor.
Prerequisites
-
Pour utiliser GitHub Copilot, vous devez disposer d’un abonnement GitHub Copilot actif. Pour plus d’informations, consultez « À propos de la facturation de GitHub Copilot ».
-
To use GitHub Copilot in Vim/Neovim you must have Vim version 9.0.0185 / Neovim version 0.6 or above and Node.js version 18 or above installed. For more information, see the Vim / Neovim documentation and the Node.js website.
Installing the GitHub Copilot extension in Vim/Neovim on macOS
- GitHub recommande d’installer le plug-in GitHub Copilot avec le gestionnaire de plug-ins intégré de Vim/Neovim. Vous pouvez également utiliser un gestionnaire de plug-ins de votre choix pour installer
github/copilot.vim
.
-
To install GitHub Copilot with Vim's built-in plugin manager, enter the following command in Terminal:
git clone https://github.com/github/copilot.vim \ ~/.vim/pack/github/start/copilot.vim
-
To install GitHub Copilot with Neovim's built-in plugin manager, enter the following command in Terminal:
git clone https://github.com/github/copilot.vim \ ~/.config/nvim/pack/github/start/copilot.vim
-
Pour configurer GitHub Copilot, ouvrez Vim/Neovim et entrez la commande suivante.
:Copilot setup
-
Activez GitHub Copilot dans votre configuration Vim/Neovim ou avec la commande Vim/Neovim.
:Copilot enable
Installing the GitHub Copilot extension in Vim/Neovim on Windows
- GitHub recommande d’installer le plug-in GitHub Copilot avec le gestionnaire de plug-ins intégré de Vim/Neovim. Vous pouvez également utiliser un gestionnaire de plug-ins de votre choix pour installer
github/copilot.vim
.
-
To install GitHub Copilot with Vim's built-in plugin manager, enter the following command in Git Bash:
git clone https://github.com/github/copilot.vim.git \ $HOME/vimfiles/pack/github/start/copilot.vim
-
To install GitHub Copilot with Neovim's built-in plugin manager, enter the following command in Git Bash:
git clone https://github.com/github/copilot.vim.git \ $HOME/AppData/Local/nvim/pack/github/start/copilot.vim
-
Pour configurer GitHub Copilot, ouvrez Vim/Neovim et entrez la commande suivante.
:Copilot setup
-
Activez GitHub Copilot dans votre configuration Vim/Neovim ou avec la commande Vim/Neovim.
:Copilot enable
Installing the GitHub Copilot extension in Vim/Neovim on Linux
- GitHub recommande d’installer le plug-in GitHub Copilot avec le gestionnaire de plug-ins intégré de Vim/Neovim. Vous pouvez également utiliser un gestionnaire de plug-ins de votre choix pour installer
github/copilot.vim
.
-
To install GitHub Copilot with Vim's built-in plugin manager, enter the following command:
git clone https://github.com/github/copilot.vim \ ~/.vim/pack/github/start/copilot.vim
-
To install GitHub Copilot with Neovim's built-in plugin manager, enter the following command:
git clone https://github.com/github/copilot.vim \ ~/.config/nvim/pack/github/start/copilot.vim
-
Pour configurer GitHub Copilot, ouvrez Vim/Neovim et entrez la commande suivante.
:Copilot setup
-
Activez GitHub Copilot dans votre configuration Vim/Neovim ou avec la commande Vim/Neovim.
:Copilot enable
Learning to use GitHub Copilot in Vim/Neovim
For guidance on using GitHub Copilot in Vim/Neovim, you can view the plugin documentation. To see the documentation, open Vim/Neovim and run the following command:
:help copilot
About GitHub Copilot and Azure Data Studio
GitHub Copilot fournit des suggestions de type autocomplétion de la part d’un programmeur en binôme d’IA pendant que vous codez. Pour plus d’informations, consultez « À propos de GitHub Copilot Individual ».
If you use Azure Data Studio, you can view and incorporate suggestions from GitHub Copilot directly within the editor. This guide demonstrates how to use GitHub Copilot within Azure Data Studio for macOS, Windows, or Linux.
Prerequisites
-
Pour utiliser GitHub Copilot, vous devez disposer d’un abonnement GitHub Copilot actif. Pour plus d’informations, consultez « À propos de la facturation de GitHub Copilot ».
-
To use GitHub Copilot in Azure Data Studio, you must have Azure Data Studio version 1.44.0 or later installed. For more information, see the Azure Data Studio download page in the Azure Data Studio documentation.
Installing the GitHub Copilot extension in Azure Data Studio
To use GitHub Copilot, you must first install the GitHub Copilot extension.
-
In Azure Data Studio, click the Extensions icon in the left-side menu.
-
In the "Extensions" tab, search for GitHub Copilot and then click Install.
-
If a popup window in Azure Data Studio prompts you to sign in to use GitHub Copilot, click Sign in to GitHub and follow the instructions on screen.
- If you have previously authorized Azure Data Studio for your account on GitHub, GitHub Copilot will be automatically authorized.
- If you don't get the prompt to authorize, you can view notifications by clicking the bell icon in the bottom panel of the Azure Data Studio window.
-
If you are following the authorization steps, in your browser, GitHub will request the necessary permissions for GitHub Copilot. To approve these permissions, click Authorize Azure Data Studio.
Seeing your first suggestion
Remarque : Si la détection de duplication est activée pour GitHub Copilot, vous pouvez recevoir des suggestions limitées ou aucune suggestion lors de l’utilisation des exemples de code fournis. Vous pouvez également commencer par taper votre propre code pour voir les suggestions de GitHub Copilot. Pour plus d’informations sur la détection des doublons, consultez « Configuration des paramètres GitHub Copilot sur GitHub.com ».
GitHub Copilot can provide you with inline suggestions as you create SQL databases in Azure Data Studio. For example, if you're writing a query that joins two tables, Copilot may suggest the join condition from columns in the open editor, other files in the workspace, and common syntax patterns.
-
Dans Azure Data Studio, créez un nouveau fichier SQL.
-
In the SQL file, type the following query. GitHub Copilot will automatically suggest a join condition in grayed text. The exact suggestion may vary.
SQL SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow] FROM [Tag].[Scoreboard] INNER JOIN
SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow] FROM [Tag].[Scoreboard] INNER JOIN
-
Pour accepter la suggestion, appuyez sur Tab.
Seeing alternative suggestions
For some suggestions, GitHub Copilot may provide multiple alternatives. You can select which suggestion you want to use, or reject all suggestions.
-
Dans Azure Data Studio, créez un nouveau fichier SQL.
-
In the SQL file, type the following query. GitHub Copilot will show you a suggestion.
SQL SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow] FROM [Tag].[Scoreboard] INNER JOIN
SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow] FROM [Tag].[Scoreboard] INNER JOIN
-
Optionally, you can see alternative suggestions, if any are available.
OS See next suggestion See previous suggestion Windows Alt+[ Alt+] Linux Alt+[ Alt+] macOS Option+[ Option+]
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.
-
Dans Azure Data Studio, créez un nouveau fichier SQL.
-
In the SQL file, type the following query. GitHub Copilot will show you a suggestion.
SQL SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow] FROM [Tag].[Scoreboard] INNER JOIN
SELECT [UserId], [Red], [Orange], [Yellow], [Green], [Blue], [Purple], [Rainbow] FROM [Tag].[Scoreboard] INNER JOIN
-
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+→ -
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 "Keyboard shortcuts in Azure Data Studio" in the Microsoft documentation. -
Alternatively, you can hover over the suggestion to see the GitHub Copilot command palette for choosing suggestions.
Generating code suggestions from comments
Vous pouvez décrire quelque chose que vous voulez faire en utilisant du langage naturel dans un commentaire : GitHub Copilot va alors suggérer le code pour réaliser votre objectif.
-
Dans Azure Data Studio, créez un nouveau fichier SQL.
-
In the SQL file, type the following query and comment. GitHub Copilot will suggest an implementation of the query.
SQL SELECT TokenColor, COUNT(UserID) AS UserCount FROM Tag.Users GROUP BY TokenColor -- pivot that query on tokencolor for Purple, Blue, Green, Yellow, Orange, Red -- and rename the columns to match the colors SELECT [Purple], [Blue], [Green], [Yellow], [Orange], [Red]
SELECT TokenColor, COUNT(UserID) AS UserCount FROM Tag.Users GROUP BY TokenColor -- pivot that query on tokencolor for Purple, Blue, Green, Yellow, Orange, Red -- and rename the columns to match the colors SELECT [Purple], [Blue], [Green], [Yellow], [Orange], [Red]
Enabling or disabling GitHub Copilot
You can enable or disable GitHub Copilot from within Azure Data Studio. The GitHub Copilot status icon in the bottom panel of the Azure Data Studio 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.
-
To enable or disable GitHub Copilot, click the status icon in the bottom panel of the Azure Data Studio window.
-
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.
Next steps
Vous avez installé GitHub Copilot et vous avez reçu votre première suggestion, mais ce n’est que le début ! Voici quelques ressources utiles pour passer aux étapes suivantes avec GitHub Copilot.
- GitHub Copilot: See practical examples of how GitHub Copilot can help you work.
- Configuration de GitHub Copilot: These guides provide details on how to configure GitHub Copilot to your personal preferences.
- Gestion de la facturation pour GitHub Copilot: Learn more about billing for GitHub Copilot.
- Résolution des problèmes liés à GitHub Copilot: These guides provide information for troubleshooting GitHub Copilot.