Rayfin CLI-reference

Find Rayfin CLI-kommandoerne til at oprette projekter, håndtere skemaændringer, udrulte til Fabric og konfigurere miljøindstillinger. Hver sektion viser kommandosyntaks, muligheder og almindelige anvendelser.

Installation

Brug npm i @microsoft/rayfin-cli den til at installere CLI'en.

Kom godt i gang

Følg trinene i din terminal for at oprette en Fabric-app.

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

For eksisterende eller tomme projekter, brug npx rayfin init i stedet for npm create at tilføje Rayfin til et projekt, der allerede har kildekode eller en tom mappe. Kommandoen init guider dig gennem aktivering af tjenester, valg af databasedialekt og konfiguration af statisk hosting uden at stille en ny skabelon sammen.

For hele gennemgangen, se Opret og udrul din første Fabric-app med CLI og Deploy en Fabric-app til Fabric.

Et projekt med en stillads npm create

npm create (alias af npm init) bootstrapper et nyt projekt ved at aktivere en create-initializer-pakke. For at støtte en Fabric-app, brug den med @microsoft/rayfin-initializeren:

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

Kommandoreference

Kommandoerne og flagene i denne artikel er verificeret ud fra det lokalt installerede CLI-hjælpeoutput.

Topniveaukommandoer

Brug denne tabel til hurtigt at finde den rigtige kommando.

Kommando	Brug det til
npx rayfin init [directory]	Opret eller konfigurér et Rayfin-projekt.
npx rayfin connector	Find, konfigurer, inspicer og påkald Fabric-dataforbindelser.
npx rayfin functions init	Scaffold, en Functions-pakke.
npx rayfin dev	Kør appen og Functions lokalt.
npx rayfin init ai-files	Installer eller tjek Rayfin-agentens kontekstfiler.
npx rayfin up	Udrul appen til Fabric og administrer fjernudrulninger.
npx rayfin env	Generer framework-specifikke miljøfiler fra rayfin/.env.
npx rayfin login	Log ind på Rayfin-platformen.
npx rayfin logout	Log ud og ryd cachede legitimationsoplysninger.

Opret eller konfigurér et projekt

rayfin init [directory]

Brug rayfin init den til at tilføje Rayfin til et nyt eller eksisterende projekt.

Skænderi	Beskrivelse
--project-name <name>	Indstil projektets navn.
-t, --template <uri>	Angiv skabelon-URI'en, der skal bruges.
--template-name <name>	Vælg en skabelon efter navn.
-l, --list-templates	En liste over tilgængelige skabeloner.
--dialect <dialect>	Indstil databasedialekten.
--services <list>	Vælg hvilke tjenester, der vil aktiveres.
--auth-methods <list>	Vælg autentificeringsmetoder.
--static-hosting	Aktivér statisk hosting-opsætning.
--overwrite	Overskriv eksisterende genererede filer.
--workspace-id <id>	Brug et specifikt Fabric workspace ID.
--workspace-uri <uri>	Brug en specifik Fabric workspace URI.
--base-api-url <url>	Overtag den grundlæggende API-URL.
--item-id <id>	Mål et specifikt Fabric item ID.

Eksempler

Opvis tilgængelige skabeloner før stillads:

npx rayfin init --list-templates

Initialiser Rayfin i den aktuelle mappe ved at bruge en navngiven skabelon og en specifik dialekt:

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

Opret et nyt projekt ikke-interaktivt med tjenester og autentificering konfigureret:

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

Stikkommandoer

Kommandogruppen connector administrerer eksterne Fabric-datakilder.

rayfin connector types

Lister connector-typer, som du kan tilføje til et projekt.

Mulighed	Beskrivelse
--json	Udsend forbindelsestypelisten som JSON.
-v, --verbose	Inkluder detaljer om kapabiliteter.

rayfin connector search [query]

Søger i Fabric-kilder, som den indloggede identitet kan tilføje som connectors.

