Utilisation de GitHub Copilot CLI

L’interface de ligne de commande (CLI) pour GitHub Copilot vous permet d’utiliser Copilot directement depuis votre terminal. Pour plus d’informations, consultez « À propos de GitHub Copilot CLI ».

Remarque

GitHub Copilot CLI est en préversion publique et susceptible d’être modifié.

Prérequis

Installez Copilot CLI. Consultez Installation de GitHub Copilot CLI.

Utilisation de Copilot CLI

Dans votre terminal, accédez à un dossier qui contient le code que vous souhaitez utiliser.
Entrez copilot pour démarrer Copilot CLI.

Copilot vous demandera de confirmer que vous faites confiance aux fichiers contenus dans ce dossier.

Important

Pendant cette session GitHub Copilot CLI, Copilot peut tenter de lire, modifier et exécuter les fichiers contenus dans ce dossier et ses sous-dossiers. Vous ne devez continuer que si vous faites confiance aux fichiers de cet emplacement. Pour plus d’informations sur les répertoires de confiance, consultez À propos de GitHub Copilot CLI.
Choisissez l’une des options suivantes :

1. Oui, continuer :

Copilot peut travailler avec les fichiers dans cet emplacement pour cette session seulement.

2. Oui, et mémoriser ce dossier pour les sessions futures :

Vous faites confiance aux fichiers de ce dossier pour cette session et les sessions futures. Vous ne serez plus interrogé lorsque vous lancerez Copilot CLI à partir de ce dossier. Choisissez cette option uniquement si vous êtes certain que Copilot peut toujours utiliser les fichiers de cet emplacement en toute sécurité.

3. Non, quitter (Échap) :

Mettez fin à votre session Copilot CLI.
Si vous n’êtes pas actuellement connecté à GitHub, vous serez invité à utiliser la commande à barre oblique /login. Entrez cette commande et suivez les instructions à l’écran pour vous authentifier.
Entrez un prompt dans l’interface de ligne de commande.

Il peut s’agir d’une simple question de conversation ou d’une demande adressée à Copilot pour effectuer une tâche spécifique, telle que corriger un bogue, ajouter une fonctionnalité à une application existante ou créer une nouvelle application.

Pour obtenir des exemples de prompts, consultez À propos de GitHub Copilot CLI.
Lorsque Copilot souhaite utiliser un outil susceptible de modifier ou d’exécuter des fichiers (par exemple, touch, chmod, node ou sed), il vous demandera d’approuver l’utilisation de cet outil.

Choisissez l’une des options suivantes :

1. Oui :

Autorisez Copilot à utiliser cet outil. La prochaine fois que Copilot voudra utiliser cet outil, il vous demandera de l’approuver à nouveau.

2. Oui, et approuver l’OUTIL pour le reste de la session en cours :

Autorisez Copilot à utiliser cet outil, avec toutes les options, sans demander à nouveau, pour le reste de la session en cours. Vous devrez approuver les commandes dans les futures sessions.

Cette option est pratique pour de nombreux outils, tels que chmod, car elle vous évite d’avoir à approuver plusieurs fois des commandes similaires au cours d’une même session. Cependant, vous devez être conscient des implications de cette option en matière de sécurité. Choisir cette option pour la commande rm, par exemple, autoriserait Copilot à supprimer n’importe quel fichier dans ou sous le dossier actuel sans demander votre approbation.

3. Non, et indiquer à Copilot ce qu’il doit faire différemment (Échap) :

Copilot n’exécutera pas la commande. Au lieu de cela, il mettra fin à l’opération en cours et attendra votre prochain prompt. Vous pouvez demander à Copilot de poursuivre la tâche, mais en utilisant une approche différente.

Par exemple, si vous demandez à Copilot de créer un script bash, mais que vous ne souhaitez pas utiliser le script suggéré par Copilot, vous pouvez arrêter l’opération en cours et entrer un nouveau prompt, tel que : Continue the previous task but include usage instructions in the script.

Conseils

Optimisez votre expérience avec Copilot CLI grâce aux conseils suivants.

Arrêter une opération en cours d’exécution

Si vous entrez un prompt et décidez ensuite d’arrêter Copilot avant qu’il ne termine la tâche alors qu’il est encore en mode « Réflexion », appuyez sur Échap.

Inclure un fichier spécifique dans votre prompt

Pour ajouter un fichier spécifique à votre prompt, utilisez @ suivi du chemin d’accès relatif au fichier. Par exemple, Explain @config/ci/ci-required-checks.yml ou Fix the bug in @src/app.js. Cela ajoute le contenu du fichier à votre prompt en tant que contexte pour Copilot.

