Erstellen eines Plugin-Marketplace für GitHub Copilot-CLI

Einleitung

Plugin-Marketplaces sind Registrierungen von Plugins für Copilot CLI. Sie können sich auf GitHub.com, in jedem anderen Online-Git-Hostingdienst oder in Ihrem lokalen oder freigegebenen Dateisystem befinden. Indem Sie einen Marketplace erstellen und Ihre Plug-Ins hinzufügen, können Sie es anderen Benutzern erleichtern, Ihre Plug-Ins zu finden und zu installieren.

Voraussetzung

Sie haben ein oder mehrere Plug-Ins erstellt, die Sie freigeben möchten. Weitere Informationen findest du unter Erstellen eines Plug-Ins für GitHub Copilot-CLI.

Erstellen eines Plug-In-Marketplace

1. Erstellen Sie eine marketplace.json Datei, die Metadaten zu Ihrem Marketplace bereitstellt, und listet die Plugins auf, die auf dem Marketplace verfügbar sind.

   Hinweis

   Die marketplace.json Datei ist die einzige erforderliche Komponente eines Plug-In-Marketplace. Wenn Sie es zu einem Repository hinzufügen, können Sie Copilot CLI das Repository als Plugin-Marketplace erkennen und benutzern eine einfache Möglichkeit zum Installieren von Plug-Ins bieten.

Beispieldatei 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"
    }
  ]
}

Onlinebeispiele:

• marketplace.json im Repository github/copilot-plugins.
• marketplace.json im Repository github/awesome-copilot.

Das Feld auf oberster Ebene plugins ist ein Array von Plug-In-Objekten, die metadaten zu einem Plug-In enthalten, einschließlich Name, Beschreibung, Version und Quelle.

Der Wert des source Felds für jedes Plug-In ist der Pfad zum Verzeichnis des Plug-Ins relativ zum Stamm des Repositorys. Es ist nicht erforderlich, am Anfang des Pfads zu verwenden ./ . Beispiel: "./plugins/plugin-name" und "plugins/plugin-name" führen zum selben Verzeichnis.

Ausführliche Informationen zu den vollständigen Feldern, die Sie in diese Datei aufnehmen können, finden Sie unter GitHub Copilot CLI-Plug-In-Referenz.

1. Fügen Sie die Datei marketplace.json zum Verzeichnis .github/plugin eines Repositorys hinzu.

   Hinweis

   Copilot CLI sucht auch nach der marketplace.json Datei im .claude-plugin/ Verzeichnis.

2. Fügen Sie für jedes in der marketplace.json Datei definierte Plug-In das entsprechende Plug-In-Verzeichnis dem entsprechenden Speicherort im Repository hinzu.

   Wenn Ihre marketplace.json-Datei beispielsweise ein Plugin mit "source": "./plugins/frontend-design" enthält, fügen Sie das frontend-design-Verzeichnis zum Stammverzeichnis Ihres Repositories plugins hinzu.

3. Teilen Sie das Repository mit Ihren beabsichtigten Benutzern, und stellen Sie ihnen Anweisungen bereit, um den Marketplace Copilot CLIhinzuzufügen. Wenn Ihr Repository beispielsweise im GitHub Repository octo-org/octo-repo gehostet wird, weisen Sie Benutzer an, Folgendes einzugeben:

   Shell

   copilot plugin marketplace add octo-org/octo-repo
   

Weiterführende Lektüre

• Suchen und Installieren von Plug-Ins für GitHub Copilot-CLI
• GitHub Copilot CLI-Plug-In-Referenz