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
npx rayfin 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 connector	Hitta, konfigurera, inspektera och anropa Fabric-datakopplingar.
npx rayfin functions init	Scaffold ett funktionspaket.
npx rayfin dev	Kör appen och funktionerna lokalt.
npx rayfin init ai-files	Installera eller kontrollera kontextfiler för Rayfin-agenten.
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

Anslutningskommandon

Kommandogruppen connector hanterar externa Fabric-datakällor.

rayfin connector types

Listar kontakttyper som du kan lägga till i ett projekt.

Option	Description
--json	Emittera kontakttyplistan som JSON.
-v, --verbose	Inkludera detaljer om kapacitet.

rayfin connector search [query]

Söker i Fabric-källor som den inloggade identiteten kan lägga till som kopplingar.

Argument eller alternativ	Description
[query]	Valfritt, kasus-insensitivt källnamnsfilter.
--query <text>	Namngivet käll-namn-filter som har företräde framför [query].
--type <type>	Kommaseparerade kontakttyper; krävdes med --workspace-id eller --all-workspaces.
--workspace-id <id>	Sök på en Fabric workspace.
--all-workspaces	Sök igenom varje arbetsyta som identiteten kan komma åt.
-y, --yes	Acceptera automatiskt den interaktiva add-överlämningen.
--limit <n>	Maximalt antal visade resultat.
--output <interactive\|plain\|json>	Välj utdataformatet.
--json	Skriv ut resultaten som JSON och hoppa över den interaktiva plockaren.
-v, --verbose	Aktivera utförliga utdata.

När inget av arbetsytalternativen tillhandahålls söker kommandot i de arbetsytor som registrerats för den aktuella projektdistributionen.

rayfin connector add --type <type>

Lägger till en anslutningsdeklaration och bygger upp sina projektfiler.

Option	Description
--type <type>	Required. Kontakttyp; använd rayfin connector types för att lista typer.
--name <name>	Kontaktnamn; härlett från föremålet när det utelämnades.
--workspace-id <id>	Fabric workspace ID.
--item-id <id>	Fabric item ID.
--operations <ops>	Komma-separerad delmängd av tillåtna operationer.
-v, --verbose	Aktivera utförliga utdata.
-y, --yes	Acceptera automatiskt bekräftelser.
--json	Sänd JSON-utgång.

rayfin connector list

Listar de kontakter som deklarerats i rayfin.yml.

Option	Description
-v, --verbose	Inkludera kontaktmetadata och funktioner.
--json	Sänd JSON-utgång.

rayfin connector inspect

Inspekterar en konfigurerad kontakt eller en direkt adresserad Fabric-källa utan att göra ändringar.

Option	Description
--name <name>	Konfigurerat kontaktnamn.
-w, --workspace <name>	Arbetsytans namn för direktinspektion.
--workspace-id <id>	Arbetsutrymmes-ID för direkt inspektion.
--item <name>	Föremålsnamn för direktinspektion.
--item-id <id>	Artikel-ID för direktinspektion.
--type <type>	Kontakttyp för direkt inspektion.
--url <url>	Semantisk modellportal-URL; härleder arbetsyt- och objekt-ID:n.
--entity <name>	Entitet eller tabell för att prova; utelämna med --query för att lista entiteter.
--query <path>	.sql eller .dax filen att köra i skrivskyddat läge.
--rows <n>	Radgräns; är standard 10 för prover och är begränsad till 100.
-v, --verbose	Aktivera utförliga utdata.
--output <interactive\|plain\|json>	Välj utdataformatet.
--json	Sänd JSON-utgång.

Användning --name för en konfigurerad kontakt, en komplett direktkällsväljare eller --url för en semantisk modell.

rayfin connector invoke [connector-name] [operation]

Anropar en operation på en konfigurerad koppling.

Argument eller alternativ	Description
[connector-name]	Konfigurerat kontaktnamn.
[operation]	Kontaktoperation, såsom executeQuery.
--name <name>	Namngiven alternativ till [connector-name].
--operation <operation>	Namngiven alternativ till [operation].
--input <json>	JSON-operationsinmatning.
--file <path>	JSON-fil som innehåller operationsinmatning.
--transport <auto\|deployed>	Anropsväg; går som standard till auto.
-v, --verbose	Aktivera utförliga utdata.
--output <interactive\|plain\|json>	Välj utdataformatet.
--output-file <path>	Skriv det fullständiga resultatet till en fil.
--max-inline-bytes <bytes>	Resultatstorlekströskeln för att skriva en fil; är standard 1 MiB.
--json	Sänd JSON-utgång.

rayfin connector remove <name>

Tar bort en connector-deklaration och dess genererade connector-filer.

Argument eller alternativ	Description
<name>	Required. Kontaktnamnet ska tas bort.
-v, --verbose	Aktivera utförliga utdata.
-y, --yes	Acceptera automatiskt bekräftelsen på borttagningen.
--json	Sänd JSON-utgång.

Funktionskommandon

rayfin functions init [directory]

Bygger och konfigurerar ett Functions-paket.

Argument eller alternativ	Description
[directory]	Project root; går till den aktuella katalogen.
--force	Skriv över en befintlig funktionsställning.
--path <relative-path>	Funktioners paketplacering relativt projektets rot.

Paketets plats är som standard en upptäckt arbetsplatsplats eller rayfin/functions.

Utvecklingskommandon

rayfin dev [project-path]

Startar en lokal utvecklingssession mot en Rayfin-backend.

