Démarrage rapide pour les extensions GitHub Copilot

Générez et essayez l’extension Blackbeard de GitHub pour découvrir le processus de développement de Extensions GitHub Copilot.

Tool navigation

Dans cet article

L’extension Blackbeard est un Extension GitHub Copilot qui comprend un GitHub App et un agent Copilot. L’agent répond aux demandes de conversation dans le style d’un pirate, à l’aide de l’API du grand modèle de langage (LLM) de Copilot et de prompts système spéciaux. Consultez À propos des agents pour les extensions Copilot.

Ce guide utilise une implémentation d’agent simple, mais le processus est similaire pour les ensembles de compétences. Pour plus d’informations sur la différence entre les agents et les ensembles de compétences, consultez About GitHub Copilot Extensions.

Ce guide de démarrage rapide est conçu pour vous aider à créer et à discuter avec l’extension Blackbeard le plus rapidement possible, afin de pouvoir développer et tester votre extension sans déployer l’infrastructure. Pour la production, vous devrez héberger l'application pour les points de terminaison de votre agent ou de votre ensemble de compétences sur un serveur accessible au public. Pour savoir comment créer une nouvelle Extension GitHub Copilot, consultez Configuration des extensions Copilot.

1. Créez et installez une GitHub App

Dans les paramètres de développement de votre compte GitHub, créez une GitHub App. Votre GitHub App doit avoir :

Un nom
L’URL de la page d’accueil
Webhooks désélectionnés

Après avoir créé votre application, cliquez sur Installer l’application dans la barre latérale, puis installez votre application sur votre compte.

Pour obtenir des instructions détaillées, consultez Création d’une application GitHub pour votre extension Copilot.

2. Clonez et hébergez localement l’agent Blackbeard

Plutôt que de déployer l'agent Blackbeard en tant qu'application web, vous pouvez héberger votre agent localement, ce qui accélère considérablement le processus de construction.

En utilisant le Terminal intégré dans VS Code, clonez le référentiel copilot-extensions/blackbeard-extension.
Dans le même Terminal, exécutez npm install pour installer les dépendances nécessaires, puis exécutez npm start pour démarrer l’agent Blackbeard sur le port 3000.
Dans l’onglet « Ports » du panneau VS Code, cliquez sur ** Transmettre un port** ou Ajouter un port, puis ajoutez le port 3000.
Faites un clic droit sur le port et définissez la visibilité sur « Public », puis copiez l’adresse locale.

3. Intégrez et testez l’extension Blackbeard

Après avoir configuré votre GitHub App et l’agent Blackbeard, vous pouvez intégrer l’agent à votre application et tester l’extension Blackbeard. Vous devez apporter les modifications suivantes à vos paramètres GitHub App :

Dans les paramètres « Généraux », dans le champ « URL de rappel », collez l’adresse locale de votre agent.
Dans les paramètres « Autorisations et événements », accordez des autorisations en lecture seule à Copilot Chat.
Dans les paramètres « Copilot », réglez votre type d’application sur « Agent », puis remplissez les champs restants.

Après avoir mis à jour vos paramètres GitHub App, vous pouvez commencer à dialoguer avec votre extension en tapant @YOUR-EXTENSION-NAME dans la fenêtre Copilot Chat, puis en envoyant une requête comme d’habitude.

Pour obtenir des instructions plus détaillées, consultez Configuration de votre application GitHub pour votre agent Copilot.

2. Clonez et hébergez l’agent Blackbeard dans le codespace

Plutôt que de déployer l’agent Blackbeard en tant qu’application web, vous pouvez héberger votre agent dans le codespace, ce qui accélère considérablement le processus de génération.

Naviguez jusqu’au référentiel copilot-extensions/blackbeard-extension. Sélectionnez le menu déroulant Code , puis cliquez sur Créer un codespace sur main.
Pour trouver votre nouveau codespace, sélectionnez le menu déroulant Code À côté de votre nouveau codespace, sélectionnez , puis cliquez sur Ouvrir dans le navigateur.
Dans le terminal intégré, exécutez npm start pour démarrer l’agent Blackbeard sur le port 3000.
Dans l’onglet « Ports » du panneau VS Code, cliquez sur ** Transmettre un port**, puis ajoutez le port 3000.
Faites un clic droit sur le port et définissez la visibilité sur « Public », puis copiez l’adresse locale.

3. Intégrez et testez l’extension Blackbeard

Après avoir configuré votre GitHub App et l’agent Blackbeard, vous pouvez intégrer l’agent à votre application et tester l’extension Blackbeard. Vous devez apporter les modifications suivantes à vos paramètres GitHub App :

