Rayfin CLI-referanse

Finn Rayfin CLI-kommandoene for å lage prosjekter, administrere skjemaendringer, distribuere til Fabric og konfigurere miljøinnstillinger. Hver seksjon lister kommandosyntaks, alternativer og vanlige bruksområder.

Installasjon

Bruk npm i @microsoft/rayfin-cli den for å installere CLI-en.

Komme i gang

Følg stegene i terminalen din for å lage 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

Tips

For eksisterende eller tomme prosjekter, bruk npx rayfin init i stedet for npm create å legge til Rayfin i et prosjekt som allerede har kildekode eller en tom katalog. Kommandoen init veileder deg gjennom å aktivere tjenester, velge en databasedialekt og konfigurere statisk hosting uten å støtte en ny mal.

For hele gjennomgangen, se Opprett og distribuer din første Fabric-app med CLI og Distribuer en Fabric-app til Fabric.

Stillas et prosjekt med npm create

npm create (alias av npm init) bootstrapper et nytt prosjekt ved å starte en Create Initializer-pakke. For å støtte en Fabric-app, bruk den med @microsoft/rayfin-initialisatoren:

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

Kommandoreferanse

Kommandoene og flaggene i denne artikkelen ble verifisert fra den lokalt installerte CLI-hjelpeutdataen.

Kommandoer på toppnivå

Bruk denne tabellen for å finne riktig kommando raskt.

Kommando	Bruk det til å
npx rayfin init [directory]	Lag eller konfigurer et Rayfin-prosjekt.
npx rayfin connector	Finn, konfigurer, inspiserer og aktiver Fabric-datakoblinger.
npx rayfin functions init	Scaffold en Functions-pakke.
npx rayfin dev	Kjør appen og funksjonene lokalt.
npx rayfin init ai-files	Installer eller sjekk Rayfin-agentens kontekstfiler.
npx rayfin up	Distribuer appen til Fabric og administrer fjernutrullinger.
npx rayfin env	Generer rammeverksspesifikke miljøfiler fra rayfin/.env.
npx rayfin login	Logg inn på Rayfin-plattformen.
npx rayfin logout	Logg ut og fjern bufrede legitimasjoner.

Opprett eller konfigurer et prosjekt

rayfin init [directory]

Bruk rayfin init det for å legge til Rayfin i et nytt eller eksisterende prosjekt.

Diskusjon	Beskrivelse
--project-name <name>	Sett prosjektnavnet.
-t, --template <uri>	Spesifiser mal-URI-en som skal brukes.
--template-name <name>	Velg en mal etter navn.
-l, --list-templates	List opp tilgjengelige maler.
--dialect <dialect>	Sett databasedialekten.
--services <list>	Velg hvilke tjenester du vil muliggjøre.
--auth-methods <list>	Velg autentiseringsmetoder.
--static-hosting	Aktiver statisk hostingoppsett.
--overwrite	Overskriv eksisterende genererte filer.
--workspace-id <id>	Bruk en spesifikk Fabric arbeidsområde-ID.
--workspace-uri <uri>	Bruk en spesifikk Fabric workspace URI.
--base-api-url <url>	Overstyr den grunnleggende API-URL-en.
--item-id <id>	Sikt mot en spesifikk Fabric-vare-ID.

Eksempler

List opp tilgjengelige maler før stillasbygging:

npx rayfin init --list-templates

Initialiser Rayfin i den nåværende katalogen ved å bruke en navngitt mal og en spesifikk dialekt:

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

Opprett et nytt prosjekt ikke-interaktivt med tjenester og autentisering konfigurert:

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

Koblingskommandoer

Kommandogruppen connector administrerer eksterne Fabric-datakilder.

rayfin connector types

Lister opp koblingstyper du kan legge til i et prosjekt.

Alternativ	Beskrivelse
--json	Send ut kontakttypelisten som JSON.
-v, --verbose	Inkluder kapasitetsdetaljer.

rayfin connector search [query]

Søker i Fabric-kilder som den innloggede identiteten kan legge til som koblinger.

