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
npx rayfin 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
npx rayfin init [directory]	Erstellen oder konfigurieren Sie ein Rayfin-Projekt.
npx rayfin connector	Finde, konfiguriere, inspiziere und rufe Fabric-Datenverbinder auf.
npx rayfin functions init	Scafffold ein Funktionspaket.
npx rayfin dev	Starte die App und Functions lokal.
npx rayfin init ai-files	Installiere oder überprüfe die Rayfin-Agenten-Kontextdateien.
npx rayfin up	Deploye die App auf Fabric und manage Remote-Deployments.
npx rayfin env	Generiere framework-spezifische Umgebungsdateien aus rayfin/.env.
npx rayfin login	Melden Sie sich auf der Rayfin-Plattform an.
npx 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

Steckerbefehle

Die Kommandogruppe connector verwaltet externe Fabric-Datenquellen.

rayfin connector types

Listet Connector-Typen auf, die du zu einem Projekt hinzufügen kannst.

Auswahl	Description
--json	Emittieren Sie die Steckertypliste als JSON.
-v, --verbose	Fügen Sie Details zu den Fähigkeiten hinzu.

rayfin connector search [query]

Sucht nach Fabric-Quellen, die die angemeldete Identität als Connectors hinzufügen kann.

Argument oder Option	Description
[query]	Optionaler, groß- und kleinschreibungsunempfindlicher Quellname-Filter.
--query <text>	Benannter Quellname-Filter, der Vorrang vor [query]hat.
--type <type>	Komma-getrennte Steckverbindertypen; erforderlich mit --workspace-id oder --all-workspaces.
--workspace-id <id>	Suchen Sie in einem Fabric Workspace.
--all-workspaces	Durchsuche jeden Arbeitsbereich, auf den die Identität zugreifen kann.
-y, --yes	Akzeptiere automatisch die interaktive Hinzufügungsübergabe.
--limit <n>	Maximale Anzahl der angezeigten Ergebnisse.
--output <interactive\|plain\|json>	Wählen Sie das Ausgabeformat aus.
--json	Druck die Ergebnisse als JSON und überspringe den interaktiven Picker.
-v, --verbose	Ausführliche Ausgabe aktivieren.

Wenn keine der Arbeitsbereichsoptionen bereitgestellt wird, sucht der Befehl die für die aktuelle Projektbereitstellung gespeicherten Arbeitsbereiche.

rayfin connector add --type <type>

Fügt eine Connector-Deklaration hinzu und unterstützt seine Projektdateien.

Auswahl	Description
--type <type>	Required. Steckertyp; verwenden rayfin connector types Sie zur Auflistung von Typen.
--name <name>	Steckername; abgeleitet vom Element, wenn es weggelassen wird.
--workspace-id <id>	Fabric-Arbeitsplatz-ID.
--item-id <id>	Fabric-Artikel-ID.
--operations <ops>	Komma-getrennte Teilmenge der erlaubten Operationen.
-v, --verbose	Ausführliche Ausgabe aktivieren.
-y, --yes	Bestätigungen automatisch akzeptieren.
--json	JSON-Ausgabe emittieren.

rayfin connector list

Listet die in deklarierten Steckverbinder auf rayfin.yml.

Auswahl	Description
-v, --verbose	Verbinder-Metadaten und -Funktionen einfügen.
--json	JSON-Ausgabe emittieren.

rayfin connector inspect

Inspiziert einen konfigurierten Steckverbinder oder eine direkt adressierte Fabric-Quelle, ohne Änderungen vorzunehmen.

Auswahl	Description
--name <name>	Name des Steckers konfiguriert.
-w, --workspace <name>	Arbeitsplatzname für direkte Inspektion.
--workspace-id <id>	Arbeitsplatz-ID für direkte Inspektion.
--item <name>	Artikelname für die direkte Inspektion.
--item-id <id>	Artikel-ID für die direkte Inspektion.
--type <type>	Steckertyp für direkte Inspektion.
--url <url>	URL des semantischen Modellportals; leitet die Arbeitsbereichs- und Item-IDs ab.
--entity <name>	Entität oder Tabelle zum Stichproben; weglassen, um --query Entitäten aufzulisten.
--query <path>	.sql oder .dax Datei, die im Schreibschutzmodus ausgeführt wird.
--rows <n>	Zeilenbegrenzung; standardmäßig steht für Samples auf 10 und ist auf 100 begrenzt.
-v, --verbose	Ausführliche Ausgabe aktivieren.
--output <interactive\|plain\|json>	Wählen Sie das Ausgabeformat aus.
--json	JSON-Ausgabe emittieren.

Verwendung --name für einen konfigurierten Connector, einen vollständigen Direktquellen-Selektor oder --url für ein semantisches Modell.

