Rayfin CLI-referens

Hitta Rayfin CLI-kommandon för att skapa projekt, hantera schemaändringar, distribuera till Fabric och konfigurera miljöinställningar. Varje avsnitt listar kommandosyntax, alternativ och vanliga användningsområden.

Installation

Använd npm i @microsoft/rayfin-cli för att installera grafikkortet.

Komma igång

Följ stegen i din terminal för att skapa 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/Råd

För befintliga eller tomma projekt, använd npx rayfin init istället för npm create att lägga till Rayfin i ett projekt som redan har källkod eller en tom katalog. Kommandot init guidar dig genom att aktivera tjänster, välja en databasdialekt och konfigurera statisk hosting utan att behöva bygga upp en ny mall.

För hela genomgången, se Skapa och distribuera din första Fabric-app med CLI och Distribuera en Fabric-app till Fabric.

Ett projekt med ett ställningsställning npm create

npm create (alias för npm init) bootstrappar ett nytt projekt genom att anropa ett Create Initializer-paket. För att stödja en Fabric-app, använd den med @microsoft/rayfin-initialiseraren:

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

Referens för kommandon

Kommandon och flaggor i denna artikel har verifierats från den lokalt installerade CLI-hjälputdatan.

Kommandon på den översta nivån

Använd denna tabell för att snabbt hitta rätt kommando.

Command Använd den för att
npx rayfin init [directory] Skapa eller konfigurera ett Rayfin-projekt.
npx rayfin up Distribuera appen till Fabric och hantera fjärrdistributioner.
npx rayfin env Generera ramverksspecifika miljöfiler från rayfin/.env.
npx rayfin login Logga in på Rayfin-plattformen.
npx rayfin logout Logga ut och rensa cachelagrade inloggningsuppgifter.

Skapa eller konfigurera ett projekt

rayfin init [directory]

Använd rayfin init för att lägga till Rayfin i ett nytt eller befintligt projekt.

Argument Description
--project-name <name> Sätt projektets namn.
-t, --template <uri> Ange vilken mall-URI som ska användas.
--template-name <name> Välj en mall efter namn.
-l, --list-templates Lista tillgängliga mallar.
--dialect <dialect> Ställ in databasens dialekt.
--services <list> Välj vilka tjänster du ska möjliggöra.
--auth-methods <list> Välj autentiseringsmetoder.
--static-hosting Aktivera statisk hosting-installation.
--overwrite Skriv över befintliga genererade filer.
--workspace-id <id> Använd ett specifikt Fabric workspace-ID.
--workspace-uri <uri> Använd en specifik Fabric workspace URI.
--base-api-url <url> Överskriv bas-API:n.
--item-id <id> Sikta på ett specifikt Fabric-produkt-ID.

Examples

Lista tillgängliga mallar innan du byggställningar:

npx rayfin init --list-templates

Initiera Rayfin i den aktuella katalogen genom att använda en namngiven mall och en specifik dialekt:

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

Skapa ett nytt projekt icke-interaktivt med tjänster och autentisering konfigurerade:

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

Distribuera till Fabric

rayfin up

Använd rayfin up för att distribuera applikationen till Fabric som ett Rayfin-objekt.

Argument Description
--tenant <id> Använd ett specifikt hyresgäst-ID.
--workspace-id <id> Distribuera till ett specifikt Fabric-arbetsområdes-ID.
--workspace-uri <uri> Distribuera till en specifik Fabric-workspace-URI.
--base-api-url <url> Överskriv bas-API:n.
--force Force deployment steg när det behövs.
--dry-run Förhandsgranska utrullningsåtgärder utan att tillämpa dem.
--env-file <path> Ladda miljövärden från en fil.
--verbose Visa utförligt utfall av utplacering.
--json Returnera distributionsutdata i JSON-format.
-y, --yes Acceptera prompts automatiskt.
--encryption-fallback-enabled Aktivera krypterings-fallback-beteende.

Examples

Distribuera till det nuvarande valda Fabric-arbetsytet:

npx rayfin up

Förhandsgranska utrullningsåtgärder utan att tillämpa dem:

npx rayfin up --dry-run --verbose

Distribuera till en specifik arbetsplats utan interactive:

