Skip to main content

Erstellen eines Plugin-Marktplatzes für den GitHub Copilot-CLI

Sie können CLI-Plug-Ins, die Sie erstellt haben, einfacher zur Installation machen, indem Sie sie zu einem Marktplatz hinzufügen.

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.

Hinweis

Hilfe zur Verwendung von Plugins finden Sie, indem Sie copilot plugin [SUBCOMMAND] --help im Terminal eingeben.

Voraussetzung

Sie haben ein oder mehrere Plug-Ins erstellt, die Sie freigeben möchten. Weitere Informationen findest du unter Erstellen eines Plugins 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. Durch das Hinzufügen zu einem Repository können Copilot-CLI das Repository als Plugin-Marketplace erkennen und benutzern eine einfache Möglichkeit zum Installieren von Plug-Ins bieten.

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

    Onlinebeispiele:

    •      [marketplace.json](https://github.com/github/copilot-plugins/blob/main/.github/plugin/marketplace.json) im [github/copilot-plugins Repository](https://github.com/github/copilot-plugins) .
      
    •      [marketplace.json](https://github.com/github/awesome-copilot/blob/main/.github/plugin/marketplace.json) im [Github/awesome-copilot Repository](https://github.com/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.

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

    Hinweis

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

  3. 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.

  4. Teilen Sie das Repository mit Ihren Zielbenutzern und geben Sie ihnen Anweisungen, wie sie den Marktplatz zu Copilot-CLI hinzufügen können. Wenn Ihr Repository beispielsweise auf GitHub im octo-org/octo-repo Repository gehostet wird, weisen Sie die Benutzer an, Folgendes einzugeben:

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

Weiterführende Lektüre

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