Argument eller mulighed	Beskrivelse
[query]	Valgfrit, kasus-ufølsomt kildenavn-filter.
--query <text>	Navngivet kilde-navn-filter, der har forrang over [query].
--type <type>	Komma-separerede stiktyper; krævet med --workspace-id eller --all-workspaces.
--workspace-id <id>	Søg i én Fabric workspace.
--all-workspaces	Søg i alle arbejdsområder, som identiteten kan få adgang til.
-y, --yes	Accepter automatisk den interaktive tilføjelsesoverdragelse.
--limit <n>	Maksimalt antal viste resultater.
--output <interactive\|plain\|json>	Vælg outputformatet.
--json	Print resultaterne som JSON og spring den interaktive picker over.
-v, --verbose	Aktivér verbose output.

Når ingen af arbejdsområderne er tilgængelige, søger kommandoen i de arbejdsområder, der er registreret for den aktuelle projektudrulning.

rayfin connector add --type <type>

Tilføjer en connector-deklaration og samler sine projektfiler.

Mulighed	Beskrivelse
--type <type>	Krævet. Stiktype; brug rayfin connector types til at liste typer.
--name <name>	Forbindelsesnavn; afledt af elementet, når det udelades.
--workspace-id <id>	Fabric workspace ID.
--item-id <id>	Fabric item ID.
--operations <ops>	Komma-separeret delmængde af tilladte operationer.
-v, --verbose	Aktivér verbose output.
-y, --yes	Accepter automatisk bekræftelser.
--json	Udsend JSON-output.

rayfin connector list

Lister de forbindelser, der er deklareret i rayfin.yml.

Mulighed	Beskrivelse
-v, --verbose	Inkluder connector-metadata og funktioner.
--json	Udsend JSON-output.

rayfin connector inspect

Inspicerer en konfigureret connector eller en direkte adresseret Fabric-kilde uden at foretage ændringer.

Mulighed	Beskrivelse
--name <name>	Konfigureret stiknavn.
-w, --workspace <name>	Arbejdsområdenavn til direkte inspektion.
--workspace-id <id>	Workspace ID til direkte inspektion.
--item <name>	Varenavn til direkte inspektion.
--item-id <id>	Vare-ID til direkte inspektion.
--type <type>	Stiktype til direkte inspektion.
--url <url>	Semantisk model portal URL; udleder arbejdsområdet og objekt-ID'erne.
--entity <name>	Entitet eller tabel til eksempel; udelad med --query for at liste entiteter.
--query <path>	.sql eller .dax fil, der skal køres i skrivebeskyttet tilstand.
--rows <n>	Rækkebegrænsning; standard er 10 for samples og er begrænset til 100.
-v, --verbose	Aktivér verbose output.
--output <interactive\|plain\|json>	Vælg outputformatet.
--json	Udsend JSON-output.

Brug --name til en konfigureret connector, en komplet direct-source selector eller --url til en semantisk model.

rayfin connector invoke [connector-name] [operation]

Påkalder en operation på en konfigureret connector.

Argument eller mulighed	Beskrivelse
[connector-name]	Konfigureret stiknavn.
[operation]	Stikoperation, såsom executeQuery.
--name <name>	Navngivet alternativ til [connector-name].
--operation <operation>	Navngivet alternativ til [operation].
--input <json>	JSON-operationens input.
--file <path>	JSON-fil, der indeholder operationens input.
--transport <auto\|deployed>	Påkaldelsessti; går som standard til auto.
-v, --verbose	Aktivér verbose output.
--output <interactive\|plain\|json>	Vælg outputformatet.
--output-file <path>	Skriv det komplette resultat til en fil.
--max-inline-bytes <bytes>	Resultatstørrelsesgrænsen for at skrive en fil; er som standard 1 MiB.
--json	Udsend JSON-output.

rayfin connector remove <name>

Fjerner en connector-deklaration og dens genererede connector-filer.

