为 GitHub Copilot 命令行界面 (CLI) 创建插件市场

介绍

插件市场是插件 Copilot 命令行界面（CLI）的注册表。 它们可以位于GitHub.com上、任何其他在线 Git 托管服务上，或者在您的本地或共享文件系统中。 通过创建市场并向其添加插件，可以让其他用户轻松查找和安装插件。

先决条件

已创建一个或多个要共享的插件。 请参阅“为 GitHub Copilot 命令行界面 (CLI) 创建插件”。

创建插件市场

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

   注意

   该文件 marketplace.json 是插件市场的唯一必需组件。 将其添加到存储库允许 Copilot 命令行界面（CLI） 将存储库识别为插件市场，并为用户提供安装插件的简单方法。

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

联机示例：

• github/copilot-plugins 存储库中的 marketplace.json。
• marketplace.json在 github/awesome-copilot 存储库中。

顶级 plugins 字段是插件对象的数组，每个对象都包含有关插件的元数据，包括其名称、说明、版本和源。

每个插件的 source 字段值是插件目录的路径，相对于存储库的根目录。 不需要在路径的开头使用 ./ 。 例如，"./plugins/plugin-name" 和 "plugins/plugin-name" 指向同一目录。

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

1. 将 marketplace.json 文件添加到存储库的 .github/plugin 目录中。

   注意

   Copilot 命令行界面（CLI） 还会在 .claude-plugin/ 目录中查找 marketplace.json 文件。

2. 对于文件中定义的 marketplace.json 每个插件，请将相关插件目录添加到存储库中的相应位置。

   例如，如果 marketplace.json 文件包含一 "source": "./plugins/frontend-design"个插件，请将 frontend-design 插件目录添加到 plugins 存储库根目录。

3. 与预期用户共享存储库，并向他们提供将应用商店添加到 Copilot 命令行界面（CLI） 的说明。 例如，如果你的存储库托管在 octo-org/octo-repo 存储库中的 GitHub 上，指导用户输入：

   Shell

   copilot plugin marketplace add octo-org/octo-repo
   

延伸阅读

• 查找并安装插件适用于GitHub Copilot 命令行界面 (CLI)
• GitHub Copilot CLI 插件参考