Zum Inhalt springen
Dokumentation

Plugin-CLI

CLI zum Erstellen und Veröffentlichen von Plugins

Unsere Plugin-CLI macht es einfach, neue Plugins zu erstellen und im Plugin-Store zu veröffentlichen oder sie für den manuellen Upload auf eine Neleto-Instanz zu packen. Beim Erstellen eines neuen Plugins mit der CLI wird unser plugin-template geklont.

Installation

Du hast mehrere Möglichkeiten, die CLI zu installieren:

Aus Source kompilieren

Du musst das stabile Rust-Toolkit installiert haben Rust installieren.

Baue die Plugin-CLI aus dem Git-Repository:

cargo install --git https://github.com/Triple-A-Software/plugin-cli.git

Ein vorkompiliertes Binary herunterladen

Demnächst verfügbar

Via NPM

Demnächst verfügbar

Befehle

publish: Veröffentliche ein Plugin im Plugin-Store

package: Packe ein Plugin für den manuellen Upload

create <name>: Starte ein neues Plugin-Projekt mit dem angegebenen Namen

Vom Projekt zur Installation

Die CLI deckt den gesamten Lebenszyklus ab:

  1. create <name> erzeugt ein neues Projekt aus dem plugin-template.
  2. Entwickle dein Plugin (siehe Entwicklungsumgebung einrichten und Erste Schritte).
  3. Liefere es auf eine von zwei Arten aus:
    • package erzeugt ein .tar.gz, das du über Plugin hochladen auf der Plugins-Seite privat auf einer einzelnen Instanz installierst (siehe Plugin installieren).
    • publish veröffentlicht es im Plugin Store, aus dem jede Instanz es installieren und aktualisieren kann.
In den Beispiel-Plugins führt package immer zuerst den Build aus, damit das Archiv niemals ohne Binary ausgeliefert wird. Ein typisches justfile lässt package von build abhängen, die echten Build-Skripte findest du bei den Beispiel-Plugins.