Rayfin CLI-Referenz

Finden Sie die Rayfin-CLI-Befehle zum Erstellen von Projekten, zur Verwaltung von Schemaänderungen, zur Bereitstellung auf Fabric und zur Konfiguration von Umgebungseinstellungen. Jeder Abschnitt listet Befehlssyntax, Optionen und gängige Verwendungen auf.

Installation

Nutze es npm i @microsoft/rayfin-cli , um die CLI zu installieren.

Erste Schritte

Folgen Sie den Schritten in Ihrem Terminal, um eine Fabric-App zu erstellen.

npm create @microsoft/rayfin@latest my-app  # 1. Create a project from a template
cd my-app
npm run dev     # 2. Run the frontend dev server
npx rayfin up   # 3. Deploy to Microsoft Fabric

Tipp

Für bestehende oder leere Projekte verwenden Sie npx rayfin initnpm create statt Rayfin zu einem Projekt hinzuzufügen, das bereits Quellcode oder ein leeres Verzeichnis enthält. Der init-Befehl führt Sie durch das Aktivieren von Diensten, die Auswahl eines Datenbankdialekts und die Konfiguration von statischem Hosting, ohne eine neue Vorlage zu unterstützen.

Für die vollständige Anleitung siehe Erstellen und deployen Sie Ihre erste Fabric-App mit der CLI und Deployen Sie eine Fabric-App auf Fabric.

Scaffold ein Projekt mit npm create

npm create (Alias von npm init) bootstrappt ein neues Projekt, indem ein Create Initializer-Paket aufgerufen wird. Um eine Fabric-App zu unterstützen, verwenden Sie sie mit dem @microsoft/rayfin Initialisierer:

npm create @microsoft/rayfin@latest my-app --workspace <workspace name>

Befehlsreferenz

Die Befehle und Flags in diesem Artikel wurden anhand der lokal installierten CLI-Hilfeausgabe überprüft.

Befehle auf oberster Ebene

Verwenden Sie diese Tabelle, um schnell den richtigen Befehl zu finden.

Befehl	Verwenden Sie es, um
rayfin init [directory]	Erstellen oder konfigurieren Sie ein Rayfin-Projekt.
rayfin up	Deploye die App auf Fabric und manage Remote-Deployments.
rayfin env	Generiere framework-spezifische Umgebungsdateien aus rayfin/.env.
rayfin login	Melden Sie sich auf der Rayfin-Plattform an.
rayfin logout	Melden Sie sich aus und löschen Sie zwischengespeicherte Zugangsdaten.

Ein Projekt erstellen oder konfigurieren

rayfin init [directory]

Nutze rayfin init es, um Rayfin zu einem neuen oder bestehenden Projekt hinzuzufügen.

Argument	Description
--project-name <name>	Stellen Sie den Projektnamen fest.
-t, --template <uri>	Gib die Vorlagen-URI an, die verwendet werden soll.
--template-name <name>	Wählen Sie eine Vorlage nach Namen aus.
-l, --list-templates	Liste verfügbarer Vorlagen auf.
--dialect <dialect>	Stellen Sie den Datenbankdialekt ein.
--services <list>	Wählen Sie aus, welche Dienstleistungen Sie aktivieren möchten.
--auth-methods <list>	Wählen Sie Authentifizierungsmethoden.
--static-hosting	Aktivieren Sie die statische Hosting-Einrichtung.
--overwrite	Bestehende generierte Dateien überschreiben.
--workspace-id <id>	Verwenden Sie eine bestimmte Fabric-Arbeitsbereichs-ID.
--workspace-uri <uri>	Verwenden Sie eine spezielle Fabric Workspace URI.
--base-api-url <url>	Überschreiben Sie die Basis-API-URL.
--item-id <id>	Ziel ist eine bestimmte Fabric-Artikel-ID.

Examples

Listen Sie verfügbare Vorlagen vor dem Gerüstbau auf:

npx rayfin init --list-templates

Initialisieren Sie Rayfin im aktuellen Verzeichnis, indem Sie eine benannte Vorlage und einen bestimmten Dialekt verwenden:

npx rayfin init . --template-name react-vite --dialect mssql

Erstelle ein neues Projekt nicht-interaktiv mit Diensten und Authentifizierung konfiguriert:

npx rayfin init my-app --project-name my-app --services db,storage --auth-methods fabric --static-hosting --overwrite

Bereitstellen für Fabric

rayfin up

Verwenden Sie rayfin up, um die Anwendung als Rayfin-Element zu Fabric.

Argument	Description
--tenant <id>	Verwenden Sie eine bestimmte Mieter-ID.
--workspace-id <id>	Deploye auf eine bestimmte Fabric Workspace-ID.
--workspace-uri <uri>	Deployen Sie auf eine bestimmte Fabric-Arbeitsbereich-URI.
--base-api-url <url>	Überschreiben Sie die Basis-API-URL.
--force	Ersetze den Einsatz, wenn nötig.
--dry-run	Schauen Sie die Bereitstellungsaktionen vor, ohne sie anzuwenden.
--env-file <path>	Lade Umgebungswerte aus einer Datei.
--verbose	Zeige ausführliche Deployment-Ausgabe.
--json	Geben Sie die Bereitstellungsausgabe im JSON-Format zurück.
-y, --yes	Akzeptieren Sie Prompts automatisch.
--encryption-fallback-enabled	Aktivieren Sie das Verschlüsselungs-Rückfallverhalten.

Examples

Deployen Sie auf den aktuell ausgewählten Fabric-Arbeitsbereich:

npx rayfin up

Führen Sie die Bereitstellungsaktionen vor, ohne sie anzuwenden:

npx rayfin up --dry-run --verbose

Deployen Sie auf einen bestimmten Arbeitsbereich nicht-interaktiv:

