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
npm run 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 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

Deploy to Fabric

rayfin up

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

Diskusjon	Beskrivelse
--tenant <id>	Bruk en spesifikk leietaker-ID.
--workspace-id <id>	Distribuer til en spesifikk Fabric arbeidsområde-ID.
--workspace-uri <uri>	Distribuer til en spesifikk Fabric-arbeidsområde-URI.
--base-api-url <url>	Overstyr den grunnleggende API-URL-en.
--force	Tvangsinnsats når det trengs.
--dry-run	Forhåndsvis deployeringshandlinger uten å bruke dem.
--env-file <path>	Last inn miljøverdier fra en fil.
--verbose	Vis omfattende utrullingsresultat.
--json	Returner distribusjonsdata i JSON-format.
-y, --yes	Godta prompts automatisk.
--encryption-fallback-enabled	Aktiver krypterings-fallback-atferd.

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 00000000-0000-0000-0000-000000000000 --yes

Underkommandoen	Beskrivelse
npx rayfin up db apply	Generer og bruk DAB-konfigurasjon på det eksterne Rayfin-elementets arbeidsbelastningsendepunkt.
npx rayfin up staticapp deploy	Bygg, pakk og distribuer statisk innhold til det eksterne Rayfin-elementet.
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 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