Rayfin CLI-referentie

Zoek de Rayfin CLI-commando's voor het aanmaken van projecten, het beheren van schemawijzigingen, het deployen naar Fabric en het configureren van omgevingsinstellingen. Elke sectie geeft de syntaxis, opties en veelvoorkomende toepassingen weer op.

Installatie

Gebruik npm i @microsoft/rayfin-cli om de CLI te installeren.

Aan de slag

Volg de stappen in je terminal om een Fabric-app te maken.

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

Voor bestaande of lege projecten kun npx rayfin init je in plaats van npm create Rayfin toevoegen aan een project dat al broncode of een lege map heeft. Het init-commando leidt je door het inschakelen van services, het kiezen van een databasedialect en het configureren van statische hosting zonder een nieuw sjabloon te ondersteunen.

Voor de volledige walkthrough, zie Create and deploy your first Fabric app met de CLI en Deploy a Fabric app to Fabric.

Scaffalt een project met npm create

npm create (alias van npm init) Bootstrap een nieuw project door een Create Initializer-pakket aan te roepen. Om een Fabric-app te ondersteunen, gebruik je deze met de @microsoft/rayfin initialiseerder:

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

Opdrachtenoverzicht

De commando's en vlaggen in dit artikel zijn geverifieerd op basis van de lokaal geïnstalleerde CLI-hulpuitvoer.

Opdrachten op het hoogste niveau

Gebruik deze tabel om snel het juiste commando te vinden.

Opdracht Gebruik het om
rayfin init [directory] Maak een Rayfin-project aan of configureer je.
rayfin up Deploy de app naar Fabric en beheer externe deployments.
rayfin env Genereer framework-specifieke omgevingsbestanden uit rayfin/.env.
rayfin login Log in op het Rayfin-platform.
rayfin logout Log uit en wis gecachte inloggegevens.

Maak of configureer een project

rayfin init [directory]

rayfin init Gebruik het om Rayfin toe te voegen aan een nieuw of bestaand project.

Argument Beschrijving
--project-name <name> Stel de projectnaam in.
-t, --template <uri> Specificeer de sjabloon-URI die gebruikt moet worden.
--template-name <name> Selecteer een sjabloon op naam.
-l, --list-templates Lijst van beschikbare sjablonen.
--dialect <dialect> Stel het databasedialect in.
--services <list> Kies welke diensten je wilt inschakelen.
--auth-methods <list> Kies authenticatiemethoden.
--static-hosting Schakel statische hosting-instellingen in.
--overwrite Overschrijf bestaande gegenereerde bestanden.
--workspace-id <id> Gebruik een specifiek Fabric workspace ID.
--workspace-uri <uri> Gebruik een specifieke Fabric workspace URI.
--base-api-url <url> Overschrijf de basis API URL.
--item-id <id> Richt je op een specifieke Fabric item ID.

Examples

Lijst van beschikbare sjablonen voordat je een steiger maakt:

npx rayfin init --list-templates

Initialiseer Rayfin in de huidige map door een benoemd sjabloon en een specifiek dialect te gebruiken:

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

Maak een nieuw project aan niet-interactief met services en authenticatie geconfigureerd:

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

Deploy to Fabric

rayfin up

Gebruik rayfin up om de applicatie als Rayfin-item te Fabric.

Argument Beschrijving
--tenant <id> Gebruik een specifieke tenant-ID.
--workspace-id <id> Deploy naar een specifieke Fabric workspace ID.
--workspace-uri <uri> Deploy naar een specifieke Fabric workspace URI.
--base-api-url <url> Overschrijf de basis API URL.
--force Force-deployment stappen wanneer nodig.
--dry-run Bekijk de implementatieacties zonder ze toe te passen.
--env-file <path> Laad omgevingswaarden uit een bestand.
--verbose Toon uitgebreide deployment-output.
--json Geef deployment-output terug in JSON-formaat.
-y, --yes Accepteer prompts automatisch.
--encryption-fallback-enabled Schakel encryptie-fallbackgedrag in.

Examples

Deploy naar de momenteel geselecteerde Fabric-werkruimte:

npx rayfin up

Bekijk implementatieacties zonder ze toe te passen:

npx rayfin up --dry-run --verbose

Deploy op een specifieke werkruimte niet-interactief:

npx rayfin up --workspace-id 00000000-0000-0000-0000-000000000000 --yes
Subcommand Beschrijving
rayfin up db apply Genereer en pas DAB-configuratie toe op het externe Rayfin-item workload-eindpunt.
rayfin up staticapp deploy Bouw, verpak en deploy statische content naar het externe Rayfin-item.
rayfin up status Toon de huidige inzetstatus.
rayfin up list Vermeld alle Fabric-implementaties die voor het project zijn geregistreerd.
rayfin up switch [workspace] Schakel de actieve Fabric deployment en herschrijf rayfin/.env.

