Creación de un marketplace de complementos para CLI de GitHub Copilot

Introducción

Los marketplaces de complementos son registros de complementos para CLI de Copilot. Se pueden ubicar en GitHub.com, en cualquier otro servicio de hospedaje de Git en línea, o en el sistema de archivos local o compartido. Mediante la creación de un marketplace y la adición de complementos a él, puede facilitar a otros usuarios encontrar e instalar sus complementos.

Prerrequisito

Ha creado uno o varios complementos que desea compartir. Consulta Creación de un complemento para CLI de GitHub Copilot.

Creación de un marketplace de complementos

1. Cree un marketplace.json archivo que proporcione metadatos sobre marketplace y muestre los complementos que están disponibles en Marketplace.

   Nota:

   El marketplace.json archivo es el único componente necesario de un marketplace de complementos. Agregarlo a un repositorio permite CLI de Copilot reconocer el repositorio como un marketplace de complementos y proporciona una manera sencilla para que los usuarios instalen complementos.

Archivo de ejemplo marketplace.json

{
  "name": "my-marketplace",
  "owner": {
    "name": "Your Organization",
    "email": "plugins@example.com"
  },
  "metadata": {
    "description": "Curated plugins for our team",
    "version": "1.0.0"
  },
  "plugins": [
    {
      "name": "frontend-design",
      "description": "Create a professional-looking GUI ...",
      "version": "2.1.0",
      "source": "./plugins/frontend-design"
    },
    {
      "name": "security-checks",
      "description": "Check for potential security vulnerabilities ...",
      "version": "1.3.0",
      "source": "./plugins/security-checks"
    }
  ]
}

{
  "name": "my-marketplace",
  "owner": {
    "name": "Your Organization",
    "email": "plugins@example.com"
  },
  "metadata": {
    "description": "Curated plugins for our team",
    "version": "1.0.0"
  },
  "plugins": [
    {
      "name": "frontend-design",
      "description": "Create a professional-looking GUI ...",
      "version": "2.1.0",
      "source": "./plugins/frontend-design"
    },
    {
      "name": "security-checks",
      "description": "Check for potential security vulnerabilities ...",
      "version": "1.3.0",
      "source": "./plugins/security-checks"
    }
  ]
}

Ejemplos en línea:

• marketplace.json en el repositorio github/copilot-plugins.
• marketplace.json en el repositorio github/awesome-copilot.

El campo de nivel plugins superior es una matriz de objetos de complemento, cada uno que contiene metadatos sobre un complemento, incluido su nombre, descripción, versión y origen.

El valor del source campo para cada complemento es la ruta de acceso al directorio del complemento, en relación con la raíz del repositorio. No es necesario usar ./ al principio de la ruta de acceso. Por ejemplo, "./plugins/plugin-name" y "plugins/plugin-name" se resuelven en el mismo directorio.

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

1. Agregue el archivo /> <c1 de un repositorio.

   Nota:

   CLI de Copilot también busca el archivo marketplace.json en el directorio .claude-plugin/.

2. Para cada complemento definido en el marketplace.json archivo, agregue el directorio del complemento correspondiente a la ubicación adecuada en el repositorio.

   Por ejemplo, si el marketplace.json archivo incluye un complemento con "source": "./plugins/frontend-design", agregue el frontend-design directorio del complemento al plugins directorio en la raíz del repositorio.

3. Comparta el repositorio con los usuarios previstos y brinde instrucciones para agregar el marketplace a CLI de Copilot. Por ejemplo, si el repositorio está hospedado en GitHub en el octo-org/octo-repo repositorio, indique a los usuarios que escriban:

   Shell

   copilot plugin marketplace add octo-org/octo-repo
   

Lectura adicional

• Búsqueda e instalación de complementos para CLI de GitHub Copilot
• Referencia del plugin CLI de GitHub Copilot