Lorsque vous commencez à taper un chemin d’accès à un fichier, les chemins correspondants s’affichent sous la zone de prompt. Utilisez les touches fléchées pour sélectionner un chemin d’accès et appuyez sur Tab pour compléter le chemin d’accès dans votre prompt.

Travailler avec des fichiers situés à un autre emplacement

Pour accomplir une tâche, Copilot peut avoir besoin de travailler avec des fichiers qui se trouvent en dehors du répertoire de travail actuel. Si un prompt que vous avez entré dans une session interactive nécessite que Copilot modifie un fichier en dehors de l’emplacement actuel, il vous demandera d’approuver l’accès au répertoire du fichier.

Vous pouvez également ajouter manuellement un répertoire de confiance à tout moment à l’aide de la commande à barre oblique :

/add-dir /path/to/directory

Si tous les fichiers avec lesquels vous souhaitez travailler se trouvent dans un autre emplacement, vous pouvez changer le répertoire de travail actuel sans démarrer une nouvelle session Copilot CLI à l’aide de la commande à barre oblique :

/cwd /path/to/directory

Reprendre une session interactive

Vous pouvez revenir à une session interactive précédente et poursuivre votre conversation avec Copilot en utilisant l’option de ligne de commande --resume, puis en choisissant la session que vous souhaitez reprendre dans la liste qui s’affiche.

Utiliser des instructions personnalisées

Vous pouvez améliorer les performances de Copilot en ajoutant des instructions personnalisées au référentiel dans lequel vous travaillez. Les instructions personnalisées sont des descriptions en langage naturel enregistrées dans des fichiers Markdown dans le référentiel. Elles sont automatiquement incluses dans les prompts que vous entrez lorsque vous travaillez dans ce référentiel. Cela aide Copilot à mieux comprendre le contexte de votre projet et à répondre à vos prompts.

Copilot CLI prend en charge :

Les instructions à l’échelle du référentiel dans le fichier .github/copilot-instructions.md.
Les fichiers d’instructions spécifiques au chemin d’accès : .github/copilot-instructions/**/*.instructions.md.
Les fichiers d’assistant tels que AGENTS.md.

Pour plus d’informations, consultez « Ajout d’instructions personnalisées du référentiel pour GitHub Copilot ».

Ajouter un serveur MCP

Copilot CLI est fourni avec le serveur MCP GitHub déjà configuré. Ce serveur MCP vous permet d’interagir avec les ressources sur GitHub.com, par exemple en vous permettant de fusionner les demandes de tirage à partir de l’interface de ligne de commande.

Pour étendre les fonctionnalités disponibles dans Copilot CLI, vous pouvez ajouter d’autres serveurs MCP :

Utilisez la commande à barre oblique suivante :
```
/mcp add
```
Renseignez les détails du serveur MCP que vous souhaitez ajouter, en utilisant la touche Tab pour passer d’un champ à l’autre.
Appuyez sur Ctrl+S pour enregistrer les détails.

Les détails de vos serveurs MCP configurés sont stockés dans le fichier mcp-config.json, situé par défaut dans le répertoire ~/.config. Cet emplacement peut être modifié en définissant la variable d’environnement XDG_CONFIG_HOME. Pour plus d’informations sur la structure JSON d’une définition de serveur, consultez Étendre l’assistant de codage GitHub Copilot avec le protocole MCP (Model Context Protocol).

En savoir plus

Pour obtenir la liste complète des options de ligne de commande et des commandes à barre oblique que vous pouvez utiliser avec Copilot CLI, procédez de l’une des manières suivantes :

Entrez ? dans la zone de prompt lors d’une session interactive.
Entrez copilot help dans votre terminal.

Pour plus d’informations, utilisez l’une des commandes suivantes dans votre terminal :

Paramètres de configuration :

copilot help config

Vous pouvez ajuster les paramètres de configuration en modifiant le fichier config.json, qui se trouve par défaut dans le répertoire ~/.config. Cet emplacement peut être modifié en définissant la variable d’environnement XDG_CONFIG_HOME.
Variables d’environnement qui affectent Copilot CLI :

copilot help environment
Niveaux de journalisation disponibles :

copilot help logging
Autorisations pour autoriser ou refuser l’utilisation de l’outil :

copilot help permissions

Commentaires

Si vous avez des commentaires à propos de GitHub Copilot CLI, veuillez nous en faire part en utilisant la commande à barre oblique /feedback dans une session interactive et en choisissant l’une des options. Vous pouvez remplir un questionnaire privé, soumettre un rapport de bogue ou suggérer une nouvelle fonctionnalité.

Qui peut utiliser cette fonctionnalité ?

Dans cet article