Argument eller mulighed	Beskrivelse
<name>	Krævet. Stiknavnet skal fjernes.
-v, --verbose	Aktivér verbose output.
-y, --yes	Accepter automatisk fjernelsesbekræftelsen.
--json	Udsend JSON-output.

Funktionskommandoer

rayfin functions init [directory]

Stiller stillads op og konfigurerer en Functions-pakke.

Argument eller mulighed	Beskrivelse
[directory]	Project root; starter med den aktuelle mappe.
--force	Overskriv et eksisterende Functions-stillads.
--path <relative-path>	Funktionspakkeplacering i forhold til projektets rod.

Pakkeplaceringen er som standard registreret arbejdsområde eller rayfin/functions.

Udviklingskommandoer

rayfin dev [project-path]

Starter en lokal udviklingssession mod en Rayfin-backend.

Argument eller mulighed	Beskrivelse
[project-path]	Project root; starter med den aktuelle mappe.
--skip-db-apply	Spring automatisk databasekonfiguration over.
--env-file <path>	.env fil brugt til rayfin.yml interpolation.
--provider <fabric>	Backend-udbyder; starter som standard .fabric
-w, --workspace <name>	Fabric workspace-navn for en first-run backend.
--workspace-id <id>	Fabric workspace ID til en first-run backend.
--capacity-id <id>	Fabric capacity ID for et arbejdsområde uden brugbar kapacitet.
-t, --tenant <id>	Microsoft Entra lejer-ID.
--encryption-fallback-enabled	Tillad klartekst-tokenlagring, når der ikke er nogen OS-nøglering tilgængelig.
--no-emit-env	Gengenerer ikke framework-filen .env.local .
-v, --verbose	Aktivér detaljeret logføring.

rayfin dev functions apply

Starter den lokale Functions-vært mod den aktive udrulning.

Mulighed	Beskrivelse
--port <port>	Local Functions værtsport; standard er .7071
--inspect-port <port>	Node.js inspektørport; går som standard til 9229.
--no-debug	Slå Node.js inspektøren fra.
--no-emit-env	Gengenerer ikke framework-filen .env.local .
--verbose	Vis diagnostisk output.
--json	Udsend JSON-output.
-y, --yes	Kør uden interaktive prompts.

Administrer agentfiler

Kommandoen rayfin init ai-files administrerer Rayfin-agentens kontekstfiler i dit projekt: AGENTS.md, .mcp.json, og .agents/skills/rayfin/SKILL.md. CLI installerer disse filer automatisk, når du stiller et projekt i en stillads. Kør kommandoerne nedenfor for at installere eller opdatere dem i et eksisterende projekt, eller tjek deres status.

rayfin init ai-files install

Installerer eller opdaterer Rayfin-agentfilerne. Kommandoen er idempotent og bevarer eksisterende brugerkonfiguration.

Mulighed	Beskrivelse
--enable <id>	Installer eller behold et bestemt element ved dets navnespaced ID, såsom skill:rayfin. Repeterbare.
--disable <id>	Stop med at administrere et bestemt element uden at slette dets fil. Repeterbare.
--remove-files	Fjern diskfilen, når du deaktiverer et element. Kræver --disable.
--force [ids...]	Overskriv ændrede genstande, genopret manglende genstande eller genopbygg misformede .mcp.json. Accepterer valgfrie navnespacede ID'er for at afgrænse operationen. Overskriver aldrig AGENTS.md.
-n, --dry-run	Rapportér ændringerne uden at skrive filer.
--json	Udsend struktureret output som JSON; indebærer ikke-interaktiv tilstand.
-y, --yes, --non-interactive	Spring den interaktive prompt over og accepter standardindstillinger.

For eksempel installer standardindstillinger uden at bede om det:

npx rayfin init ai-files install --yes

rayfin init ai-files status

Printer tilstanden på hver administreret agentfil. Brug --json til struktureret output.

