Skip to main content

GitHub Copilot CLI(コマンドラインインターフェース) のプラグイン マーケットプレースの作成

作成した CLI プラグインをマーケットプレースに追加することで、簡単にインストールできます。

イントロダクション

プラグイン マーケットプレースは、 Copilot CLI のプラグインのレジストリです。 GitHub.com、その他のオンライン Git ホスティング サービス、またはローカルまたは共有ファイル システムに配置できます。 マーケットプレースを作成し、プラグインを追加することで、他のユーザーがプラグインを簡単に見つけてインストールできるようになります。

メモ

ターミナルで copilot plugin [SUBCOMMAND] --help を入力すると、プラグインの使用に関するヘルプが表示されます。

前提条件

共有する 1 つ以上のプラグインを作成しました。 「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"
        }
      ]
    }
    

    オンラインの例:

    •      [github/copilot-plugins](https://github.com/github/copilot-plugins/blob/main/.github/plugin/marketplace.json) リポジトリに [marketplace.json](https://github.com/github/copilot-plugins) します。
      
    •      [github/awesome-copilot](https://github.com/github/awesome-copilot/blob/main/.github/plugin/marketplace.json) リポジトリに [marketplace.json](https://github.com/github/awesome-copilot) します。
      

    最上位の plugins フィールドはプラグイン オブジェクトの配列であり、それぞれにプラグインに関するメタデータ (名前、説明、バージョン、ソースなど) が含まれます。

    各プラグインの source フィールドの値は、リポジトリのルートを基準としたプラグインのディレクトリへのパスです。 パスの先頭で ./ を使用する必要はありません。 たとえば、"./plugins/plugin-name""plugins/plugin-name" は同じディレクトリに解決されます。

    このファイルに含めることができるフィールドの完全なセットの詳細については、 GitHub Copilot CLI プラグイン リファレンス を参照してください。

  2.        `marketplace.json` ファイルをリポジトリの`.github/plugin` ディレクトリに追加します。
    

    メモ

    Copilot CLI は、marketplace.json ディレクトリ内の.claude-plugin/ ファイルも検索します。

  3.        `marketplace.json` ファイルで定義されているプラグインごとに、関連するプラグイン ディレクトリをリポジトリ内の適切な場所に追加します。
    

    たとえば、marketplace.json ファイルに "source": "./plugins/frontend-design" を含むプラグインが含まれている場合は、リポジトリのルートにある frontend-design ディレクトリに plugins プラグイン ディレクトリを追加します。

  4. リポジトリを目的のユーザーと共有し、Copilot CLI にマーケットプレースを追加する手順を提供します。 たとえば、リポジトリが octo-org/octo-repo リポジトリの GitHub でホストされている場合は、ユーザーに次のように入力するように指示します。

    Shell
    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)