Rayfin CLI-referentie

Zoek de Rayfin CLI-commando's voor het aanmaken van projecten, het beheren van schemawijzigingen, het deployen naar Fabric en het configureren van omgevingsinstellingen. Elke sectie geeft de syntaxis, opties en veelvoorkomende toepassingen weer op.

Installatie

Gebruik npm i @microsoft/rayfin-cli om de CLI te installeren.

Aan de slag

Volg de stappen in je terminal om een Fabric-app te maken.

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

Tip

Voor bestaande of lege projecten kun npx rayfin init je in plaats van npm create Rayfin toevoegen aan een project dat al broncode of een lege map heeft. Het init-commando leidt je door het inschakelen van services, het kiezen van een databasedialect en het configureren van statische hosting zonder een nieuw sjabloon te ondersteunen.

Voor de volledige walkthrough, zie Create and deploy your first Fabric app met de CLI en Deploy a Fabric app to Fabric.

Scaffalt een project met npm create

npm create (alias van npm init) Bootstrap een nieuw project door een Create Initializer-pakket aan te roepen. Om een Fabric-app te ondersteunen, gebruik je deze met de @microsoft/rayfin initialiseerder:

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

Opdrachtenoverzicht

De commando's en vlaggen in dit artikel zijn geverifieerd op basis van de lokaal geïnstalleerde CLI-hulpuitvoer.

Opdrachten op het hoogste niveau

Gebruik deze tabel om snel het juiste commando te vinden.

Opdracht	Gebruik het om
npx rayfin init [directory]	Maak een Rayfin-project aan of configureer je.
npx rayfin connector	Vind, configureer, inspecteer en roep Fabric-dataconnectoren op.
npx rayfin functions init	Scaffold een Functions-pakket.
npx rayfin dev	Start de app en Functions lokaal.
npx rayfin init ai-files	Installeer of controleer de contextbestanden van de Rayfin-agent.
npx rayfin up	Deploy de app naar Fabric en beheer externe deployments.
npx rayfin env	Genereer framework-specifieke omgevingsbestanden uit rayfin/.env.
npx rayfin login	Log in op het Rayfin-platform.
npx rayfin logout	Log uit en wis gecachte inloggegevens.

Maak of configureer een project

rayfin init [directory]

rayfin init Gebruik het om Rayfin toe te voegen aan een nieuw of bestaand project.

Argument	Beschrijving
--project-name <name>	Stel de projectnaam in.
-t, --template <uri>	Specificeer de sjabloon-URI die gebruikt moet worden.
--template-name <name>	Selecteer een sjabloon op naam.
-l, --list-templates	Lijst van beschikbare sjablonen.
--dialect <dialect>	Stel het databasedialect in.
--services <list>	Kies welke diensten je wilt inschakelen.
--auth-methods <list>	Kies authenticatiemethoden.
--static-hosting	Schakel statische hosting-instellingen in.
--overwrite	Overschrijf bestaande gegenereerde bestanden.
--workspace-id <id>	Gebruik een specifiek Fabric workspace ID.
--workspace-uri <uri>	Gebruik een specifieke Fabric workspace URI.
--base-api-url <url>	Overschrijf de basis API URL.
--item-id <id>	Richt je op een specifieke Fabric item ID.

Examples

Lijst van beschikbare sjablonen voordat je een steiger maakt:

npx rayfin init --list-templates

Initialiseer Rayfin in de huidige map door een benoemd sjabloon en een specifiek dialect te gebruiken:

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

Maak een nieuw project aan niet-interactief met services en authenticatie geconfigureerd:

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

Connectorcommando's

De connector commandogroep beheert externe Fabric-databronnen.

rayfin connector types

Geeft een lijst met connectortypes die je aan een project kunt toevoegen.

Option	Beschrijving
--json	Emitteer de connectortypelijst als JSON.
-v, --verbose	Voeg functionaliteitsdetails toe.

rayfin connector search [query]

Zoekt naar Fabric-bronnen die de ingelogde identiteit als connectors kan toevoegen.

