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

OmniRoute CLI Plugin System (Svenska)

🌐 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 · 🇳🇴 no · 🇮🇳 or · 🇮🇳 pa · 🇵🇭 phi · 🇵🇱 pl · 🇵🇹 pt · 🇧🇷 pt-BR · 🇷🇴 ro · 🇷🇺 ru · 🇱🇰 si · 🇸🇰 sk · 🇸🇮 sl · 🇷🇸 sr · 🇰🇪 sw · 🇮🇳 ta · 🇮🇳 te · 🇹🇭 th · 🇹🇷 tr · 🇺🇦 uk-UA · 🇵🇰 ur · 🇺🇿 uz · 🇻🇳 vi · 🇳🇬 yo · 🇨🇳 zh-CN · 🇹🇼 zh-TW

---

Utöka CLI:t omniroute utan att ändra dess kärna. Insticksprogram följer namnkonventionen omniroute-cmd-*, på liknande sätt som gh extension eller kubectl plugin.

Snabbstart

# Installera ett insticksprogram från npm
omniroute plugin install stripe

# Installera ett lokalt insticksprogram under utveckling
omniroute plugin install ./my-plugin

# Lista installerade insticksprogram
omniroute plugin list

# Skapa grundstrukturen för ett nytt insticksprogram
omniroute plugin scaffold myplugin
cd omniroute-cmd-myplugin
omniroute plugin install .

Insticksprogrammets struktur

Ett insticksprogram är ett npm-paket med namnet omniroute-cmd-<name> (eller @scope/omniroute-cmd-<name>).

omniroute-cmd-myplugin/
├── package.json     # måste ha "type": "module" och "main": "index.mjs"
├── index.mjs        # exporterar register(program, ctx) + valfri 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);
    });
}

Kontext-API för insticksprogram

Objektet ctx som skickas till register(program, ctx):

Egenskap	Typ	Beskrivning
ctx.apiFetch(path, opts)	async function	Autentiserad hämtning från OmniRoute-servern
ctx.emit(data, opts)	function	Utdata i table/json/jsonl/csv enligt flaggan --output
ctx.t(key)	async function	Uppslagning av i18n-översättning
ctx.withSpinner(label, fn)	async function	Omsluter asynkrona fn med en ora-indikator
ctx.baseUrl	string	Matchad bas-URL
ctx.apiKey	string | null	API-nyckel om en sådan har angetts

Identifiering

Insticksprogram identifieras från:

1. ~/.omniroute/plugins/<name>/ — användarlokala installationer
2. Miljövariabeln OMNIROUTE_PLUGIN_PATH — anpassad katalog

Båda är endast för CLI:t. Insticksprogramskörningen på serversidan (marknadsplatsens/plugin.json-insticksprogrammen som körs inuti proxyn) har en egen skanner med en egen åsidosättning, OMNIROUTE_PLUGINS_DIR — se PLUGIN_MARKETPLACE.md → Katalog för insticksprogram. Att ange den ena påverkar inte den andra.

Inläsningsfel fångas upp och skrivs ut som varningar — ett trasigt insticksprogram kraschar aldrig CLI:t.

Säkerhet

Insticksprogram körs med samma Node.js-processbehörigheter som omniroute. Installera endast insticksprogram från källor som du litar på. omniroute plugin install visar en uttrycklig varning och kräver --yes eller interaktiv bekräftelse.

Publicering

1. Säkerställ att package.json innehåller "keywords": ["omniroute-plugin"]
2. Kör npm publish som vanligt
3. Användare hittar insticksprogram via omniroute plugin search <query> (söker i npm-registret)

Exempel på insticksprogram

Se examples/omniroute-cmd-hello/ för ett minimalt fungerande exempel med meta + register().