Argument eller alternativ	Beskrivelse
[query]	Valgfri, mellom-kasus-sensitiv kildenavn-filter.
--query <text>	Navngitt kilde-navn-filter som har forrang over [query].
--type <type>	Komma-separerte kontakttyper; kreves med --workspace-id eller --all-workspaces.
--workspace-id <id>	Søk i en Fabric workspace.
--all-workspaces	Søk gjennom alle arbeidsområder identiteten kan få tilgang til.
-y, --yes	Aksepter automatisk den interaktive tilleggsoverleveringen.
--limit <n>	Maksimalt antall viste resultater.
--output <interactive\|plain\|json>	Velg utgangsformatet.
--json	Skriv ut resultatene som JSON og hopp over den interaktive plukkeren.
-v, --verbose	Aktiver verbose output.

Når ingen av arbeidsområdene er tilgjengelig, søker kommandoen i arbeidsområdene som er registrert for den nåværende prosjektutrullingen.

rayfin connector add --type <type>

Legger til en tilkoblingserklæring og støtter prosjektfilene sine.

Alternativ	Beskrivelse
--type <type>	Påkrevd. Kontakttype; bruk rayfin connector types for å liste opp typer.
--name <name>	Koblingsnavn; avledet fra elementet når det utelates.
--workspace-id <id>	Fabric arbeidsområde-ID.
--item-id <id>	Fabric item ID.
--operations <ops>	Komma-separert delmengde av tillatte operasjoner.
-v, --verbose	Aktiver verbose output.
-y, --yes	Godkjenn bekreftelser automatisk.
--json	Send ut JSON-utgang.

rayfin connector list

Lister opp kontaktene som er deklarert i rayfin.yml.

Alternativ	Beskrivelse
-v, --verbose	Inkluder kontaktmetadata og funksjonalitet.
--json	Send ut JSON-utgang.

rayfin connector inspect

Inspiserer en konfigurert kontakt eller en direkte adressert Fabric-kilde uten å gjøre endringer.

Alternativ	Beskrivelse
--name <name>	Konfigurert kontaktnavn.
-w, --workspace <name>	Arbeidsplassens navn for direkte inspeksjon.
--workspace-id <id>	Arbeidsplass-ID for direkte inspeksjon.
--item <name>	Varenavn for direkte inspeksjon.
--item-id <id>	Gjenstands-ID for direkte inspeksjon.
--type <type>	Kontakttype for direkte inspeksjon.
--url <url>	Semantisk modellportal-URL; utleder arbeidsområdet og gjenstands-IDene.
--entity <name>	Entitet eller tabell til utvalg; utelat med --query for å liste entiteter.
--query <path>	.sql eller .dax filen som skal kjøres i skrivebeskyttet modus.
--rows <n>	Radgrense; er standard 10 for prøver og er begrenset til 100.
-v, --verbose	Aktiver verbose output.
--output <interactive\|plain\|json>	Velg utgangsformatet.
--json	Send ut JSON-utgang.

Bruk --name for en konfigurert kontakt, en komplett direktekildevelger, eller --url for en semantisk modell.

rayfin connector invoke [connector-name] [operation]

Utløser en operasjon på en konfigurert kontakt.

Argument eller alternativ	Beskrivelse
[connector-name]	Konfigurert kontaktnavn.
[operation]	Koblingsoperasjon, slik som executeQuery.
--name <name>	Navngitt alternativ til [connector-name].
--operation <operation>	Navngitt alternativ til [operation].
--input <json>	JSON-operasjonsinput.
--file <path>	JSON-fil som inneholder operasjonsinput.
--transport <auto\|deployed>	Invokasjonssti; går som standard til auto.
-v, --verbose	Aktiver verbose output.
--output <interactive\|plain\|json>	Velg utgangsformatet.
--output-file <path>	Skriv det komplette resultatet til en fil.
--max-inline-bytes <bytes>	Resultatstørrelsesterskel for å skrive en fil; er standard 1 MiB.
--json	Send ut JSON-utgang.

rayfin connector remove <name>

