Utilisation de GitHub Copilot dans l’interface de ligne de commande CLI

Vous pouvez utiliser gh, l’interface de ligne de commande GitHub pour travailler avec GitHub Copilot in the CLI.

Dans cet article

À propos de l’utilisation de GitHub Copilot in the CLI

GitHub CLI est un outil open source permettant d’utiliser GitHub à partir de la ligne de commande de votre ordinateur. Lorsque vous travaillez à partir de la ligne de commande, vous pouvez utiliser l’GitHub CLI pour gagner du temps et éviter de changer de contexte. Pour plus d’informations, consultez « À propos de GitHub CLI ».

GitHub Copilot in the CLI est une extension pour GitHub CLI. Il fournit une interface de type conversation dans le terminal qui vous permet de poser des questions sur les commandes que vous exécutez à partir de la ligne de commande. Vous pouvez demander à Copilot in the CLI de suggérer une commande pour votre cas d’utilisation, avec gh copilot suggest, ou d’expliquer une commande qui vous intéresse particulièrement, avec gh copilot explain.

En outre, vous pouvez utiliser gh copilot --help pour obtenir une aide générale ou gh copilot SUBCOMMAND --help pour obtenir une aide sur une sous-commande spécifique.

Prérequis

Pour accéder à GitHub Copilot in the CLI, vous aurez besoin des éléments suivants.

  • Abonnement à GitHub Copilot  : vous devez disposer d’un abonnement GitHub Copilot actif. Pour plus d’informations, consultez « À propos de la facturation de GitHub Copilot ».
  • Accès à Copilot in the CLI  : si vous faites partie d’une organisation ou d’entreprise avec un abonnement GitHub Copilot Business or GitHub Copilot Enterprise, l’organisation ou l’entreprise doit vous accorder l’accès aux Copilot in the CLI. Pour plus d’informations, consultez « Configurer GitHub Copilot dans la CLI ».
  • Installer GitHub CLI  : vous devez installer GitHub CLI. Pour obtenir des instructions d’installation pour GitHub CLI, consultez le dépôt GitHub CLI.
  • Installez l’extension Copilot in the CLI  : de plus, vous devez installer l’extension Copilot in the CLI. Pour plus d’informations, consultez « Installation de Copilot in the CLI ».

Demander à Copilot in the CLI d’expliquer une commande

Vous pouvez demander à Copilot in the CLI d’expliquer une commande pour vous en exécutant :

Shell
gh copilot explain

Vous pouvez également ajouter la commande que vous souhaitez expliquer directement à l’invite :

Shell
gh copilot explain "sudo apt-get"

Copilot in the CLI peut vous aider en expliquant ce qu’effectue une commande en langage clair. Ainsi, vous pouvez comprendre plus facilement l’objectif de la commande et son fonctionnement pour un exemple spécifique. Vous n’avez pas besoin d’accéder à la documentation de la commande, car l’explication inclut des informations sur ce que la commande prend comme entrée et produit comme sortie, et fournit des exemples pratiques.

Demander à Copilot in the CLI de suggérer une commande

Vous pouvez demander à Copilot in the CLI de suggérer une commande pour vous en exécutant :

Shell
gh copilot suggest

Cela a pour effet de démarrer une expérience interactive en vue d’obtenir la commande dont vous avez besoin. Copilot in the CLI vise à suggérer des commandes qui vous aident à réaliser les tâches que vous essayez d’effectuer. Pour aider Copilot in the CLI à fournir de meilleures suggestions, vous pouvez spécifier le type de commande que vous recherchez (générique, git ou gh).

Si vous connaissez déjà la commande dont vous avez besoin, vous pouvez également l’inclure à l’invite. Par exemple, si vous souhaitez installer Git, vous pouvez demander à Copilot in the CLI de suggérer une commande pour vous :

Shell
gh copilot suggest "Install git"

Si le résultat n’est pas tout à fait ce que vous recherchez, vous pouvez continuer à modifier votre question jusqu’à ce que la commande renvoyée réponde à vos attentes. Pour ce faire, sélectionnez l’option Réviser la commande.

Une fois que vous avez généré la commande idéale pour votre tâche, vous pouvez facilement la copier dans votre presse-papiers pour l’exécuter là où vous en avez besoin en sélectionnant l’option Copier dans le Presse-papiers, ou vous pouvez exécuter la commande.

Exécution de la commande

Après que Copilot in the CLI a suggéré une commande, vous pouvez choisir d’exécuter la commande en sélectionnant l’option Exécuter la commande. Si vous sélectionnez cette option après l’exécution de gh copilot suggest pour demander une suggestion, Copilot in the CLI copie la commande dans le presse-papiers et quitte automatiquement la session interactive. Vous pouvez ensuite coller la commande et l’exécuter vous-même.

Si vous souhaitez que Copilot in the CLI exécute des commandes pour vous, l’alias ghcs généré par gh copilot alias fournit ce support. Pour plus d’informations sur la configuration de l’alias ghcs, consultez « Configuration des alias pour Copilot in the CLI ».

Lorsque vous utilisez l’alias ghcs et que vous sélectionnez Exécuter la commande, Copilot in the CLI demande votre confirmation avant d’exécuter la commande. L’invite de confirmation est définie par défaut sur No, mais vous pouvez modifier votre préférence par le biais de l’option gh copilot config. Pour plus d’informations, consultez « Configuration de GitHub Copilot dans l’interface CLI ».

Si vous confirmez, la commande est exécutée et enregistrée dans l’historique de votre shell pour référence ultérieure.

Configuration d’alias pour Copilot in the CLI

Avec gh copilot alias, vous pouvez créer des alias pour Copilot in the CLI. Les alias ne sont pas nécessaires pour utiliser Copilot in the CLI, mais ils peuvent être utiles pour des raisons pratiques, car ils nécessitent moins de séquences de touches et aident à exécuter des commandes suggérées.

Vous pouvez également utiliser les alias fournis pour encapsuler gh copilot suggest et gh copilot explain. Les alias fournis sont ghcs et ghce. Pour utiliser ghcs et ghce, vous devez ajouter des configurations d’alias à votre fichier de configuration shell.

Les exemples suivants montrent comment ajouter les configurations d’alias à vos fichiers de configuration Bash, PowerShell et Zsh.

Bash

Exécutez ce qui suit pour ajouter les alias à votre fichier de configuration Bash :

Shell
echo 'eval "$(gh copilot alias -- bash)"' >> ~/.bashrc

PowerShell

Exécutez ce qui suit pour ajouter les alias à votre profil PowerShell :

Shell
$GH_COPILOT_PROFILE = Join-Path -Path $(Split-Path -Path $PROFILE -Parent) -ChildPath "gh-copilot.ps1"
gh copilot alias -- pwsh | Out-File ( New-Item -Path $GH_COPILOT_PROFILE -Force )
echo ". `"$GH_COPILOT_PROFILE`"" >> $PROFILE

Zsh

Exécutez ce qui suit pour ajouter les alias à votre fichier de configuration Zsh :

Shell
echo 'eval "$(gh copilot alias -- zsh)"' >> ~/.zshrc

Une fois que vous avez configuré l’alias, vous pouvez exécuter ce qui suit :

Shell
ghcs 'print "Hello world!"'

Partage de commentaires sur Copilot in the CLI

Si vous rencontrez des problèmes ou des limites avec Copilot in the CLI, vous pouvez nous fournir vos commentaires en sélectionnant l’option Évaluer la réponse dans Copilot in the CLI.