rayfin connector invoke [connector-name] [operation]

Ruft eine Operation auf einem konfigurierten Connector aus.

Argument oder Option	Description
[connector-name]	Name des Steckers konfiguriert.
[operation]	Steckverbinderbetrieb, wie zum Beispiel executeQuery.
--name <name>	Benannte Alternative zu [connector-name].
--operation <operation>	Benannte Alternative zu [operation].
--input <json>	JSON-Operation-Eingabe.
--file <path>	JSON-Datei mit Operation-Eingabe.
--transport <auto\|deployed>	Invocation-Pfad; standardmäßig gilt .auto
-v, --verbose	Ausführliche Ausgabe aktivieren.
--output <interactive\|plain\|json>	Wählen Sie das Ausgabeformat aus.
--output-file <path>	Schreibe das vollständige Ergebnis in eine Datei.
--max-inline-bytes <bytes>	Ergebnisgrößengrenze für das Schreiben einer Datei; standardmäßig 1 MiB.
--json	JSON-Ausgabe emittieren.

rayfin connector remove <name>

Entfernt eine Connector-Deklaration und ihre generierten Connector-Dateien.

Argument oder Option	Description
<name>	Required. Steckername soll entfernt werden.
-v, --verbose	Ausführliche Ausgabe aktivieren.
-y, --yes	Automatisch akzeptieren Sie die Entfernungsbestätigung.
--json	JSON-Ausgabe emittieren.

Funktionsbefehle

rayfin functions init [directory]

Scaffold und konfiguriert ein Funktionspaket.

Argument oder Option	Description
[directory]	Project Root; standardmäßig auf das aktuelle Verzeichnis.
--force	Überschreiben Sie ein bestehendes Funktionsgerüst.
--path <relative-path>	Funktionspaketstandort relativ zur Projektwurzel.

Der Paketstandort wird standardmäßig auf einen erkannten Arbeitsbereichsort oder rayfin/functionsgesetzt.

Entwicklungskommandos

rayfin dev [project-path]

Startet eine lokale Entwicklungssitzung gegen ein Rayfin-Backend.

Argument oder Option	Description
[project-path]	Project Root; standardmäßig auf das aktuelle Verzeichnis.
--skip-db-apply	Automatische Datenbankkonfiguration überspringen, angewendet werden.
--env-file <path>	.env Datei, die für rayfin.yml die Interpolation verwendet wird.
--provider <fabric>	Backend-Provider; standardmäßig auf fabric.
-w, --workspace <name>	Fabric Workspace-Name für ein First-Run-Backend.
--workspace-id <id>	Fabric Workspace ID für ein First-Run-Backend.
--capacity-id <id>	Fabric-Kapazitäts-ID für einen Arbeitsbereich ohne nutzbare Kapazität.
-t, --tenant <id>	Microsoft Entra-Mandanten-ID
--encryption-fallback-enabled	Klartext-Tokenspeicherung erlauben, wenn kein Betriebssystemschlüsselbund verfügbar ist.
--no-emit-env	Regeneriere die Framework-Datei .env.local nicht.
-v, --verbose	Ermöglicht das Erstellen ausführlicher Protokolldateien.

rayfin dev functions apply

Startet den lokalen Funktionshost gegen die aktive Bereitstellung.

Auswahl	Description
--port <port>	Local Functions Host-Port; standardmäßig gilt .7071
--inspect-port <port>	Node.js Inspektor-Port; setzt standardmäßig auf 9229.
--no-debug	Deaktivieren Sie den Node.js Inspektor.
--no-emit-env	Regeneriere die Framework-Datei .env.local nicht.
--verbose	Diagnostische Ausgabe anzeigen.
--json	JSON-Ausgabe emittieren.
-y, --yes	Ohne interaktive Eingabeaufforderungen laufen.

Agentendateien verwalten

Der rayfin init ai-files Befehl verwaltet Rayfin-Agenten-Kontextdateien in Ihrem Projekt: AGENTS.md, .mcp.json, und .agents/skills/rayfin/SKILL.md. Die CLI installiert diese Dateien automatisch, wenn du ein Projekt gescffold. Führe die untenstehenden Befehle aus, um sie in einem bestehenden Projekt zu installieren oder zu aktualisieren, oder überprüfe ihren Status.

rayfin init ai-files install

Installiert oder aktualisiert die Rayfin-Agenten-Dateien. Der Befehl ist idempotent und bewahrt die bestehende Benutzerkonfiguration.

