API-Referenz · Quellkomponenten-CLI
@oriatheme/cli
Kopieren Sie bearbeitbare React/Vue ThemeEditor-Quellen sicher in ein Verbraucherprojekt. Es handelt sich nicht um eine Laufzeitabhängigkeit.Paket und Umgebung
Eine ausführbare Knotendatei. Wird normalerweise einmal über pnpm dlx, npm exec, Yarn dlx oder bunx ausgeführt, anstatt es einem Browser-Bundle hinzuzufügen.
pnpm add -D @oriatheme/clinpm install -D @oriatheme/cliyarn add -D @oriatheme/clibun add -D @oriatheme/cliVerwenden Sie den Paketmanager und die Sperrdatei, die bereits vom Verbraucherprojekt ausgewählt wurden. Beispiele verwenden nur Paket-Root-Exporte; Führen Sie keinen Deep-Import aus src-, dist- oder Registry-Vorlagen durch.
Programmatic export
| Exportieren | Unterschrift | Beschreibung |
|---|---|---|
runCli | (args: readonly string[], cwd?: string) => Promise<CliResult> | Führt die CLI programmgesteuert aus und gibt „exitCode“ plus Ausgabezeilen zurück. |
Allgemeine Befehle
pnpm dlx @oriatheme/cli@latest add theme-editor --framework react --dry-runnpm exec --yes --package=@oriatheme/cli@latest -- oria add theme-editor --framework react --dry-runyarn dlx @oriatheme/cli@latest add theme-editor --framework react --dry-runbunx @oriatheme/cli@latest add theme-editor --framework react --dry-runadd druckt einen Plan und beendet sich standardmäßig mit Code 2; nur --yes schreibt. --dry-run führt keine Schreibvorgänge durch und wird mit Code 0 beendet. Verwenden Sie --path für ein projektinternes Ziel und vue als Framework für Vue. Ersetzen Sie nach der Überprüfung --dry-run durch --yes über denselben Läufer. Verwenden Sie diesen Runner mit dem Diff-Theme-Editor --framework, um auf Unterschiede zu reagieren.
Der Registry-Theme-Editor ist jetzt 0.2.0, rendert oria-standard@2 und erfordert @oriatheme/core@^0.3.0 im Verbraucherprojekt. Ein zweiter Befehl erstellt vorab eine statische Tailwind CSS v4-Brücke und schreibt nur die generierte CSS in die --out-Datei:
oria theme tailwind-bridge --out src/oria-tailwind.css
oria theme tailwind-bridge --prefix acme --out src/oria-tailwind.css --dry-runSicherheit vor dem Schreiben
Die CLI validiert Manifeste, Framework, kompatible Versionen, relative Pfade, Dateigrößen und SHA-256. Es lehnt Skripte, HTTP, Pfad-Escape- und Symlink-Ziele ab. Überschreibungen werden standardmäßig abgelehnt. diff schreibt nie und --overwrite erfordert explizites --yes. Die CLI führt keine Registrierungslebenszyklusskripte aus und lädt keine Designs oder Projektdateien hoch.