Mulige tilstande inkluderer , , , , , , , orphaned, og unreadable. not-installeddisabledmissinguser-modifiedupdate-availableup-to-date Kør rayfin init ai-files install for at opdatere filer eller rayfin init ai-files install --force <id> for at overskrive et specifikt administreret element.

Deploy to Fabric

rayfin up

Brug rayfin up til at deploye applikationen til at Fabric som et Rayfin-element.

Skænderi	Beskrivelse
-t, --tenant <id>	Brug et specifikt lejer-ID.
-w, --workspace <name>	Deploy til et Fabric-arbejdsområde efter navn; standard er .My Workspace
--workspace-id <id>	Deploy til et specifikt Fabric workspace ID.
--workspace-uri <uri>	Deploy til en specifik Fabric workspace URI.
--item-name <name>	Fabric-objektets visningsnavn; standarden er projekt-ID.
--capacity-id <id>	Fabric kapacitets-ID, når målarbejdsområdet har brug for kapacitet.
--force	Tillad destruktive ændringer af data-skema.
-n, --dry-run	Valider input og løs arbejdsområdet uden at deploye.
--env-file <path>	.envfil for udrulningsegenskaber; standard er .rayfin/.env
-v, --verbose	Aktivér verbose output.
--json	Returner deploy-output i JSON-format.
-y, --yes	Accepter automatisk bekræftelser.
--encryption-fallback-enabled	Tillad klartekst-tokenlagring, når der ikke er nogen OS-nøglering tilgængelig.
--exclude-services <names>	Komma-separerede tjenester til at springe over under opbygning og udrulning: staticHosting eller functions.
--provider <fabric>	Deployeringsudbyder; starter som standard .fabric

Eksempler

Deploy til det aktuelt valgte Fabric-arbejdsområde:

npx rayfin up

Forhåndsvis deployeringshandlinger uden at anvende dem:

npx rayfin up --dry-run --verbose

Deploy til et specifikt arbejdsområde ikke-interaktivt:

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

Udrul uden at bygge eller implementere funktioner:

npx rayfin up --exclude-services functions

--capacity-id kan ikke kombineres med --workspace, --workspace-id, eller --workspace-uri.

Underkommandoen	Beskrivelse
npx rayfin up db apply	Generer og anvend DAB-konfiguration på det eksterne Rayfin-item workload-endpoint.
npx rayfin up functions deploy	Byg, pakke og deployer funktioner til det aktive fjernelement.
npx rayfin up staticapp deploy	Byg, pakke og deployer statisk indhold til det eksterne Rayfin-element.
npx rayfin up connector apply	Anvend databasekonfiguration for deklarerede GraphQL-forbindelser.
npx rayfin up status	Vis den aktuelle udsendelsesstatus.
npx rayfin up list	Opfør alle Fabric-udrulninger, der er registreret for projektet.
npx rayfin up switch [workspace]	Skift den aktive Fabric deployment og omskriv rayfin/.env.

rayfin up db apply

Genererer og anvender DAB-konfiguration på det eksterne Rayfin-item workload-endpoint.

Skænderi	Beskrivelse
--verbose	Vis ordrig output.
--force	Force regeneration og anvend konfiguration.
--json	Returner output i JSON-format.

Eksempler

Anvend databasekonfigurationsændringer på det eksterne Rayfin-element:

npx rayfin up db apply

Kraftregenerering og opsamling af maskinlæsbart output:

npx rayfin up db apply --force --json

rayfin up functions deploy

Bygger, pakker og deployerer funktioner til det aktive fjernelement.

Mulighed	Beskrivelse
--verbose	Vis ordrig output.
--skip-build	Udrul eksisterende Functions-output uden at bygge.
--json	Udsend JSON-output.

rayfin up connector apply

Anvender databasekonfiguration for deklarerede GraphQL-forbindelser.

Mulighed	Beskrivelse
--name <name>	Påfør kun den navngivne connector.
--verbose	Aktivér verbose output.
--json	Udsend JSON-output.