Argument of optie	Beschrijving
[query]	Optioneel, naamloze bronnaamfilter.
--query <text>	Benoemde bronnaamfilter die voorrang heeft boven [query].
--type <type>	Comma-gescheiden connectortypes; vereist met --workspace-id of --all-workspaces.
--workspace-id <id>	Zoek op één Fabric workspace.
--all-workspaces	Doorzoek elke werkruimte waar de identiteit toegang toe heeft.
-y, --yes	Accepteer automatisch de interactieve overdracht van toevoegingen.
--limit <n>	Maximaal aantal weergegeven resultaten.
--output <interactive\|plain\|json>	Selecteer het uitvoerformaat.
--json	Print de resultaten af als JSON en sla de interactieve picker over.
-v, --verbose	Uitgebreide uitvoer inschakelen.

Wanneer geen van beide werkruimteopties wordt opgegeven, doorzoekt het commando de werkruimtes die zijn opgenomen voor de huidige projectimplementatie.

rayfin connector add --type <type>

Voegt een connectordeclaratie toe en scaffoldt de projectbestanden.

Option	Beschrijving
--type <type>	Required. Connectortype; gebruik rayfin connector types om types te vermelden.
--name <name>	Connectornaam; afgeleid van het item wanneer weggelaten.
--workspace-id <id>	Fabric workspace ID.
--item-id <id>	Fabric item ID.
--operations <ops>	Comma-gescheiden deelverzameling van toegestane operaties.
-v, --verbose	Uitgebreide uitvoer inschakelen.
-y, --yes	Bevestigingen automatisch accepteren.
--json	Geef JSON-output uit.

rayfin connector list

Geeft de connectoren weer die in rayfin.ymlzijn gedeclareerd.

Option	Beschrijving
-v, --verbose	Voeg connectormetadata en mogelijkheden op.
--json	Geef JSON-output uit.

rayfin connector inspect

Inspecteert een geconfigureerde connector of een direct aangesproken Fabric-bron zonder wijzigingen aan te brengen.

Option	Beschrijving
--name <name>	Connectornaam geconfigureerd.
-w, --workspace <name>	Werkruimtenaam voor directe inspectie.
--workspace-id <id>	Werkruimte-ID voor directe inspectie.
--item <name>	Itemnaam voor directe inspectie.
--item-id <id>	Item-ID voor directe inspectie.
--type <type>	Connectortype voor directe inspectie.
--url <url>	Semantisch model portaal URL; leidt de werkruimte- en item-ID's af.
--entity <name>	Entiteit of tabel om te samplen; laat met weg --query om entiteiten te vermelden.
--query <path>	.sql of .dax bestand om in alleen-lezen-modus uit te voeren.
--rows <n>	Rijlimiet; standaard 10 voor samples en is gelimiteerd op 100.
-v, --verbose	Uitgebreide uitvoer inschakelen.
--output <interactive\|plain\|json>	Selecteer het uitvoerformaat.
--json	Geef JSON-output uit.

Gebruik --name voor een geconfigureerde connector, een volledige direct-source selector, of --url voor een semantisch model.

rayfin connector invoke [connector-name] [operation]

Roept een operatie op op een geconfigureerde connector.

Argument of optie	Beschrijving
[connector-name]	Connectornaam geconfigureerd.
[operation]	Connectorwerking, zoals executeQuery.
--name <name>	Genoemd alternatief voor [connector-name].
--operation <operation>	Genoemd alternatief voor [operation].
--input <json>	JSON-operatie-invoer.
--file <path>	JSON-bestand met operatie-invoer.
--transport <auto\|deployed>	Aanroepingspad; standaard is .auto
-v, --verbose	Uitgebreide uitvoer inschakelen.
--output <interactive\|plain\|json>	Selecteer het uitvoerformaat.
--output-file <path>	Schrijf het volledige resultaat in een bestand.
--max-inline-bytes <bytes>	Resultaat-grootte drempel voor het schrijven van een bestand; standaard is 1 MiB.
--json	Geef JSON-output uit.