npx rayfin up --workspace-id 00000000-0000-0000-0000-000000000000 --yes
Subcommand Description
npx rayfin up db apply Generera och applicera DAB-konfiguration på den fjärrstyrda Rayfin-artikelns arbetsbelastningsendpoint.
npx rayfin up staticapp deploy Bygg, paketera och distribuera statiskt innehåll till det fjärrstyrda Rayfin-objektet.
npx rayfin up status Visa aktuell utplaceringsstatus.
npx rayfin up list Lista alla Fabric-installationer registrerade för projektet.
npx rayfin up switch [workspace] Byt aktiv Fabric distribution och skriv om rayfin/.env.

rayfin up db apply

Genererar och applicerar DAB-konfiguration på den fjärrstyrda Rayfin-artikelns arbetsbelastningsendpoint.

Argument Description
--verbose Visa utförliga utdata.
--force Kraftregenerering och tillämpa konfiguration.
--json Returnera utdata i JSON-format.

Examples

Tillämpa databaskonfigurationsändringar på det fjärrstyrda Rayfin-objektet:

npx rayfin up db apply

Kraftregenerering och fångst maskinläsbar utdata:

npx rayfin up db apply --force --json

rayfin up staticapp deploy

Bygger, paketerar och distribuerar statiskt innehåll till det fjärrstyrda Rayfin-objektet.

Argument Description
--verbose Visa utförliga utdata.
--skip-build Distribuera utan att köra byggsteget.
--json Returnera utdata i JSON-format.

Examples

Bygg och distribuera statiskt innehåll:

npx rayfin up staticapp deploy

Distribuera en förbyggd dist mapp utan att köra om bygget:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Visar statusen för molndistributionen.

Argument Description
--json Återvändningsstatus i JSON-format.
--verbose Visa utförliga utdata.

Examples

Kontrollera den aktuella utplaceringsstatusen:

npx rayfin up status

Returnera status som JSON för användning i skript:

npx rayfin up status --json

rayfin up list

Listar alla Fabric-utplaceringar registrerade för detta projekt.

Argument Description
--json Returnera distributionslistan i JSON-format.

Examples

Lista alla registrerade Fabric-installationer för projektet:

npx rayfin up list

rayfin up switch [workspace]

Byter aktiv Fabric distribution och skriver om rayfin/.env därefter.

Argument Description
-l, --list Lista tillgängliga distributioner utan att byta.
--no-emit-env Hoppa över att skriva filer för emitterade miljöer.

Examples

Lista tillgängliga distributioner att byta till:

npx rayfin up switch --list

Byt den aktiva distributionen till en specifik arbetsyta:

npx rayfin up switch my-workspace

Generera miljöfiler

rayfin env

Använd rayfin env för att avge ramverksspecifika .env.local värden från rayfin/.env.

Argument Description
--framework <vite|nextjs|plain> Välj det avsedda ramformatet.
--output <dir> Skriv genererade filer till en specifik katalog.
--show Skriv ut emitterade värden utan att skriva filer.

Examples

Generera en Vite-kompatibel .env.local:

npx rayfin env --framework vite

Förhandsgranska utgivna miljövärden utan att skriva filer:

npx rayfin env --framework nextjs --show

Logga in och logga ut

rayfin login

Använd rayfin login det för att logga in på Rayfin-plattformen.

Argument Description
--tenant <id> Använd ett specifikt hyresgäst-ID.
--service-principal Försök logga in som tjänstechef. Detta alternativ finns i hjälp men stöds inte för tillfället.
-u, --client-id <id> Ange klient-ID för inloggning med tjänstehuvudansvarig. Detta alternativ finns i hjälp men stöds inte för tillfället.
-p, --client-secret <secret> Tillhandahåll klienthemligheten för inloggning till tjänstehuvudpersonen. Detta alternativ finns i hjälp men stöds inte för tillfället.
--select Välj bland tillgängliga inloggade konton eller sammanhang.
--encryption-fallback-enabled Aktivera krypterings-fallback-beteende.

Examples

Logga in interaktivt:

npx rayfin login

Logga in på en specifik hyresgäst:

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

Byt mellan inloggade konton:

npx rayfin login --select
Subcommand Description
npx rayfin login status Visa den aktuella autentiseringsstatusen.

rayfin login status

Visar aktuell autentiseringsstatus.

Argument Description
None Detta underkommando listar inga alternativ i CLI-hjälputdatan.

Example

Kontrollera om du är inloggad:

npx rayfin login status

rayfin logout

Loggar ut och rensar cachade inloggningsuppgifter.

Argument Description
None Detta kommando listar inga alternativ i CLI-hjälputdata.

Example

Logga ut och rensa cachade inloggningsuppgifter:

npx rayfin logout
  • Last updated on