Argument eller alternativ	Description
[project-path]	Project root; går till den aktuella katalogen.
--skip-db-apply	Hoppa över automatisk databaskonfiguration.
--env-file <path>	.env filen används för rayfin.yml interpolation.
--provider <fabric>	Backend-leverantör; går till standard .fabric
-w, --workspace <name>	Fabric workspace-namn för en first-run backend.
--workspace-id <id>	Fabric workspace ID för en förstahands-backend.
--capacity-id <id>	Fabric capacity ID för en arbetsyta utan användbar kapacitet.
-t, --tenant <id>	Microsoft Entra-klientorganisations-ID.
--encryption-fallback-enabled	Tillåt lagring av klartexttoken när ingen OS-nyckelring finns tillgänglig.
--no-emit-env	Generera inte framework-filen .env.local igen.
-v, --verbose	Aktivera utförlig loggning.

rayfin dev functions apply

Startar den lokala Functions-värden mot den aktiva distributionen.

Option	Description
--port <port>	Local Functions värdport; går som standard till 7071.
--inspect-port <port>	Node.js inspektörport; går som standard till 9229.
--no-debug	Inaktivera Node.js inspektör.
--no-emit-env	Generera inte framework-filen .env.local igen.
--verbose	Visa diagnostiska resultat.
--json	Sänd JSON-utgång.
-y, --yes	Kör utan interaktiva promptar.

Hantera agentfiler

Kommandot rayfin init ai-files hanterar Rayfin-agentens kontextfiler i ditt projekt: AGENTS.md, .mcp.json, och .agents/skills/rayfin/SKILL.md. CLI installerar dessa filer automatiskt när du stannar ett projekt. Kör kommandona nedan för att installera eller uppdatera dem i ett befintligt projekt, eller kontrollera deras status.

rayfin init ai-files install

Installerar eller uppdaterar Rayfin-agentfilerna. Kommandot är idempotent och bevarar befintlig användarkonfiguration.

Option	Description
--enable <id>	Installera eller behåll ett specifikt objekt med dess namnspaced-ID, såsom skill:rayfin. Repeterbar.
--disable <id>	Sluta hantera ett specifikt objekt utan att radera dess fil. Repeterbar.
--remove-files	Ta bort filen på disken när du inaktiverar ett objekt. Kräver --disable.
--force [ids...]	Skriv över modifierade föremål, återställ saknade föremål eller bygg om felaktigt format..mcp.json Accepterar valfria namnspaced-ID:n för att begränsa operationen. Skriver AGENTS.mdaldrig över.
-n, --dry-run	Rapportera ändringarna utan att skriva filer.
--json	Sänd strukturerad utdata som JSON; innebär icke-interaktivt läge.
-y, --yes, --non-interactive	Hoppa över den interaktiva prompten och acceptera standardinställningar.

Till exempel, installera standardinställningar utan att fråga:

npx rayfin init ai-files install --yes

rayfin init ai-files status

Skriver ut statusen för varje hanterad agentfil. Använd --json för strukturerad output.

Möjliga tillstånd inkluderar , , , , , , , orphanedoch unreadable. disablednot-installedmissinguser-modifiedupdate-availableup-to-date Kör rayfin init ai-files install för att uppdatera filer eller rayfin init ai-files install --force <id> för att skriva över ett specifikt hanterat objekt.

Distribuera till Fabric

rayfin up

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

Argument	Description
-t, --tenant <id>	Använd ett specifikt hyresgäst-ID.
-w, --workspace <name>	Distribuera till en Fabric-arbetsyta efter namn; standarden är My Workspace.
--workspace-id <id>	Distribuera till ett specifikt Fabric-arbetsområdes-ID.
--workspace-uri <uri>	Distribuera till en specifik Fabric-workspace-URI.
--item-name <name>	Fabric-objekt visningsnamn; standarden är projekt-ID:t.
--capacity-id <id>	Fabric capacity ID när målarbetsplatsen behöver kapacitet.
--force	Tillåt destruktiva dataschemaändringar.
-n, --dry-run	Validera indata och lösa arbetsytan utan att distribuera.
--env-file <path>	.envfil för distributionsegenskaper; går till standard .rayfin/.env
-v, --verbose	Aktivera utförliga utdata.
--json	Returnera distributionsutdata i JSON-format.
-y, --yes	Acceptera automatiskt bekräftelser.
--encryption-fallback-enabled	Tillåt lagring av klartexttoken när ingen OS-nyckelring finns tillgänglig.
--exclude-services <names>	Kommaseparerade tjänster att hoppa över under byggande och utrullning: staticHosting eller functions.
--provider <fabric>	Distributionsleverantör; går som standard till fabric.

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 <workspace-id> --yes

Distribuera utan att bygga eller distribuera funktioner:

npx rayfin up --exclude-services functions

--capacity-id kan inte kombineras med --workspace, --workspace-id, eller --workspace-uri.

Subcommand	Description
npx rayfin up db apply	Generera och applicera DAB-konfiguration på den fjärrstyrda Rayfin-artikelns arbetsbelastningsendpoint.
npx rayfin up functions deploy	Bygg, paketera och distribuera funktioner till det aktiva fjärrföremålet.
npx rayfin up staticapp deploy	Bygg, paketera och distribuera statiskt innehåll till det fjärrstyrda Rayfin-objektet.
npx rayfin up connector apply	Tillämpa databaskonfiguration för deklarerade GraphQL-kopplingar.
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 functions deploy

Bygger, paketerar och distribuerar funktioner till det aktiva fjärrföremålet.

Option	Description
--verbose	Visa utförliga utdata.
--skip-build	Distribuera befintliga Functions-utgångar utan att bygga.
--json	Sänd JSON-utgång.

rayfin up connector apply

Applicerar databaskonfiguration för deklarerade GraphQL-kontakter.

Option	Description
--name <name>	Använd endast den namngivna kontakten.
--verbose	Aktivera utförliga utdata.
--json	Sänd JSON-utgång.

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