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

OmniRoute CLI Plugin System (Dansk)

🌐 Languages: 🇺🇸 English · 🇪🇹 am · 🇸🇦 ar · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇨🇿 cs · 🇩🇪 de · 🇬🇷 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

---

Udvid omniroute-CLI'en uden at ændre dens kerne. Plugins følger navngivningskonventionen omniroute-cmd-*, ligesom gh extension eller kubectl plugin.

Hurtig start

# Installer et plugin fra npm
omniroute plugin install stripe

# Installer et lokalt plugin under udvikling
omniroute plugin install ./my-plugin

# Vis installerede plugins
omniroute plugin list

# Opret grundstrukturen til et nyt plugin
omniroute plugin scaffold myplugin
cd omniroute-cmd-myplugin
omniroute plugin install .

Et plugins opbygning

Et plugin er en npm-pakke med navnet omniroute-cmd-<name> (eller @scope/omniroute-cmd-<name>).

omniroute-cmd-myplugin/
├── package.json     # skal have "type": "module" og "main": "index.mjs"
├── index.mjs        # eksporterer register(program, ctx) + valgfri 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: "Mit plugin til 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);
    });
}

API for plugin-kontekst

ctx-objektet, der overføres til register(program, ctx):

Egenskab	Type	Beskrivelse
ctx.apiFetch(path, opts)	async function	Godkendt fetch-kald til OmniRoute-serveren
ctx.emit(data, opts)	function	Output i table/json/jsonl/csv i henhold til flaget --output
ctx.t(key)	async function	Opslag af i18n-oversættelse
ctx.withSpinner(label, fn)	async function	Omslutter asynkron fn med en ora-spinner
ctx.baseUrl	string	Den fortolkede basis-URL
ctx.apiKey	string | null	API-nøgle, hvis den er angivet

Registrering

Plugins registreres fra:

1. ~/.omniroute/plugins/<name>/ — bruger-lokale installationer
2. Miljøvariablen OMNIROUTE_PLUGIN_PATH — brugerdefineret mappe

Begge er kun til CLI'en. Plugin-kørselsmiljøet på serversiden (marketplace-/plugin.json-plugins, der kører inde i proxyen) har sin egen scanner med sin egen tilsidesættelse, OMNIROUTE_PLUGINS_DIR — se PLUGIN_MARKETPLACE.md → Plugin-mappe. Indstilling af den ene påvirker ikke den anden.

Indlæsningsfejl opfanges og udskrives som advarsler — et defekt plugin får aldrig CLI'en til at gå ned.

Sikkerhed

Plugins kører med de samme Node.js-procesrettigheder som omniroute. Installer kun plugins fra kilder, du har tillid til. omniroute plugin install viser en udtrykkelig advarsel og kræver --yes eller interaktiv bekræftelse.

Udgivelse

1. Sørg for, at package.json har "keywords": ["omniroute-plugin"]
2. Kør npm publish som normalt
3. Brugere kan finde plugins via omniroute plugin search <query> (søger i npm-registret)

Eksempelplugin

Se examples/omniroute-cmd-hello/ for et minimalt fungerende eksempel med meta + register().