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

OmniRoute CLI Plugin System (Norsk)

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

---

Utvid omniroute-CLI-et uten å endre kjernen. Programtillegg følger navnekonvensjonen omniroute-cmd-*, tilsvarende gh extension eller kubectl plugin.

Hurtigstart

# Installer et programtillegg fra npm
omniroute plugin install stripe

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

# Vis installerte programtillegg
omniroute plugin list

# Opprett grunnstrukturen for et nytt programtillegg
omniroute plugin scaffold myplugin
cd omniroute-cmd-myplugin
omniroute plugin install .

Oppbygning av programtillegg

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

omniroute-cmd-myplugin/
├── package.json     # må ha "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: "Mitt programtillegg 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);
    });
}

Kontekst-API for programtillegg

ctx-objektet som sendes til register(program, ctx):

Egenskap	Type	Beskrivelse
ctx.apiFetch(path, opts)	async function	Autentisert forespørsel til OmniRoute-serveren
ctx.emit(data, opts)	function	Utdata som table/json/jsonl/csv basert på --output-flagget
ctx.t(key)	async function	Oppslag av i18n-oversettelse
ctx.withSpinner(label, fn)	async function	Pakker inn asynkron fn med en ora-spinner
ctx.baseUrl	string	Løst basis-URL
ctx.apiKey	string | null	API-nøkkel hvis angitt

Oppdagelse

Programtillegg oppdages fra:

1. ~/.omniroute/plugins/<name>/ — brukerlokale installasjoner
2. Miljøvariabelen OMNIROUTE_PLUGIN_PATH — egendefinert katalog

Begge gjelder kun CLI-et. Kjøremiljøet for programtillegg på serversiden (markedsplassen/plugin.json-programtillegg som kjører inne i proxyen) har sin egen skanner med sin egen overstyring, OMNIROUTE_PLUGINS_DIR — se PLUGIN_MARKETPLACE.md → Katalog for programtillegg. Innstilling av den ene påvirker ikke den andre.

Innlastingsfeil fanges opp og skrives ut som advarsler — et defekt programtillegg krasjer aldri CLI-et.

Sikkerhet

Programtillegg kjører med de samme Node.js-prosessrettighetene som omniroute. Installer bare programtillegg fra kilder du stoler på. omniroute plugin install viser en uttrykkelig advarsel og krever --yes eller interaktiv bekreftelse.

Publisering

1. Sørg for at package.json har "keywords": ["omniroute-plugin"]
2. Kjør npm publish som normalt
3. Brukere finner dem via omniroute plugin search <query> (søker i npm-registeret)

Eksempel på programtillegg

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