Dans les paramètres « Généraux », dans le champ « URL de rappel », collez l’adresse transmise de votre agent.
Dans les paramètres « Autorisations et événements », accordez des autorisations en lecture seule à Copilot Chat.
Dans les paramètres « Copilot », réglez votre type d’application sur « Agent », puis remplissez les champs restants.

Après avoir mis à jour vos paramètres GitHub App, vous pouvez commencer à dialoguer avec votre extension en tapant @YOUR-EXTENSION-NAME dans la fenêtre Copilot Chat d’un client ou d’un IDE pris en charge, puis en envoyant une requête comme d’habitude. Pour une liste de clients et d'IDE pris en charge, consultez About GitHub Copilot Extensions.

Remarque

Les conversations avec Extensions GitHub Copilot dans GitHub Codespaces ne sont pas prises en charge.

Pour obtenir des instructions plus détaillées, consultez Configuration de votre application GitHub pour votre agent Copilot.

2. Clonez et démarrez localement l’agent Blackbeard

Plutôt que de déployer l'agent Blackbeard en tant qu'application web, vous pouvez héberger votre agent localement, ce qui accélère considérablement le processus de construction.

À l’aide de votre application de ligne de commande, clonez le référentiel copilot-extensions/blackbeard-extension.
Exécutez npm install pour installer les dépendances nécessaires, puis exécutez npm start pour démarrer l’agent Blackbeard sur le port 3000.

3. Exposez votre serveur local

Pour rendre l’agent Blackbeard accessible à la plateforme Copilot et GitHub, vous devez exposer votre serveur local afin qu’il soit accessible par des requêtes HTTP. Pour ce faire, vous pouvez utiliser n’importe quel service de transfert de port ou de tunneling. Pour les étapes suivantes, nous utiliserons ngrok.

Accédez à la page de téléchargement de ngrok, puis installez la version de ngrok correspondant à votre système d’exploitation.
Accédez à la page de configuration et d’installation de ngrok, puis connectez-vous ou créez un compte ngrok.
Pour exposer votre serveur local, dans une nouvelle fenêtre de votre application de ligne de commande, exécutez la commande suivante :
Shell
```
ngrok http http://localhost:3000
```
```
ngrok http http://localhost:3000
```
Dans votre application de ligne de commande, à côté de « Transfert », copiez l’URL attribuée par ngrok à votre serveur.

4. Intégrez et testez l’extension Blackbeard

Pour intégrer votre GitHub App à l’agent Blackbeard, vous devez apporter les modifications suivantes aux paramètres de votre application :

Dans les paramètres « Généraux », dans le champ « URL de rappel », collez l’URL de votre serveur exposé.
Dans les paramètres « Autorisations et événements », accordez des autorisations en lecture seule à Copilot Chat.
Dans les paramètres « Copilot », réglez votre type d’application sur « Agent », puis remplissez les champs restants.

Après avoir mis à jour vos paramètres GitHub App, vous pouvez commencer à dialoguer avec votre extension en tapant @YOUR-EXTENSION-NAME dans la fenêtre Copilot Chat, puis en envoyant une requête comme d’habitude.

Pour obtenir des instructions plus détaillées, consultez Configuration de votre application GitHub pour votre agent Copilot.

Étapes suivantes

Maintenant que vous disposez d’une Extension GitHub Copilot fonctionnelle, vous pouvez essayer de générer l’agent Blackbeard pour expérimenter le développement d'un agent.

Pour en savoir plus sur la mise en œuvre d’agents plus complexes, vous pouvez également examiner les exemples d’agents et le kit de développement logiciel (SDK) suivants, qui sont tous disponibles dans l’organisation copilot-extensions :

GitHub Models : un agent plus complexe qui vous permet de poser des questions et d’interagir avec divers LLM référencés sur la GitHub Marketplace par le biais de Copilot Chat. L’agent GitHub Models utilise l’appel de fonction.
Appel de fonction : un exemple d’agent écrit en Go qui démontre l’appel de fonction et les dialogues de confirmation.
Extension RAG : un exemple d’agent écrit en Go qui démontre une implémentation simple de la génération augmentée de récupération.
Kit de développement logiciel (SDK) en préversion : un Kit de développement logiciel (SDK) qui rationalise le développement de Extensions Copilot en gérant automatiquement la vérification de la demande, l’analyse de la charge utile et le formatage de la réponse. Ce Kit de développement logiciel (SDK) permet aux créateurs d’extensions de se concentrer davantage sur la création de fonctionnalités principales et moins sur le code réutilisable.