Fjerner en connector-deklarasjon og dens genererte connector-filer.

Argument eller alternativ	Beskrivelse
<name>	Påkrevd. Navnet på kontakten skal fjernes.
-v, --verbose	Aktiver verbose output.
-y, --yes	Godkjenn automatisk bekreftelsen på fjerningen.
--json	Send ut JSON-utgang.

Funksjonskommandoer

rayfin functions init [directory]

Stillas og konfigurerer en Functions-pakke.

Argument eller alternativ	Beskrivelse
[directory]	Project root; går som standard til den nåværende katalogen.
--force	Overskriv et eksisterende Functions-stillas.
--path <relative-path>	Funksjonspakkens plassering relativt til prosjektroten.

Pakkeplasseringen er som standard en oppdaget arbeidsplasslokasjon eller rayfin/functions.

Utviklingskommandoer

rayfin dev [project-path]

Starter en lokal utviklingsøkt mot en Rayfin-backend.

Argument eller alternativ	Beskrivelse
[project-path]	Project root; går som standard til den nåværende katalogen.
--skip-db-apply	Hopp over automatisk databasekonfigurasjon og anvend.
--env-file <path>	.env fil brukt til rayfin.yml interpolasjon.
--provider <fabric>	Backend-leverandør; går som standard til fabric.
-w, --workspace <name>	Fabric workspace-navn for en first-run backend.
--workspace-id <id>	Fabric workspace ID for en førstegangs backend.
--capacity-id <id>	Fabric kapasitets-ID for et arbeidsområde uten brukbar kapasitet.
-t, --tenant <id>	Microsoft Entra leietaker-ID.
--encryption-fallback-enabled	Tillat lagring av klarteksttoken når ingen OS-nøkkelring er tilgjengelig.
--no-emit-env	Ikke regenerer framework-filen .env.local .
-v, --verbose	Aktiver detaljert logging.

rayfin dev functions apply

Starter den lokale Functions-verten mot den aktive distribusjonen.

Alternativ	Beskrivelse
--port <port>	Lokal Functions vertsport; går som standard til 7071.
--inspect-port <port>	Node.js inspektørport; går som standard til 9229.
--no-debug	Deaktiver Node.js inspektør.
--no-emit-env	Ikke regenerer framework-filen .env.local .
--verbose	Vis diagnostisk utgang.
--json	Send ut JSON-utgang.
-y, --yes	Kjør uten interaktive prompts.

Administrer agentfiler

Kommandoen rayfin init ai-files håndterer Rayfin-agentens kontekstfiler i prosjektet ditt: AGENTS.md, .mcp.json, og .agents/skills/rayfin/SKILL.md. CLI-en installerer disse filene automatisk når du støtter et prosjekt. Kjør kommandoene nedenfor for å installere eller oppdatere dem i et eksisterende prosjekt, eller sjekk statusen deres.

rayfin init ai-files install

Installerer eller oppdaterer Rayfin-agentfilene. Kommandoen er idempotent og bevarer eksisterende brukerkonfigurasjon.

Alternativ	Beskrivelse
--enable <id>	Installer eller behold et spesifikt element med dets navnespacede ID, for eksempel skill:rayfin. Repeterbare.
--disable <id>	Slutt å administrere et spesifikt element uten å slette filen. Repeterbare.
--remove-files	Fjern filen på disken når du deaktiverer et element. Krever --disable.
--force [ids...]	Overskriv modifiserte gjenstander, reparer manglende gjenstander, eller bygg opp feilformaterte .mcp.jsongjenstander. Godtar valgfrie navnespace-ID-er for å begrense operasjonen. Overskriver aldri AGENTS.md.
-n, --dry-run	Rapporter endringene uten å skrive filer.
--json	Send ut strukturert output som JSON; innebærer ikke-interaktiv modus.
-y, --yes, --non-interactive	Hopp over den interaktive prompten og aksepter standardinnstillinger.

For eksempel, installer standardinnstillinger uten å be om:

npx rayfin init ai-files install --yes

rayfin init ai-files status

