为 GitHub Copilot CLI 创建插件市场

简介

插件市场是 Copilot CLI 插件的注册表。它们可以位于 GitHub.com、任何其他在线 Git 托管服务，或您本地或共享的文件系统中。通过创建市场并将您的插件添加到其中，您可以让其他用户更容易找到并安装您的插件。

先决条件

您已创建一个或多个想要分享的插件。请参阅 为 GitHub Copilot CLI 创建插件。

创建插件市场

1. 创建一个 marketplace.json 文件，用于提供有关您的市场的元数据并列出市场中可用的插件。

   注意

   `marketplace.json` 文件是插件市场唯一必需的组件。将其添加到代码库可让 Copilot 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"
       }
     ]
   }
   

   在线示例

   • marketplace.json 位于 github/copilot-plugins 代码库中。
   • marketplace.json 位于 github/awesome-copilot 代码库中。

   顶层的 plugins 字段是一个插件对象数组，每个对象包含插件的元数据，包括名称、描述、版本和来源。

   `source` 字段的值是插件目录的路径，相对于代码库根目录。不必在路径开头使用 `./`。例如，`"./plugins/plugin-name"` 和 `"plugins/plugin-name"` 指向同一目录。

   有关此文件中可包含的全部字段的详细信息，请参阅 GitHub Copilot CLI 插件参考。

2. 将 marketplace.json 文件添加到代码库的 .github/plugin 目录中。

   注意

   Copilot CLI 也会在 .claude-plugin/ 目录中查找 marketplace.json 文件。

3. 对于 marketplace.json 文件中定义的每个插件，请将相应的插件目录添加到代码库中的适当位置。

   例如，如果您的 marketplace.json 文件包含一个 `"source": "./plugins/frontend-design"` 的插件，请将 frontend-design 插件目录添加到代码库根目录下的 plugins 目录中。

4. 将代码库分享给目标用户，并向他们提供将市场添加到 Copilot CLI 的说明。例如，如果您的代码库托管在 GitHub 的 octo-org/octo-repo 中，请指示用户输入

   Shell

   copilot plugin marketplace add octo-org/octo-repo
   

延伸阅读

• 查找并安装 GitHub Copilot CLI 插件
• GitHub Copilot CLI 插件参考