Auswahl	Description
--enable <id>	Installiere oder behalte ein bestimmtes Element mit seiner namensspaced-ID, zum Beispiel skill:rayfin. Wiederholbar.
--disable <id>	Hören Sie auf, ein bestimmtes Element zu verwalten, ohne dessen Datei zu löschen. Wiederholbar.
--remove-files	Entfernen Sie die Festplattendatei beim Deaktivieren eines Elements. Erfordert --disable.
--force [ids...]	Überschreiben Sie modifizierte Gegenstände, stellen fehlende Gegenstände wieder her oder bauen Sie fehlerhaft geformt .mcp.jsonwieder auf. Akzeptiert optionale Namespaced-IDs, um die Operation abzugrenzen. Überschreibt AGENTS.mdnie.
-n, --dry-run	Melde die Änderungen, ohne Dateien zu schreiben.
--json	Erzeugt strukturierte Ausgabe als JSON; impliziert einen nicht-interaktiven Modus.
-y, --yes, --non-interactive	Überspringe den interaktiven Prompt und akzeptiere Standardeinstellungen.

Zum Beispiel kann man Standardeinstellungen ohne Aufforderung installieren:

npx rayfin init ai-files install --yes

rayfin init ai-files status

Druckt den Zustand jeder verwalteten Agentendatei. Verwenden Sie --json sie für strukturierte Ausgaben.

Mögliche Zustände sind , , , , missing, not-installeddisabled, , orphanedund unreadable. user-modifiedupdate-availableup-to-date Führe rayfin init ai-files install es aus, um Dateien zu aktualisieren oder rayfin init ai-files install --force <id> ein bestimmtes verwaltetes Element zu überschreiben.

Bereitstellen für Fabric

rayfin up

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

Argument	Description
-t, --tenant <id>	Verwenden Sie eine bestimmte Mieter-ID.
-w, --workspace <name>	Deploye auf einen Fabric-Arbeitsbereich nach Name; standardmäßig ist My Workspace.
--workspace-id <id>	Deploye auf eine bestimmte Fabric Workspace-ID.
--workspace-uri <uri>	Deployen Sie auf eine bestimmte Fabric-Arbeitsbereich-URI.
--item-name <name>	Fabric-Artikel-Anzeigename; standardmäßig wird die Projekt-ID verwendet.
--capacity-id <id>	Fabric Capacity ID, wenn der Zielarbeitsbereich Kapazität benötigt.
--force	Erlauben Sie zerstörerische Datenschema-Änderungen.
-n, --dry-run	Validiere Eingaben und löse den Arbeitsbereich ohne Deployment auf.
--env-file <path>	.envDatei für die Bereitstellungseigenschaften; standardmäßig gilt .rayfin/.env
-v, --verbose	Ausführliche Ausgabe aktivieren.
--json	Geben Sie die Bereitstellungsausgabe im JSON-Format zurück.
-y, --yes	Bestätigungen automatisch akzeptieren.
--encryption-fallback-enabled	Klartext-Tokenspeicherung erlauben, wenn kein Betriebssystemschlüsselbund verfügbar ist.
--exclude-services <names>	Kommma-getrennte Dienste, die während des Baus und der Bereitstellung übersprungen werden: staticHosting oder functions.
--provider <fabric>	Bereitstellungsanbieter; standardmäßig auf fabric.

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 <workspace-id> --yes

Bereitstellung ohne Aufbau oder Bereitstellung von Funktionen bereitzustellen:

npx rayfin up --exclude-services functions

--capacity-id Kann nicht mit --workspace, --workspace-idoder --workspace-urikombiniert werden.

Subcommand	Description
npx rayfin up db apply	Generiere und wende DAB-Konfigurationen auf den entfernten Rayfin-Item-Workload-Endpunkt an.
npx rayfin up functions deploy	Bauen, paketieren und Functions auf das aktive entfernte Item bereitstellen.
npx rayfin up staticapp deploy	Baue, paketiere und bereite statische Inhalte auf das entfernte Rayfin-Element aus.
npx rayfin up connector apply	Verwenden Sie die Datenbankkonfiguration für deklarierte GraphQL-Connectors.
npx rayfin up status	Zeigen Sie den aktuellen Einsatzstatus an.
npx rayfin up list	Liste alle für das Projekt erfassten Fabric-Deployments auf.
npx 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 functions deploy

Erstellt, paketiert und bereitet Funktionen für das aktive entfernte Item aus.

Auswahl	Description
--verbose	Zeigt eine detaillierte Ausgabe an.
--skip-build	Bereite bestehende Funktionen-Ausgaben aus, ohne zu bauen.
--json	JSON-Ausgabe emittieren.

rayfin up connector apply

Verwendet Datenbankkonfiguration für deklarierte GraphQL-Connectors.

Auswahl	Description
--name <name>	Verwenden Sie nur den benannten Connector.
--verbose	Ausführliche Ausgabe aktivieren.
--json	JSON-Ausgabe emittieren.

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
npx 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