Skriver ut tilstanden til hver administrert agentfil. Bruk --json for strukturert output.

Mulige tilstander inkluderer up-to-date, , , user-modified, missing, not-installeddisabled, , orphanedog unreadableupdate-available. Kjør rayfin init ai-files install for å oppdatere filer eller rayfin init ai-files install --force <id> for å overskrive et spesifikt administrert element.

Deploy to Fabric

rayfin up

Bruk rayfin up for å distribuere applikasjonen til Fabric som et Rayfin-element.

Diskusjon	Beskrivelse
-t, --tenant <id>	Bruk en spesifikk leietaker-ID.
-w, --workspace <name>	Distribuer til et Fabric-arbeidsområde etter navn; standard er My Workspace.
--workspace-id <id>	Distribuer til en spesifikk Fabric arbeidsområde-ID.
--workspace-uri <uri>	Distribuer til en spesifikk Fabric-arbeidsområde-URI.
--item-name <name>	Fabric-objektets visningsnavn; går som standard til prosjekt-ID.
--capacity-id <id>	Fabric kapasitets-ID når målarbeidsområdet trenger kapasitet.
--force	Tillat destruktive endringer i data-skjema.
-n, --dry-run	Valider input og løs arbeidsområdet uten å deploye.
--env-file <path>	.envfil for distribusjonsegenskaper; standard er .rayfin/.env
-v, --verbose	Aktiver verbose output.
--json	Returner distribusjonsdata i JSON-format.
-y, --yes	Godkjenn bekreftelser automatisk.
--encryption-fallback-enabled	Tillat lagring av klarteksttoken når ingen OS-nøkkelring er tilgjengelig.
--exclude-services <names>	Komma-separerte tjenester for å hoppe over under bygging og utrulling: staticHosting eller functions.
--provider <fabric>	Deployeringsleverandør; går som standard til fabric.

Eksempler

Distribuer til det nåværende valgte Fabric-arbeidsområdet:

npx rayfin up

Forhåndsvis deployeringshandlinger uten å bruke dem:

npx rayfin up --dry-run --verbose

Distribuer til et spesifikt arbeidsområde ikke-interaktivt:

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

Distribuer uten å bygge eller distribuere funksjoner:

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 bruk DAB-konfigurasjon på det eksterne Rayfin-elementets arbeidsbelastningsendepunkt.
npx rayfin up functions deploy	Bygg, pakk og distribuer Functions til det aktive eksterne elementet.
npx rayfin up staticapp deploy	Bygg, pakk og distribuer statisk innhold til det eksterne Rayfin-elementet.
npx rayfin up connector apply	Bruk databasekonfigurasjon for deklarerte GraphQL-kontakter.
npx rayfin up status	Vis nåværende utplasseringsstatus.
npx rayfin up list	List opp alle Fabric-utplasseringer registrert for prosjektet.
npx rayfin up switch [workspace]	Bytt aktiv Fabric deployering og skriv om rayfin/.env.

rayfin up db apply

Genererer og anvender DAB-konfigurasjon på det eksterne Rayfin-elementets arbeidsbelastningsendepunkt.

Diskusjon	Beskrivelse
--verbose	Vis ordrik utdata.
--force	Kraftregenerering og bruk konfigurasjon.
--json	Returner utgang i JSON-format.

Eksempler

Bruk databasekonfigurasjonsendringer på det eksterne Rayfin-elementet:

npx rayfin up db apply

Kraftregenerering og fangst maskinlesbar utgang:

npx rayfin up db apply --force --json

rayfin up functions deploy

Bygger, pakker og distribuerer funksjoner til det aktive eksterne elementet.

Alternativ	Beskrivelse
--verbose	Vis ordrik utdata.
--skip-build	Distribuer eksisterende Functions-utgang uten å bygge.
--json	Send ut JSON-utgang.

rayfin up connector apply

Anvender databasekonfigurasjon for deklarerte GraphQL-kontakter.

Alternativ	Beskrivelse
--name <name>	Bruk kun den navngitte kontakten.
--verbose	Aktiver verbose output.
--json	Send ut JSON-utgang.