rayfin connector remove <name>

Verwijdert een connector-declaratie en de gegenereerde connectorbestanden.

Argument of optie	Beschrijving
<name>	Required. Connectornaam om te verwijderen.
-v, --verbose	Uitgebreide uitvoer inschakelen.
-y, --yes	Accepteer automatisch de verwijderingsbevestiging.
--json	Geef JSON-output uit.

Functions-commando's

rayfin functions init [directory]

Scaffoldt en configureert een Functions-pakket.

Argument of optie	Beschrijving
[directory]	Project root; standaard naar de huidige directory.
--force	Overschrijf een bestaande Functions-steiger.
--path <relative-path>	Functiepakketlocatie ten opzichte van de projectwortel.

De pakketlocatie is standaard een gedetecteerde werkruimtelocatie of rayfin/functions.

Ontwikkelingscommando's

rayfin dev [project-path]

Start een lokale ontwikkelingssessie tegen een Rayfin-backend.

Argument of optie	Beschrijving
[project-path]	Project root; standaard naar de huidige directory.
--skip-db-apply	Sla automatische databaseconfiguratie over.
--env-file <path>	.env Bestand gebruikt voor rayfin.yml interpolatie.
--provider <fabric>	Backendprovider; standaard is .fabric
-w, --workspace <name>	Fabric workspace-naam voor een first-run backend.
--workspace-id <id>	Fabric workspace ID voor een first-run backend.
--capacity-id <id>	Fabric capaciteits-ID voor een werkruimte zonder bruikbare capaciteit.
-t, --tenant <id>	Tenant-id van Microsoft Entra.
--encryption-fallback-enabled	Sta opslag van platte tekst tokens toe wanneer er geen OS-sleutelhanger beschikbaar is.
--no-emit-env	Genereer het frameworkbestand .env.local niet.
-v, --verbose	Uitgebreide logboekregistratie inschakelen.

rayfin dev functions apply

Start de lokale Functions-host tegen de actieve deployment.

Option	Beschrijving
--port <port>	Lokale Functions hostpoort; standaard is .7071
--inspect-port <port>	Node.js inspecteurpoort; standaard naar 9229.
--no-debug	Schakel de Node.js inspecteur uit.
--no-emit-env	Genereer het frameworkbestand .env.local niet.
--verbose	Toon diagnostische output.
--json	Geef JSON-output uit.
-y, --yes	Speel zonder interactieve prompts.

Beheer agentbestanden

Het rayfin init ai-files commando beheert contextbestanden van Rayfin-agenten in je project: AGENTS.md, .mcp.json, en .agents/skills/rayfin/SKILL.md. De CLI installeert deze bestanden automatisch wanneer je een project opbouwt. Voer de onderstaande commando's uit om ze te installeren of te verversen in een bestaand project, of controleer hun status.

rayfin init ai-files install

Installeert of ververst de Rayfin-agentbestanden. Het commando is idempotent en behoudt de bestaande gebruikersconfiguratie.

Option	Beschrijving
--enable <id>	Installeer of bewaar een specifiek item via zijn naamgebakte ID, zoals skill:rayfin. Herhaalbare.
--disable <id>	Stop met het beheren van een specifiek item zonder het bestand te verwijderen. Herhaalbare.
--remove-files	Verwijder het bestand op de schijf bij het uitschakelen van een item. Vereist --disable.
--force [ids...]	Overschrijf aangepaste items, herstel ontbrekende items, of bouw misformed .mcp.jsonop. Accepteert optionele naamruimte-ID's om de operatie te scopen. Nooit overschrijven.AGENTS.md
-n, --dry-run	Rapporteer de wijzigingen zonder bestanden te schrijven.
--json	Genereer gestructureerde output als JSON; impliceert niet-interactieve modus.
-y, --yes, --non-interactive	Sla de interactieve prompt over en accepteer defaults.

Installeer bijvoorbeeld standaardinstellingen zonder te vragen:

npx rayfin init ai-files install --yes

rayfin init ai-files status

Print de status van elk managed agent-bestand. Gebruik --json het voor gestructureerde output.

