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

介绍

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

注意

可以通过在终端中输入 copilot plugin [SUBCOMMAND] --help 来查找有关使用插件的帮助。

先决条件

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

创建插件市场

创建一个 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"
    }
  ]
}

{
  "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](https://github.com/github/copilot-plugins/blob/main/.github/plugin/marketplace.json) 存储库中的 [marketplace.json](https://github.com/github/copilot-plugins)。

     [marketplace.json](https://github.com/github/awesome-copilot/blob/main/.github/plugin/marketplace.json)在 [github/awesome-copilot](https://github.com/github/awesome-copilot) 存储库中。

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

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

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

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

注意

Copilot 命令行界面（CLI）还会在 .claude-plugin/ 目录中查找 marketplace.json 文件。
对于文件中定义的 marketplace.json 每个插件，请将相关插件目录添加到存储库中的相应位置。

例如，如果 marketplace.json 文件包含一 "source": "./plugins/frontend-design"个插件，请将 frontend-design 插件目录添加到 plugins 存储库根目录。
与目标用户共享该存储库，并向他们提供将市场添加到 Copilot 命令行界面（CLI）的说明。例如，如果存储库托管在 octo-org/octo-repo 存储库中的 GitHub 上，则指示用户输入：
Shell
```
copilot plugin marketplace add octo-org/octo-repo
```
```
copilot plugin marketplace add octo-org/octo-repo
```

延伸阅读

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

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

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

在本文中

介绍

先决条件

创建插件市场

延伸阅读