rayfin up staticapp deploy

Bygger, pakker og distribuerer statisk innhold til det eksterne Rayfin-elementet.

Diskusjon	Beskrivelse
--verbose	Vis ordrik utdata.
--skip-build	Deploy uten å kjøre byggesteget.
--json	Returner utgang i JSON-format.

Eksempler

Bygg og distribuer statisk innhold:

npx rayfin up staticapp deploy

Distribuer en ferdigbygd dist mappe uten å kjøre bygget på nytt:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Viser statusen til skyutrullingen.

Diskusjon	Beskrivelse
--json	Returstatus i JSON-format.
--verbose	Vis ordrik utdata.

Eksempler

Sjekk gjeldende utplasseringsstatus:

npx rayfin up status

Returner status som JSON for bruk i skript:

npx rayfin up status --json

rayfin up list

Lister alle Fabric-utplasseringer registrert for dette prosjektet.

Diskusjon	Beskrivelse
--json	Returner distribusjonslisten i JSON-format.

Eksempler

List opp alle registrerte Fabric-utplasseringer for prosjektet:

npx rayfin up list

rayfin up switch [workspace]

Bytter aktiv Fabric distribusjon og omskriver rayfin/.env deretter.

Diskusjon	Beskrivelse
-l, --list	List opp tilgjengelige distribusjoner uten å bytte.
--no-emit-env	Hopp over å skrive utsendte miljøfiler.

Eksempler

List over tilgjengelige distribusjoner du kan bytte til:

npx rayfin up switch --list

Bytt aktiv distribusjon til et spesifikt arbeidsområde:

npx rayfin up switch my-workspace

Generer miljøfiler

rayfin env

Bruk rayfin env for å utløse rammeverksspesifikke .env.local verdier fra rayfin/.env.

Diskusjon	Beskrivelse
--framework <vite|nextjs|plain>	Velg målrammeformatet.
--output <dir>	Skriv genererte filer til en spesifikk mappe.
--show	Skriv ut emitterte verdier uten å skrive filer.

Eksempler

Generer en Vite-kompatibel .env.local:

npx rayfin env --framework vite

Forhåndsvisning av utsendte miljøverdier uten å skrive filer:

npx rayfin env --framework nextjs --show

Logg inn og ut

rayfin login

Bruk rayfin login den for å logge inn på Rayfin-plattformen.

Diskusjon	Beskrivelse
--tenant <id>	Bruk en spesifikk leietaker-ID.
--service-principal	Forsøk å logge inn som tjenesteleder. Dette alternativet er oppført i hjelpen, men støttes ikke for øyeblikket.
-u, --client-id <id>	Oppgi klient-ID-en for innlogging til tjenestelederen. Dette alternativet er oppført i hjelpen, men støttes ikke for øyeblikket.
-p, --client-secret <secret>	Oppgi klienthemmeligheten for innlogging til tjenestelederen. Dette alternativet er oppført i hjelpen, men støttes ikke for øyeblikket.
--select	Velg blant tilgjengelige innloggede kontoer eller kontekster.
--encryption-fallback-enabled	Aktiver krypterings-fallback-atferd.

Eksempler

Logg inn interaktivt:

npx rayfin login

Logg inn på en bestemt leietaker:

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

Bytt mellom innloggede kontoer:

npx rayfin login --select

Underkommandoen	Beskrivelse
npx rayfin login status	Vis gjeldende autentiseringsstatus.

rayfin login status

Viser gjeldende autentiseringsstatus.

Diskusjon	Beskrivelse
Ingen	Denne underkommandoen lister ikke opp noen alternativer i CLI-hjelpeutdataen.

Eksempel

Sjekk om du er innlogget:

npx rayfin login status

rayfin logout

Logger ut og tømmer bufret legitimasjon.

Diskusjon	Beskrivelse
Ingen	Denne kommandoen lister ikke opp noen alternativer i CLI-hjelpeutgangen.

Eksempel

Logg ut og fjern bufret legitimasjon:

npx rayfin logout