Mogelijke toestanden zijn onder andere up-to-date, update-available, user-modified, missing, not-installed, disabled, , orphaneden unreadable. Voer rayfin init ai-files install uit om bestanden te verversen of rayfin init ai-files install --force <id> om een specifiek beheerd item te overschrijven.

Implementeren in Fabric

rayfin up

Gebruik rayfin up om de applicatie als Rayfin-item te Fabric.

Argument	Beschrijving
-t, --tenant <id>	Gebruik een specifieke tenant-ID.
-w, --workspace <name>	Deploy naar een Fabric-werkruimte op naam; standaard is My Workspace.
--workspace-id <id>	Deploy naar een specifieke Fabric workspace ID.
--workspace-uri <uri>	Deploy naar een specifieke Fabric workspace URI.
--item-name <name>	Fabric-itemweergavenaam; standaard wordt de project-ID gebruikt.
--capacity-id <id>	Fabric capaciteits-ID wanneer de doelwerkplek capaciteit nodig heeft.
--force	Laat destructieve data-schema-wijzigingen toe.
-n, --dry-run	Valideer invoer en los de werkruimte op zonder te deployen.
--env-file <path>	.envbestand voor deployment-eigenschappen; standaard is .rayfin/.env
-v, --verbose	Uitgebreide uitvoer inschakelen.
--json	Geef deployment-output terug in JSON-formaat.
-y, --yes	Bevestigingen automatisch accepteren.
--encryption-fallback-enabled	Sta opslag van platte tekst tokens toe wanneer er geen OS-sleutelhanger beschikbaar is.
--exclude-services <names>	Comma-gescheiden diensten om over te slaan tijdens het bouwen en uitrolen: staticHosting of functions.
--provider <fabric>	Deployment provider; standaard is .fabric

Examples

Deploy naar de momenteel geselecteerde Fabric-werkruimte:

npx rayfin up

Bekijk implementatieacties zonder ze toe te passen:

npx rayfin up --dry-run --verbose

Deploy op een specifieke werkruimte niet-interactief:

npx rayfin up --workspace-id <workspace-id> --yes

Deploy zonder functies te bouwen of te implementeren:

npx rayfin up --exclude-services functions

--capacity-id kan niet gecombineerd worden met --workspace, --workspace-id, of --workspace-uri.

Subcommand	Beschrijving
npx rayfin up db apply	Genereer en pas DAB-configuratie toe op het externe Rayfin-item workload-eindpunt.
npx rayfin up functions deploy	Bouw, verpak en deploy Functions naar het actieve remote item.
npx rayfin up staticapp deploy	Bouw, verpak en deploy statische content naar het externe Rayfin-item.
npx rayfin up connector apply	Pas databaseconfiguratie toe voor gedeclareerde GraphQL-connectoren.
npx rayfin up status	Toon de huidige inzetstatus.
npx rayfin up list	Vermeld alle Fabric-implementaties die voor het project zijn geregistreerd.
npx rayfin up switch [workspace]	Schakel de actieve Fabric deployment en herschrijf rayfin/.env.

rayfin up db apply

Genereert en past DAB-configuratie toe op het externe Rayfin-item workload-eindpunt.

Argument	Beschrijving
--verbose	Toon uitgebreide uitvoer.
--force	Force regeneratie en passen configuratie toe.
--json	Geef output terug in JSON-formaat.

Examples

Pas databaseconfiguratiewijzigingen toe op het externe Rayfin-item:

npx rayfin up db apply

Krachtregeneratie en het vastleggen van machineleesbare output:

npx rayfin up db apply --force --json

rayfin up functions deploy

Bouwt, verpakt en deployt Functions naar het actieve remote item.

Option	Beschrijving
--verbose	Toon uitgebreide uitvoer.
--skip-build	Deploy bestaande Functions-output zonder te bouwen.
--json	Geef JSON-output uit.

rayfin up connector apply

Past databaseconfiguratie toe voor gedeclareerde GraphQL-connectoren.

