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
npm run 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
rayfin init [directory] Opret eller konfigurér et Rayfin-projekt.
rayfin up Udrul appen til Fabric og administrer fjernudrulninger.
rayfin env Generer framework-specifikke miljøfiler fra rayfin/.env.
rayfin login Log ind på Rayfin-platformen.
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

Deploy to Fabric

rayfin up

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

Skænderi Beskrivelse
--tenant <id> Brug et specifikt lejer-ID.
--workspace-id <id> Deploy til et specifikt Fabric workspace ID.
--workspace-uri <uri> Deploy til en specifik Fabric workspace URI.
--base-api-url <url> Overtag den grundlæggende API-URL.
--force Force deployment trin, når det er nødvendigt.
--dry-run Forhåndsvis deployeringshandlinger uden at anvende dem.
--env-file <path> Indlæs miljøværdier fra en fil.
--verbose Vis udførligt udsendelsesoutput.
--json Returner deploy-output i JSON-format.
-y, --yes Accepter prompts automatisk.
--encryption-fallback-enabled Aktiver krypterings-fallback-adfærd.

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 00000000-0000-0000-0000-000000000000 --yes
Underkommandoen Beskrivelse
rayfin up db apply Generer og anvend DAB-konfiguration på det eksterne Rayfin-item workload-endpoint.
rayfin up staticapp deploy Byg, pakke og deployer statisk indhold til det eksterne Rayfin-element.
rayfin up status Vis den aktuelle udsendelsesstatus.
rayfin up list Opfør alle Fabric-udrulninger, der er registreret for projektet.
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 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
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
  • Last updated on