npx rayfin up --workspace-id 00000000-0000-0000-0000-000000000000 --yes

Subcommand	Description
rayfin up db apply	Generiere und wende DAB-Konfigurationen auf den entfernten Rayfin-Item-Workload-Endpunkt an.
rayfin up staticapp deploy	Baue, paketiere und bereite statische Inhalte auf das entfernte Rayfin-Element aus.
rayfin up status	Zeigen Sie den aktuellen Einsatzstatus an.
rayfin up list	Liste alle für das Projekt erfassten Fabric-Deployments auf.
rayfin up switch [workspace]	Schalte die aktive Fabric Deployment um und schreibe rayfin/.env neu.

rayfin up db apply

Erzeugt und wendet DAB-Konfigurationen auf den entfernten Rayfin-Artikel-Workload-Endpunkt an.

Argument	Description
--verbose	Zeigt eine detaillierte Ausgabe an.
--force	Kraftregeneration und Konfiguration anwenden.
--json	Ausgabe im JSON-Format zurückgeben.

Examples

Fügen Sie Datenbankkonfigurationsänderungen auf das entfernte Rayfin-Element an:

npx rayfin up db apply

Kraftregeneration und -erfassung maschinenlesbarer Ausgabe:

npx rayfin up db apply --force --json

rayfin up staticapp deploy

Erstellt, paketiert und bereitet statische Inhalte auf das entfernte Rayfin-Element aus.

Argument	Description
--verbose	Zeigt eine detaillierte Ausgabe an.
--skip-build	Deploye, ohne den Build-Schritt auszuführen.
--json	Ausgabe im JSON-Format zurückgeben.

Examples

Statische Inhalte erstellen und bereitstellen:

npx rayfin up staticapp deploy

Bereite einen vorgefertigten dist Ordner aus, ohne den Build erneut auszuführen:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Zeigt den Status der Cloud-Bereitstellung an.

Argument	Description
--json	Rückgabestatus im JSON-Format.
--verbose	Zeigt eine detaillierte Ausgabe an.

Examples

Überprüfen Sie den aktuellen Bereitstellungsstatus:

npx rayfin up status

Rückgabestatus als JSON zur Verwendung in Skripten:

npx rayfin up status --json

rayfin up list

Listet alle für dieses Projekt erfassten Fabric-Einsätze auf.

Argument	Description
--json	Gib die Bereitstellungsliste im JSON-Format zurück.

Examples

Liste alle aufgezeichneten Fabric-Einsätze für das Projekt auf:

npx rayfin up list

rayfin up switch [workspace]

Wechselt die aktive Fabric Deployment und schreibt rayfin/.env entsprechend um.

Argument	Description
-l, --list	Liste verfügbare Deployments ohne Wechsel auf.
--no-emit-env	Überspringe das Schreiben von emittierten Umgebungsdateien.

Examples

Liste der verfügbaren Deployments zum Wechseln auf:

npx rayfin up switch --list

Schalte die aktive Bereitstellung auf einen bestimmten Arbeitsbereich um:

npx rayfin up switch my-workspace

Generiere Umgebungsdateien

rayfin env

Verwenden Sie rayfin env , um framework-spezifische .env.local Werte aus zu rayfin/.enverzeugen.

Argument	Description
--framework <vite|nextjs|plain>	Wählen Sie das Ziel-Framework-Format.
--output <dir>	Schreibe generierte Dateien in ein bestimmtes Verzeichnis.
--show	Ausgabe von emittierten Werten, ohne Dateien zu schreiben.

Examples

Generiere eine Vite-kompatible .env.localMethode :

npx rayfin env --framework vite

Vorschau der ausgegebenen Umgebungswerte ohne Dateischreibung:

npx rayfin env --framework nextjs --show

An- und Abmelden

rayfin login

Nutze rayfin login es, um dich auf der Rayfin-Plattform anzumelden.

Argument	Description
--tenant <id>	Verwenden Sie eine bestimmte Mieter-ID.
--service-principal	Versuchen Sie, sich anzumelden. Diese Option ist in der Hilfe aufgeführt, wird aber derzeit nicht unterstützt.
-u, --client-id <id>	Gib die Client-ID für die Anmeldung des Service-Principals an. Diese Option ist in der Hilfe aufgeführt, wird aber derzeit nicht unterstützt.
-p, --client-secret <secret>	Stellen Sie das Client-Geheimnis für die Anmeldung des Service Principal bereit. Diese Option ist in der Hilfe aufgeführt, wird aber derzeit nicht unterstützt.
--select	Wählen Sie aus verfügbaren angemeldeten Konten oder Kontexten.
--encryption-fallback-enabled	Aktivieren Sie das Verschlüsselungs-Rückfallverhalten.

Examples

Interaktiv anmelden:

npx rayfin login

Melden Sie sich bei einem bestimmten Mieter an:

npx rayfin login --tenant 00000000-0000-0000-0000-000000000000

Wechseln Sie zwischen angemeldeten Konten:

npx rayfin login --select

Subcommand	Description
rayfin login status	Zeigen Sie den aktuellen Authentifizierungsstatus an.

rayfin login status

Zeigt den aktuellen Authentifizierungsstatus an.

Argument	Description
Nichts	Dieser Unterbefehl listet keine Optionen in der CLI-Hilfeausgabe auf.

Example

Überprüfe, ob du angemeldet bist:

npx rayfin login status

rayfin logout

Meldet sich ab und löscht zwischengespeicherte Zugangsdaten.

Argument	Description
Nichts	Dieser Befehl listet keine Optionen in der CLI-Hilfeausgabe auf.

Example

Melden Sie sich ab und löschen Sie zwischengespeicherte Zugangsdaten:

npx rayfin logout