Skip to main content

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

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

イントロダクション

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

メモ

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

前提条件

共有する 1 つ以上のプラグインを作成しました。 「用のプラグインを作成する GitHub Copilot CLI(コマンドラインインターフェース)」を参照してください。

プラグイン マーケットプレースの作成

  1. マーケットプレースに関するメタデータを提供し、マーケットプレースで使用可能なプラグインを一覧表示する marketplace.json ファイルを作成します。

    メモ

    marketplace.json ファイルは、プラグイン マーケットプレースの唯一の必須コンポーネントです。 リポジトリに追加すると、 Copilot CLI (コパイロット 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"
    }
  ]
}

オンラインの例:

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

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

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

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

    メモ

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

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

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

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

    Shell
    copilot plugin marketplace add octo-org/octo-repo
    

詳細については、次を参照してください。