Option	Beschrijving
--name <name>	Pas alleen de genoemde connector aan.
--verbose	Uitgebreide uitvoer inschakelen.
--json	Geef JSON-output uit.

rayfin up staticapp deploy

Bouwt, verpakt en deployt statische content naar het externe Rayfin-item.

Argument	Beschrijving
--verbose	Toon uitgebreide uitvoer.
--skip-build	Deploy zonder de bouwstap te draaien.
--json	Geef output terug in JSON-formaat.

Examples

Bouw en deploy statische content:

npx rayfin up staticapp deploy

Deploy een vooraf gebouwde dist map zonder de build opnieuw uit te voeren:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Toont de status van de cloud-implementatie.

Argument	Beschrijving
--json	Retourstatus in JSON-formaat.
--verbose	Toon uitgebreide uitvoer.

Examples

Controleer de huidige status van de deployment:

npx rayfin up status

Returnstatus als JSON voor gebruik in scripts:

npx rayfin up status --json

rayfin up list

Geeft een overzicht van alle geregistreerde Fabric-implementaties voor dit project.

Argument	Beschrijving
--json	Stuur de deploymentlijst terug in JSON-formaat.

Examples

Vermeld alle geregistreerde Fabric-implementaties voor het project:

npx rayfin up list

rayfin up switch [workspace]

Schakelt de actieve Fabric deployment en herschrijft rayfin/.env dienovereenkomstig.

Argument	Beschrijving
-l, --list	Vermeld beschikbare implementaties zonder te wisselen.
--no-emit-env	Sla het schrijven van verzonden omgevingsbestanden over.

Examples

Lijst van beschikbare implementaties om naar over te stappen:

npx rayfin up switch --list

Schakel de actieve deployment over naar een specifieke werkruimte:

npx rayfin up switch my-workspace

Genereer omgevingsbestanden

rayfin env

Gebruik rayfin env om framework-specifieke .env.local waarden uit rayfin/.envte voeren.

Argument	Beschrijving
--framework <vite|nextjs|plain>	Kies het doelframe-formaat.
--output <dir>	Schrijf gegenereerde bestanden naar een specifieke map.
--show	Print uitgezonden waarden zonder bestanden te schrijven.

Examples

Genereer een Vite-compatibele .env.local:

npx rayfin env --framework vite

Voorbeelden van geëmitteerde omgevingswaarden zonder bestanden te schrijven:

npx rayfin env --framework nextjs --show

Aanmelden en afmelden

rayfin login

rayfin login Gebruik om in te loggen op het Rayfin-platform.

Argument	Beschrijving
--tenant <id>	Gebruik een specifieke tenant-ID.
--service-principal	Probeer in te loggen als dienstdirecteur. Deze optie staat in de hulp, maar wordt momenteel niet ondersteund.
-u, --client-id <id>	Geef de client-ID op voor het aanmelden van de dienstprincipal. Deze optie staat in de hulp, maar wordt momenteel niet ondersteund.
-p, --client-secret <secret>	Geef het cliëntgeheim voor het aanmelden van de dienstprincipal. Deze optie staat in de hulp, maar wordt momenteel niet ondersteund.
--select	Kies uit beschikbare ingelogde accounts of contexten.
--encryption-fallback-enabled	Schakel encryptie-fallbackgedrag in.

Examples

Log interactief in:

npx rayfin login

Log in bij een specifieke huurder:

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

Wissel tussen ingelogde accounts:

npx rayfin login --select

Subcommand	Beschrijving
npx rayfin login status	Toon de huidige authenticatiestatus.

rayfin login status

Toont de huidige authenticatiestatus.

Argument	Beschrijving
Geen	Dit subcommando vermeldt geen opties in de CLI-hulpoutput.

Example

Controleer of je bent ingelogd:

npx rayfin login status

rayfin logout

Logt uit en wist gecachte inloggegevens.

Argument	Beschrijving
Geen	Dit commando vermeldt geen opties in de CLI-hulpoutput.

Example

Log uit en wis gecachede inloggegevens:

npx rayfin logout