Creación de un complemento para la CLI de GitHub Copilot

Introducción

Plugins son paquetes que amplían la funcionalidad de CLI de Copilot. Consulta Acerca de los complementos para CLI de GitHub Copilot.

Nota:

Puede encontrar ayuda sobre el uso de complementos escribiendo copilot plugin [SUBCOMMAND] --help en el terminal.

Un complemento consta de un directorio con una estructura específica. Como mínimo, debe contener un plugin.json archivo de manifiesto en la raíz del directorio. También puede contener cualquier combinación de agentes, aptitudes, enlaces y configuraciones de servidor MCP.

Estructura del complemento de ejemplo

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)

Creación de un complemento

Cree un directorio para el complemento.

Agregue un plugin.json archivo de manifiesto a la raíz del directorio.

       **Archivo de ejemplo `plugin.json`**

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"
}

Para obtener más información sobre el conjunto completo de campos que puede incluir en este archivo, consulte Referencia del complemento de la CLI de Copilot de GitHub.

Agregue algunos componentes al complemento mediante la creación de los archivos y directorios adecuados para agentes, aptitudes, enlaces y configuraciones de servidor MCP.

Por ejemplo:
1. Agregue un agente mediante la creación de un NAME.agent.md archivo en un agents subdirectorio.
  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. Agregue una aptitud mediante la creación de un skills/NAME subdirectorio del directorio del complemento, donde NAME es el nombre de la aptitud. A continuación, dentro de este subdirectorio, cree un SKILL.md archivo que defina la aptitud.
  
  Por ejemplo, para crear una aptitud de "implementación", cree 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...
```
Instale el complemento localmente para que pueda probarlo a medida que lo desarrolle.

Por ejemplo, donde ./my-plugin es la ruta de acceso al directorio del complemento, escriba:
Shell
```
copilot plugin install ./my-plugin
```
```
copilot plugin install ./my-plugin
```
Compruebe que el complemento se cargó correctamente viendo la lista de complementos instalados:
Shell
```
copilot plugin list
```
```
copilot plugin list
```
O bien, puede iniciar una nueva sesión interactiva y escribir:
Copilot prompt
```
/plugin list
```
```
/plugin list
```
Compruebe que los agentes, aptitudes, enlaces y configuraciones del servidor MCP que ha definido se cargan correctamente.

Por ejemplo, en una sesión interactiva, para comprobar que los agentes personalizados definidos en el complemento se cargaron, escriba:
Copilot prompt
```
/agent
```
```
/agent
```
Para comprobar que las aptitudes definidas en el complemento se cargaron, escriba:
Copilot prompt
```
/skills list
```
```
/skills list
```
Use la funcionalidad proporcionada por los componentes del complemento para comprobar que cada componente funciona según lo previsto.
Itere en el desarrollo del complemento, según sea necesario.
Importante

Al instalar un complemento, sus componentes se almacenan en caché y la CLI lee de la memoria caché para sesiones posteriores. Para recoger los cambios realizados en un complemento local, instálelo de nuevo:
Shell
```
copilot plugin install ./my-plugin
```
```
copilot plugin install ./my-plugin
```
Una vez finalizadas las pruebas, puede desinstalar la versión local del complemento escribiendo lo siguiente:
Shell
```
copilot plugin uninstall NAME
```
```
copilot plugin uninstall NAME
```
Nota:

Para desinstalar un complemento, use el nombre del complemento como se especifica en el name campo del archivo de manifiesto del plugin.json complemento, no la ruta de acceso al directorio del complemento.

Distribución del complemento

Para distribuir el complemento, puede agregarlo a un marketplace. Consulta Creación de un marketplace de complementos para CLI de GitHub Copilot.

Lectura adicional

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

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