Création d’un plug-in pour GitHub Copilot CLI

Présentation

Les plug-ins sont des packages qui étendent les fonctionnalités de Copilot CLI. Consultez À propos des plug-ins pour GitHub Copilot CLI.

Remarque

Vous trouverez de l’aide sur l’utilisation de plug-ins en entrant copilot plugin [SUBCOMMAND] --help dans le terminal.

Un plug-in se compose d’un répertoire avec une structure spécifique. Au minimum, il doit contenir un plugin.json fichier manifeste à la racine du répertoire. Il peut également contenir n’importe quelle combinaison d’agents, de compétences, de hooks et de configurations de serveur MCP.

Exemple de structure de plug-in

my-plugin/
├── plugin.json           # Required manifest
├── agents/               # Custom agents (optional)
│   └── helper.agent.md
├── skills/               # Skills (optional)
│   └── deploy/
│       └── SKILL.md
├── hooks.json            # Hook configuration (optional)
└── .mcp.json             # MCP server config (optional)

Création d’un plug-in

Créez un répertoire pour votre plug-in.

Ajoutez un plugin.json fichier manifeste à la racine du répertoire.

       **Exemple de `plugin.json` fichier**

JSON

{
  "name": "my-dev-tools",
  "description": "React development utilities",
  "version": "1.2.0",
  "author": {
    "name": "Jane Doe",
    "email": "jane@example.com"
  },
  "license": "MIT",
  "keywords": ["react", "frontend"],
  "agents": "agents/",
  "skills": ["skills/", "extra-skills/"],
  "hooks": "hooks.json",
  "mcpServers": ".mcp.json"
}

{
  "name": "my-dev-tools",
  "description": "React development utilities",
  "version": "1.2.0",
  "author": {
    "name": "Jane Doe",
    "email": "jane@example.com"
  },
  "license": "MIT",
  "keywords": ["react", "frontend"],
  "agents": "agents/",
  "skills": ["skills/", "extra-skills/"],
  "hooks": "hooks.json",
  "mcpServers": ".mcp.json"
}

Pour plus d’informations sur l’ensemble complet de champs que vous pouvez inclure dans ce fichier, consultez Références du plug-in CLI GitHub Copilot.

Ajoutez certains composants à votre plug-in en créant les fichiers et répertoires appropriés pour les agents, les compétences, les hooks et les configurations de serveur MCP.

Par exemple:
1. Ajoutez un agent en créant un NAME.agent.md fichier dans un agents sous-répertoire.
  Markdown
```
---
name: my-agent
description: Helps with specific tasks
tools: ["bash", "edit", "view"]
---

You are a specialized assistant that...
```
```
---
name: my-agent
description: Helps with specific tasks
tools: ["bash", "edit", "view"]
---

You are a specialized assistant that...
```
2. Ajoutez une compétence en créant un skills/NAME sous-répertoire de votre répertoire de plug-in, où NAME est le nom de votre compétence. Ensuite, dans ce sous-répertoire, créez un SKILL.md fichier qui définit la compétence.
  
  Par exemple, pour créer une compétence « déployer », créez skills/deploy/SKILL.md:
  Markdown
```
---
name: deploy
description: Deploy the current project to...
---

Instructions for the skill...
```
```
---
name: deploy
description: Deploy the current project to...
---

Instructions for the skill...
```
Installez votre plug-in localement pour pouvoir le tester lors de son développement.

Par exemple, où ./my-plugin est le chemin d’accès à votre répertoire de plug-in, entrez :
Shell
```
copilot plugin install ./my-plugin
```
```
copilot plugin install ./my-plugin
```
Vérifiez que le plug-in a été chargé correctement en consultant votre liste de plug-ins installés :
Shell
```
copilot plugin list
```
```
copilot plugin list
```
Vous pouvez également démarrer une nouvelle session interactive et entrer :
Copilot prompt
```
/plugin list
```
```
/plugin list
```
Vérifiez que les agents, compétences, hooks et configurations de serveur MCP que vous avez définies sont correctement chargés.

Par exemple, dans une session interactive, pour vérifier que les agents personnalisés définis dans le plug-in ont été chargés, entrez :
Copilot prompt
```
/agent
```
```
/agent
```
Pour vérifier que les compétences définies dans le plug-in ont été chargées, entrez :
Copilot prompt
```
/skills list
```
```
/skills list
```
Utilisez les fonctionnalités fournies par les composants de votre plug-in pour vérifier que chaque composant fonctionne comme prévu.
Itérer sur votre développement de plug-in, selon les besoins.
Important

Lorsque vous installez un plug-in, ses composants sont mis en cache et l’interface CLI lit à partir du cache pour les sessions suivantes. Pour récupérer les modifications apportées à un plug-in local, installez-le à nouveau :
Shell
```
copilot plugin install ./my-plugin
```
```
copilot plugin install ./my-plugin
```
Une fois le test terminé, vous pouvez désinstaller la version locale de votre plug-in en entrant :
Shell
```
copilot plugin uninstall NAME
```
```
copilot plugin uninstall NAME
```
Remarque

Pour désinstaller un plug-in, utilisez le nom du plug-in tel que spécifié dans le name champ du fichier manifeste du plugin.json plug-in, et non le chemin d’accès au répertoire du plug-in.

Distribution de votre plug-in

Pour distribuer votre plug-in, vous pouvez l’ajouter à une place de marché. Consultez Création d’un marketplace de plugins pour GitHub Copilot CLI.

Lectures complémentaires

        [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/plugins-finding-installing)

        [AUTOTITLE](/copilot/reference/cli-plugin-reference)