Создание маркетплейса плагинов для GitHub Copilot CLI

Вы можете сделать созданные вами плагины CLI простыми для установки, добавив их на маркетплейс.

В этой статье

Введение

Маркетплейсы плагинов — это реестры плагинов для Второй пилот CLI. Они могут находиться на GitHub.com, в любом другом онлайн-хостинге Git, либо в вашей локальной или общей файловой системе. Создавая маркетплейс и добавляя туда свои плагины, вы сможете облегчить другим пользователям поиск и установку ваших плагинов.

Примечание.

Помощь по использованию плагинов можно найти copilot plugin [SUBCOMMAND] --help в терминале.

Предпосылка

Вы создали один или несколько плагинов, которыми хотите поделиться. См . раздел AUTOTITLE.

Создание маркетплейса плагинов

Создайте marketplace.json файл, который содержит метаданные о вашем маркетплейсе и содержит список доступных на рынке плагинов.

Примечание.

       `marketplace.json` Файл — единственный необходимый компонент на рынке плагинов. Добавление его в репозиторий позволяет Второй пилот CLI распознавать репозиторий как маркетплейс плагинов и предоставляет удобный способ для пользователей устанавливать плагины.

       **Пример `marketplace.json` файла**

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

Онлайн-примеры:

marketplace.json в репозитории github/copilot-plugins.
marketplace.json в репозитории github/awesome-copilot.

Верхнее поле plugins — это массив объектов плагинов, каждый из которых содержит метаданные о плагине, включая его название, описание, версию и исходный код.

Значение source поля для каждого плагина — это путь к каталогу плагина относительно корня репозитория. Не обязательно использовать ./ его в начале пути. Например "./plugins/plugin-name" , и "plugins/plugin-name" разрешить в одну и ту же папку.

Для подробностей полного набора полей, которые вы можете включить в этот файл, смотрите Ссылка на плагин GitHub Copilot CLI.

Добавьте файл marketplace.json в каталог .github/plugin репозитория.

Примечание.

Второй пилот CLI также ищет marketplace.json файл в .claude-plugin/ каталоге.
Для каждого плагина, определённого в marketplace.json файле, добавьте соответствующую папку плагина в соответствующее место репозитория.

Например, если в вашем marketplace.json файле есть плагин с "source": "./plugins/frontend-design", добавьте frontend-design папку плагинов в plugins корне вашего репозитория.
Поделитесь репозиторием с целевой аудиторией и дайте им инструкции по добавлению маркетплейса в Второй пилот CLI. Например, если ваш репозиторий размещён в GitHubocto-org/octo-repo репозитории, попросите пользователей ввести:
Shell
```
copilot plugin marketplace add octo-org/octo-repo
```
```
copilot plugin marketplace add octo-org/octo-repo
```

Дополнительные материалы