rayfin up staticapp deploy

Bygger, pakker og deployerer statisk indhold til det eksterne Rayfin-element.

Skænderi	Beskrivelse
--verbose	Vis ordrig output.
--skip-build	Deploy uden at køre build-trinnet.
--json	Returner output i JSON-format.

Eksempler

Byg og udrul statisk indhold:

npx rayfin up staticapp deploy

Udrul en færdigbygget dist mappe uden at køre buildet igen:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Viser status for cloud-implementeringen.

Skænderi	Beskrivelse
--json	Returneringsstatus i JSON-format.
--verbose	Vis ordrig output.

Eksempler

Tjek den aktuelle udrulningsstatus:

npx rayfin up status

Returner status som JSON til brug i scripts:

npx rayfin up status --json

rayfin up list

Lister alle Fabric-udrulninger registreret for dette projekt.

Skænderi	Beskrivelse
--json	Returner deploylisten i JSON-format.

Eksempler

Opvis alle registrerede Fabric-udrulninger for projektet:

npx rayfin up list

rayfin up switch [workspace]

Skifter den aktive Fabric deployment og omskriver rayfin/.env derefter.

Skænderi	Beskrivelse
-l, --list	Opfør tilgængelige udrulninger uden at skifte.
--no-emit-env	Spring over at skrive udsendte miljøfiler.

Eksempler

List tilgængelige udrulninger at skifte til:

npx rayfin up switch --list

Skift den aktive udrulning til et specifikt arbejdsområde:

npx rayfin up switch my-workspace

Generer miljøfiler

rayfin env

Brug rayfin env til at udsende rammeværksspecifikke .env.local værdier fra rayfin/.env.

Skænderi	Beskrivelse
--framework <vite|nextjs|plain>	Vælg det målrettede rammeværksformat.
--output <dir>	Skriv genererede filer til en bestemt mappe.
--show	Udskriv udsendte værdier uden at skrive filer.

Eksempler

Generer en Vite-kompatibel .env.local:

npx rayfin env --framework vite

Forhåndsvisning af udsendte miljøværdier uden at skrive filer:

npx rayfin env --framework nextjs --show

Log ind og ud

rayfin login

Jeg bruger rayfin login det til at logge ind på Rayfin-platformen.

Skænderi	Beskrivelse
--tenant <id>	Brug et specifikt lejer-ID.
--service-principal	Forsøg at logge ind med tjenesteleder. Denne mulighed står i hjælpen, men understøttes ikke i øjeblikket.
-u, --client-id <id>	Angiv klient-ID'et til log ind for tjenesteprincipalen. Denne mulighed står i hjælpen, men understøttes ikke i øjeblikket.
-p, --client-secret <secret>	Giv klienthemmeligheden til log ind for tjenesteprincipalen. Denne mulighed står i hjælpen, men understøttes ikke i øjeblikket.
--select	Vælg blandt tilgængelige login-konti eller kontekster.
--encryption-fallback-enabled	Aktiver krypterings-fallback-adfærd.

Eksempler

Log ind interaktivt:

npx rayfin login

Log ind hos en bestemt lejer:

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

Skift mellem indloggede konti:

npx rayfin login --select

Underkommandoen	Beskrivelse
npx rayfin login status	Vis den aktuelle autentificeringsstatus.

rayfin login status

Viser aktuel autentificeringsstatus.

Skænderi	Beskrivelse
Ingen	Denne underkommando nævner ikke nogen muligheder i CLI-hjælpeoutputtet.

Eksempel

Tjek om du er logget ind:

npx rayfin login status

rayfin logout

Logger ud og rydder cachede legitimationsoplysninger.

Skænderi	Beskrivelse
Ingen	Denne kommando viser ikke nogen muligheder i CLI-hjælpeoutputtet.

Eksempel

Log ud og snyd cachede legitimationsoplysninger:

npx rayfin logout