rayfin up db apply

Genereert en past DAB-configuratie toe op het externe Rayfin-item workload-eindpunt.

Argument Beschrijving
--verbose Toon uitgebreide uitvoer.
--force Force regeneratie en passen configuratie toe.
--json Geef output terug in JSON-formaat.

Examples

Pas databaseconfiguratiewijzigingen toe op het externe Rayfin-item:

npx rayfin up db apply

Krachtregeneratie en het vastleggen van machineleesbare output:

npx rayfin up db apply --force --json

rayfin up staticapp deploy

Bouwt, verpakt en deployt statische content naar het externe Rayfin-item.

Argument Beschrijving
--verbose Toon uitgebreide uitvoer.
--skip-build Deploy zonder de bouwstap te draaien.
--json Geef output terug in JSON-formaat.

Examples

Bouw en deploy statische content:

npx rayfin up staticapp deploy

Deploy een vooraf gebouwde dist map zonder de build opnieuw uit te voeren:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Toont de status van de cloud-implementatie.

Argument Beschrijving
--json Retourstatus in JSON-formaat.
--verbose Toon uitgebreide uitvoer.

Examples

Controleer de huidige status van de deployment:

npx rayfin up status

Returnstatus als JSON voor gebruik in scripts:

npx rayfin up status --json

rayfin up list

Geeft een overzicht van alle geregistreerde Fabric-implementaties voor dit project.

Argument Beschrijving
--json Stuur de deploymentlijst terug in JSON-formaat.

Examples

Vermeld alle geregistreerde Fabric-implementaties voor het project:

npx rayfin up list

rayfin up switch [workspace]

Schakelt de actieve Fabric deployment en herschrijft rayfin/.env dienovereenkomstig.

Argument Beschrijving
-l, --list Vermeld beschikbare implementaties zonder te wisselen.
--no-emit-env Sla het schrijven van verzonden omgevingsbestanden over.

Examples

Lijst van beschikbare implementaties om naar over te stappen:

npx rayfin up switch --list

Schakel de actieve deployment over naar een specifieke werkruimte:

npx rayfin up switch my-workspace

Genereer omgevingsbestanden

rayfin env

Gebruik rayfin env om framework-specifieke .env.local waarden uit rayfin/.envte voeren.

Argument Beschrijving
--framework <vite|nextjs|plain> Kies het doelframe-formaat.
--output <dir> Schrijf gegenereerde bestanden naar een specifieke map.
--show Print uitgezonden waarden zonder bestanden te schrijven.

Examples

Genereer een Vite-compatibele .env.local:

npx rayfin env --framework vite

Voorbeelden van geëmitteerde omgevingswaarden zonder bestanden te schrijven:

npx rayfin env --framework nextjs --show

Aanmelden en afmelden

rayfin login

rayfin login Gebruik om in te loggen op het Rayfin-platform.

Argument Beschrijving
--tenant <id> Gebruik een specifieke tenant-ID.
--service-principal Probeer in te loggen als dienstdirecteur. Deze optie staat in de hulp, maar wordt momenteel niet ondersteund.
-u, --client-id <id> Geef de client-ID op voor het aanmelden van de dienstprincipal. Deze optie staat in de hulp, maar wordt momenteel niet ondersteund.
-p, --client-secret <secret> Geef het cliëntgeheim voor het aanmelden van de dienstprincipal. Deze optie staat in de hulp, maar wordt momenteel niet ondersteund.
--select Kies uit beschikbare ingelogde accounts of contexten.
--encryption-fallback-enabled Schakel encryptie-fallbackgedrag in.

Examples

Log interactief in:

npx rayfin login

Log in bij een specifieke huurder:

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

Wissel tussen ingelogde accounts:

npx rayfin login --select
Subcommand Beschrijving
rayfin login status Toon de huidige authenticatiestatus.

rayfin login status

Toont de huidige authenticatiestatus.

Argument Beschrijving
Geen Dit subcommando vermeldt geen opties in de CLI-hulpoutput.

Example

Controleer of je bent ingelogd:

npx rayfin login status

rayfin logout

Logt uit en wist gecachte inloggegevens.

Argument Beschrijving
Geen Dit commando vermeldt geen opties in de CLI-hulpoutput.

Example

Log uit en wis gecachede inloggegevens:

npx rayfin logout
  • Last updated on