OmniRoute/docs/i18n/de/docs/frameworks/PLUGINS.md

OmniRoute CLI Plugin System (Deutsch)

🌐 Languages: 🇺🇸 English · 🇪🇹 am · 🇸🇦 ar · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇨🇿 cs · 🇩🇰 da · 🇬🇷 el · 🇪🇸 es · 🇪🇪 et · 🇮🇷 fa · 🇫🇮 fi · 🇫🇷 fr · 🇮🇪 ga · 🇮🇳 gu · 🇳🇬 ha · 🇮🇱 he · 🇮🇳 hi · 🇭🇷 hr · 🇭🇺 hu · 🇦🇲 hy · 🇮🇩 id · 🇳🇬 ig · 🇮🇹 it · 🇯🇵 ja · 🇬🇪 ka · 🇰🇭 km · 🇮🇳 kn · 🇰🇷 ko · 🇱🇹 lt · 🇱🇻 lv · 🇮🇳 ml · 🇮🇳 mr · 🇲🇾 ms · 🇲🇹 mt · 🇲🇲 my · 🇳🇵 ne · 🇳🇱 nl · 🇳🇴 no · 🇮🇳 or · 🇮🇳 pa · 🇵🇭 phi · 🇵🇱 pl · 🇵🇹 pt · 🇧🇷 pt-BR · 🇷🇴 ro · 🇷🇺 ru · 🇱🇰 si · 🇸🇰 sk · 🇸🇮 sl · 🇷🇸 sr · 🇸🇪 sv · 🇰🇪 sw · 🇮🇳 ta · 🇮🇳 te · 🇹🇭 th · 🇹🇷 tr · 🇺🇦 uk-UA · 🇵🇰 ur · 🇺🇿 uz · 🇻🇳 vi · 🇳🇬 yo · 🇨🇳 zh-CN · 🇹🇼 zh-TW

---

Erweitere die omniroute-CLI, ohne ihren Kern zu verändern. Plugins folgen der Namenskonvention omniroute-cmd-*, ähnlich wie gh extension oder kubectl plugin.

Schnellstart

# Ein Plugin von npm installieren
omniroute plugin install stripe

# Ein lokales Plugin in der Entwicklung installieren
omniroute plugin install ./my-plugin

# Installierte Plugins auflisten
omniroute plugin list

# Ein Grundgerüst für ein neues Plugin erstellen
omniroute plugin scaffold myplugin
cd omniroute-cmd-myplugin
omniroute plugin install .

Aufbau eines Plugins

Ein Plugin ist ein npm-Paket mit dem Namen omniroute-cmd-<name> (oder @scope/omniroute-cmd-<name>).

omniroute-cmd-myplugin/
├── package.json     # muss "type": "module" und "main": "index.mjs" enthalten
├── index.mjs        # exportiert register(program, ctx) sowie optional meta
└── README.md

package.json

{
  "name": "omniroute-cmd-myplugin",
  "version": "0.1.0",
  "type": "module",
  "main": "index.mjs",
  "engines": { "omniroute": ">=4.0.0" },
  "keywords": ["omniroute-plugin", "omniroute-cmd"]
}

index.mjs

export const meta = {
  name: "myplugin",
  version: "0.1.0",
  description: "My plugin for OmniRoute",
  omnirouteApi: ">=4.0.0",
};

export function register(program, ctx) {
  program
    .command("myplugin")
    .description(meta.description)
    .option("-n, --name <name>")
    .action(async (opts, cmd) => {
      const gOpts = cmd.optsWithGlobals();
      const res = await ctx.apiFetch("/api/combos", {
        baseUrl: gOpts.baseUrl,
        apiKey: gOpts.apiKey,
      });
      const data = await res.json();
      ctx.emit(data, gOpts);
    });
}

Plugin-Kontext-API

Das an register(program, ctx) übergebene ctx-Objekt:

Eigenschaft	Typ	Beschreibung
ctx.apiFetch(path, opts)	async function	Authentifizierter Abruf vom OmniRoute-Server
ctx.emit(data, opts)	function	Ausgabe als Tabelle/json/jsonl/csv entsprechend der Option --output
ctx.t(key)	async function	Nachschlagen von i18n-Übersetzungen
ctx.withSpinner(label, fn)	async function	Umschließt die asynchrone Funktion mit einem ora-Spinner
ctx.baseUrl	string	Aufgelöste Basis-URL
ctx.apiKey	string | null	API-Schlüssel, sofern angegeben

Erkennung

Plugins werden an folgenden Orten gesucht:

1. ~/.omniroute/plugins/<name>/ — benutzerlokale Installationen
2. Umgebungsvariable OMNIROUTE_PLUGIN_PATH — benutzerdefiniertes Verzeichnis

Beide gelten nur für die CLI. Die serverseitige Plugin-Laufzeitumgebung (die Marketplace-/plugin.json-Plugins, die innerhalb des Proxys ausgeführt werden) besitzt einen eigenen Scanner mit einer eigenen Überschreibung namens OMNIROUTE_PLUGINS_DIR — siehe PLUGIN_MARKETPLACE.md → Plugin-Verzeichnis. Das Festlegen der einen Option hat keine Auswirkungen auf die andere.

Fehler beim Laden werden abgefangen und als Warnungen ausgegeben — ein defektes Plugin bringt die CLI niemals zum Absturz.

Sicherheit

Plugins werden mit denselben Node.js-Prozessberechtigungen wie omniroute ausgeführt. Installiere nur Plugins aus Quellen, denen du vertraust. omniroute plugin install zeigt eine ausdrückliche Warnung an und erfordert entweder --yes oder eine interaktive Bestätigung.

Veröffentlichung

1. Stelle sicher, dass package.json den Eintrag "keywords": ["omniroute-plugin"] enthält
2. Führe npm publish wie gewohnt aus
3. Benutzer finden Plugins über omniroute plugin search <query> (durchsucht die npm-Registry)

Beispiel-Plugin

Unter examples/omniroute-cmd-hello/ findest du ein minimales funktionsfähiges Beispiel mit meta und register().