Rayfin CLI referencia

Keresd meg a Rayfin CLI parancsokat projektek létrehozásához, sémaváltozások kezeléséhez, Fabric-be történő telepítéshez és környezetbeállítások konfigurálásához. Minden szakasz felsorolja a parancsszintaxist, opciókat és gyakori felhasználásokat.

Installation

Használd npm i @microsoft/rayfin-cli a Klia telepítéséhez.

Kezdő lépések

Kövesd a terminál lépéseit, hogy létrehozz egy Fabric alkalmazást.

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

Jótanács

Meglévő vagy üres projektek esetén használd npx rayfin initnpm create helyette a Rayfint egy olyan projekthez, amelynek már van forráskódja vagy üres könyvtára. Az init parancs végigvezet a szolgáltatások engedélyezésén, az adatbázis-dialektusok kiválasztásán, és a statikus hosztingrendszer konfigurálásán anélkül, hogy új sablont kellene építenéd.

A teljes végigjátszásért lásd a Create and deployd a first Fabric appod a CLI és a Deploy a Fabric app a Fabric-re.

Építs fel egy projektet npm create

npm create (álnév ) npm init egy új projektet indít egy Create inicializátor csomag meghívásával. Egy Fabric alkalmazás felépítéséhez használd az @microsoft/rayfin inicializátorral:

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

Parancshivatkozás

A cikkben szereplő parancsokat és zászlókat a helyi telepített CLI help output alapján ellenőrizték.

Felső szintű parancsok

Használd ezt a táblázatot, hogy gyorsan megtaláld a megfelelő parancsot.

Parancs	Használd arra, hogy
npx rayfin init [directory]	Hozz létre vagy konfiguráljon egy Rayfin projektet.
npx rayfin connector	Keress, konfigurálja, ellenőrizze és hívja meg a Fabric adatcsatlakozókat.
npx rayfin functions init	Scaffold egy Functions csomag.
npx rayfin dev	Indítsd el az alkalmazást és a Functions-t helyben.
npx rayfin init ai-files	Telepítsd vagy ellenőrizd a Rayfin ügynök kontextusfájlokat.
npx rayfin up	Telepítsd az alkalmazást a Fabric-be, és kezeld a távoli telepítéseket.
npx rayfin env	Keret-specifikus környezeti fájlokat generálni .rayfin/.env
npx rayfin login	Jelentkezz be a Rayfin platformra.
npx rayfin logout	Lépj ki és töröld a gyorsítótárban tárolt hitelesedéseket.

Létrehozz vagy konfiguráljon egy projektet

rayfin init [directory]

Használd rayfin init arra, hogy hozzáadd a Rayfint egy új vagy meglévő projekthez.

Argument	Leírás
--project-name <name>	Állítsd be a projekt nevét.
-t, --template <uri>	Határozd meg a használt sablon URI-t.
--template-name <name>	Válassz egy sablont a név szerint.
-l, --list-templates	Listázd fel a rendelkezésre álló sablonokat.
--dialect <dialect>	Állítsd be az adatbázis dialektust.
--services <list>	Válaszd ki, melyik szolgáltatásokat engedélyezd.
--auth-methods <list>	Válassz hitelesítési módszereket.
--static-hosting	Engedélyezd a statikus hóterhely beállítását.
--overwrite	Írd felül a meglévő generált fájlokat.
--workspace-id <id>	Használj egy speciális Fabric munkaterületi azonosítót.
--workspace-uri <uri>	Használj egy specifikus Fabric munkaterület URI-t.
--base-api-url <url>	Felülírd az alap API URL-t.
--item-id <id>	Célozz meg egy adott Fabric item ID-t.

Examples

Listázd fel a rendelkezésre álló sablonokat a vázlatok építése előtt:

npx rayfin init --list-templates

Inicializáljuk a Rayfin jelenlegi könyvtárát egy elnevezett sablon és egy adott dialektussal együtt:

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

Hozzon létre egy új projektet, amely nem interaktív, szolgáltatások és hitelesítés konfigurálva:

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

Csatlakozóparancsok

A connector parancscsoport kezeli a külső Fabric adatforrásokat.

rayfin connector types

Felsorolja a csatlakozótípusokat, amelyeket hozzáadhatsz egy projekthez.

Option	Leírás
--json	A csatlakozó típuslistát JSON-ként bocsátsd ki.
-v, --verbose	Tartalmazzon képességek részleteit.

rayfin connector search [query]

Keresi azokat a Fabric forrásokat, amelyeket a bejelentkezett identitás hozzáadhat csatlakozóként.

Érv vagy opció	Leírás
[query]	Opcionális, kihívó-érzékeny forrásnév-szűrő.
--query <text>	Névnevű forrásnév-szűrő, amely elsőbbséget élvez a [query].
--type <type>	Vesszővel elválasztott csatlakozótípusok; szükség esetén --workspace-id vagy --all-workspaces.
--workspace-id <id>	Keress egy Fabric munkaterületet.
--all-workspaces	Keress minden olyan munkaterületet, amelyhez az identitás hozzáférhet.
-y, --yes	Automatikusan fogadd el az interaktív hozzáadásátadást.
--limit <n>	A megjelenített eredmények maximális száma.
--output <interactive\|plain\|json>	Válaszd ki a kimeneti formátumot.
--json	Nyomtatd ki az eredményeket JSON-ként, és hagyd ki az interaktív választót.
-v, --verbose	Részletes kimenet engedélyezése.

Ha egyik munkaterület opció sem elérhető, a parancs a jelenlegi projekttelepítéshez rögzített munkaterületeket keresi.

rayfin connector add --type <type>

Hozzáad egy csatlakozó deklarációt és támogatja a projektfájlokat.

Option	Leírás
--type <type>	Kötelező. Csatlakozó típus; a típusok listázásához használják rayfin connector types .
--name <name>	Csatlakozó neve; az elemből származik, ha kihagyják.
--workspace-id <id>	Fabric workspace azonosító.
--item-id <id>	Fabric tárgyazonosító.
--operations <ops>	Vesszővel elválasztott az engedélyezett műveletek részhalmaza.
-v, --verbose	Részletes kimenet engedélyezése.
-y, --yes	Automatikusan fogadja el a megerősítéseket.
--json	Sugározz JSON kimenetet.

rayfin connector list

Felsorolja a bevallásban rayfin.ymlbejelentett csatlakozókat.

Option	Leírás
-v, --verbose	Tartalmazzon a csatlakozó metaadatait és képességeit.
--json	Sugározz JSON kimenetet.

rayfin connector inspect

Átvizsgál egy konfigurált csatlakozót vagy egy közvetlenül címzett Fabric forrást változtatás nélkül.

Option	Leírás
--name <name>	Konfigurált csatlakozó név.
-w, --workspace <name>	Munkaterület neve közvetlen vizsgálathoz.
--workspace-id <id>	Munkaterület azonosító közvetlen ellenőrzéshez.
--item <name>	Tárgy neve közvetlen vizsgálathoz.
--item-id <id>	Tárgyazonosító közvetlen vizsgálathoz.
--type <type>	Csatlakozó típus közvetlen vizsgálatra.
--url <url>	Szemantikai modellportál URL-je; levezeti a munkaterületet és az elemazonosítókat.
--entity <name>	Entitás vagy tábla a mintavételhez; kihagyjuk a listázáshoz --query tartozó entitásokat.
--query <path>	.sql vagy .dax fájlt futtathatsz csak olvasható módban.
--rows <n>	Sorkorlát; alapértelmezés szerint 10-re van a mintáknál, és 100-ra van korlátozva.
-v, --verbose	Részletes kimenet engedélyezése.
--output <interactive\|plain\|json>	Válaszd ki a kimeneti formátumot.
--json	Sugározz JSON kimenetet.

Használat --name konfigurált csatlakozóhoz, teljes közvetlen forráskódú választóhoz vagy --url szemantikai modellhez.

rayfin connector invoke [connector-name] [operation]

Műveletet indít egy konfigurált csatlakozón.

Érv vagy opció	Leírás
[connector-name]	Konfigurált csatlakozó név.
[operation]	Csatlakozó működés, például executeQuery.
--name <name>	Alternatíva .[connector-name]
--operation <operation>	Alternatíva .[operation]
--input <json>	JSON műveleti bemenet.
--file <path>	JSON fájl, amely műveleti bemenetet tartalmaz.
--transport <auto\|deployed>	Invocation path; alapértelmezettként .auto
-v, --verbose	Részletes kimenet engedélyezése.
--output <interactive\|plain\|json>	Válaszd ki a kimeneti formátumot.
--output-file <path>	Írd meg a teljes eredményt egy fájlba.
--max-inline-bytes <bytes>	Eredményméret-küszöb fájlíráshoz; alapértelmezés szerint 1 MiB.
--json	Sugározz JSON kimenetet.

rayfin connector remove <name>

Eltávolítja a csatlakozó deklarációt és az általa generált csatlakozó fájlokat.

Érv vagy opció	Leírás
<name>	Kötelező. A csatlakozó nevét kell eltávolítani.
-v, --verbose	Részletes kimenet engedélyezése.
-y, --yes	Automatikusan fogadd el a eltávolítási megerősítést.
--json	Sugározz JSON kimenetet.

Funkcióparancsok

rayfin functions init [directory]

Állványokat épít és konfigurál egy Funkciós csomag.

Érv vagy opció	Leírás
[directory]	Project root; alapértelmezett a jelenlegi könyvtárra épül.
--force	Írj felül egy meglévő Functions állványt.
--path <relative-path>	A függvények csomaghelye a projekt gyökereihez viszonyítva.

A csomag helye alapértelmezetten egy észlelt munkaterület vagy rayfin/functions.

Fejlesztési parancsnokságok

rayfin dev [project-path]

Helyi fejlesztési szekciót indít egy Rayfin háttérrendszerrel.

Érv vagy opció	Leírás
[project-path]	Project root; alapértelmezett a jelenlegi könyvtárra épül.
--skip-db-apply	Hagyd ki az automatikus adatbázis-beállítást.
--env-file <path>	.env fájlt interpoláláshoz rayfin.yml használtak.
--provider <fabric>	Backend szolgáltató; alapértelmezettként .fabric
-w, --workspace <name>	Fabric munkaterület neve egy első futásos backendhez.
--workspace-id <id>	Fabric workspace ID egy első futású backendhez.
--capacity-id <id>	Fabric kapacitásazonosító egy használható kapacitás nélküli munkaterülethez.
-t, --tenant <id>	Microsoft Entra-bérlőazonosító.
--encryption-fallback-enabled	Engedélyezze a tiszta szöveges token tárolást, ha nincs elérhető operációs rendszer kulcstartó.
--no-emit-env	Ne regeneráld a keretrendszer .env.local fájlt.
-v, --verbose	Engedélyezd a részletes naplózást.

rayfin dev functions apply

Indítja el a helyi Functions hosztot az aktív telepítés ellen.

Option	Leírás
--port <port>	Local Functions host port; alapértelmezettként .7071
--inspect-port <port>	Node.js Inspector port; alapértelmezettként .9229
--no-debug	Kapcsold ki a Node.js felügyelőt.
--no-emit-env	Ne regeneráld a keretrendszer .env.local fájlt.
--verbose	Mutatd meg a diagnosztikai kimenetet.
--json	Sugározz JSON kimenetet.
-y, --yes	Futasz interaktív promptok nélkül.

Ügynök fájlok kezelése

A rayfin init ai-files parancs a Rayfin ügynök kontextusfájlokat kezeli a projektedben: AGENTS.md, .mcp.json, és .agents/skills/rayfin/SKILL.md. A CLI automatikusan telepíti ezeket a fájlokat, amikor egy projektet építesz. Futtatd az alábbi parancsokat, hogy telepítsd vagy frissítsd őket egy meglévő projektben, vagy ellenőrizd az állapotukat.

rayfin init ai-files install

Telepíti vagy frissíti a Rayfin ügynök fájlokat. A parancs idempotens és megőrzi a meglévő felhasználói konfigurációt.

Option	Leírás
--enable <id>	Telepítsd vagy tarts egy adott tárgyat a névtéri azonosítójával, például skill:rayfin. Ismételhető.
--disable <id>	Hagyd abba egy adott elem kezelését anélkül, hogy törölnéd a fájlját. Ismételhető.
--remove-files	Töröld a lemezen lévő fájlt, amikor letiltod egy tárgyat. Szükséges --disable.
--force [ids...]	Felülírni a módosított tárgyakat, helyreállítani a hiányzó tárgyakat, vagy újraépíteni a hibás tárgyakat .mcp.json. Opcionális névtérbeli azonosítókat fogad el a művelet hatótávolságához. Sosem írja AGENTS.mdfelül.
-n, --dry-run	Jelentse a változásokat anélkül, hogy fájlokat írna.
--json	Strukturált kimenetet bocsát ki JSON-ként; ami nem interaktív módot jelent.
-y, --yes, --non-interactive	Hagyd ki az interaktív promptot, és fogadd el az alapértelmezéseket.

Például telepítsd az alapbeállításokat anélkül, hogy kérnéd:

npx rayfin init ai-files install --yes

rayfin init ai-files status

Kinyomtatja minden menedzselt ügynök fájl állapotát. Strukturált kimenethez való használat --json .

Lehetséges állapotok közé up-to-datetartozik , update-available, user-modified, missing, not-installeddisabledorphaned, és unreadable. Fuss rayfin init ai-files install fájlok frissítéséhez vagy rayfin init ai-files install --force <id> egy adott kezelt elem felülírásához.

Üzembe helyezés a Fabric

rayfin up

Használd az rayfin up alkalmazást Fabric-re Rayfin elemként.

Argument	Leírás
-t, --tenant <id>	Használj egy adott bérlőazonosítót.
-w, --workspace <name>	Deploy be egy Fabric workspace-re név szerint; alapértelmezés .My Workspace
--workspace-id <id>	Telepítsd egy adott Fabric workspace ID-re.
--workspace-uri <uri>	Telepítsd egy adott Fabric workspace URI-re.
--item-name <name>	Fabric item megjelenítési neve; alapértelmezett projektazonosító.
--capacity-id <id>	Fabric kapacitásazonosító, amikor a célterületnek kapacitásra van szüksége.
--force	Engedélyezzük a romboló adatséma-változtatásokat.
-n, --dry-run	Validáld a bemeneteket, és oldd meg a munkaterületet telepítés nélkül.
--env-file <path>	.envfájl telepítési tulajdonságokhoz; alapértelmezettként .rayfin/.env
-v, --verbose	Részletes kimenet engedélyezése.
--json	Return deployment output JSON formátumban.
-y, --yes	Automatikusan fogadja el a megerősítéseket.
--encryption-fallback-enabled	Engedélyezze a tiszta szöveges token tárolást, ha nincs elérhető operációs rendszer kulcstartó.
--exclude-services <names>	Vesszővel elválasztott szolgáltatásokat kihagyni építés és telepítés során: staticHosting vagy functions.
--provider <fabric>	Telepítési szolgáltató; alapértelmezettként .fabric

Examples

Telepítse a jelenleg kiválasztott Fabric munkaterületre:

npx rayfin up

Előzetes megtekintés telepítési műveletek alkalmazása nélkül:

npx rayfin up --dry-run --verbose

Telepítsd egy adott munkaterületre nem interaktívan:

npx rayfin up --workspace-id <workspace-id> --yes

Telepítés anélkül, hogy felépítenénk vagy telepítenénk Funkciókat:

npx rayfin up --exclude-services functions

--capacity-idNem kombinálható , --workspace--workspace-id, vagy --workspace-uri.

Subcommand	Leírás
npx rayfin up db apply	Generálj és alkalmazzunk DAB konfigurációt a távoli Rayfin item munkaterhelés végpontján.
npx rayfin up functions deploy	Építsd, csomagolj és telepítsd a Függvényeket az aktív távoli elemre.
npx rayfin up staticapp deploy	Építs, csomagolj és telepíts statikus tartalmat a távoli Rayfin elemre.
npx rayfin up connector apply	Alkalmazz adatbázis-konfigurációt a deklarált GraphQL csatlakozókhoz.
npx rayfin up status	Mutassa meg a jelenlegi telepítési állapotot.
npx rayfin up list	Sorold fel az összes Fabric telepítést, amelyet a projekthez rögzítettek.
npx rayfin up switch [workspace]	Kapcsold át az aktív Fabric telepítést, és írd át rayfin/.env.

rayfin up db apply

Generálja és alkalmazza a DAB konfigurációt a távoli Rayfin item munkaterhelés végpontján.

Argument	Leírás
--verbose	Részletes kimenet megjelenítése.
--force	Kényszerítsd regenerációt és alkalmazz konfigurációt.
--json	Return output JSON formátumban.

Examples

Alkalmazzuk az adatbázis-konfigurációs változtatásokat a távoli Rayfin elemre:

npx rayfin up db apply

Erőregenerálás és géppel olvasható kimenet rögzítése:

npx rayfin up db apply --force --json

rayfin up functions deploy

Funkciókat épít, csomagol, és telepít az aktív távoli elemre.

Option	Leírás
--verbose	Részletes kimenet megjelenítése.
--skip-build	Telepítsd a meglévő funkciók kimenetét építkezés nélkül.
--json	Sugározz JSON kimenetet.

rayfin up connector apply

Adatbázis-konfigurációt alkalmaz deklarált GraphQL csatlakozókhoz.

Option	Leírás
--name <name>	Csak a megnevezett csatlakozót alkalmazzák.
--verbose	Részletes kimenet engedélyezése.
--json	Sugározz JSON kimenetet.

rayfin up staticapp deploy

Statikus tartalmat épít, csomagol és telepít a távoli Rayfin elemre.

Argument	Leírás
--verbose	Részletes kimenet megjelenítése.
--skip-build	Telepítsd be a build lépés futtatása nélkül.
--json	Return output JSON formátumban.

Examples

Statikus tartalom építése és telepítése:

npx rayfin up staticapp deploy

Telepítsünk előre dist összerakott mappát anélkül, hogy újra futtatják a buildet:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Megjeleníti a felhőtelepítés állapotát.

Argument	Leírás
--json	Visszaküldés státusza JSON formátumban.
--verbose	Részletes kimenet megjelenítése.

Examples

Ellenőrizd a jelenlegi telepítési állapotot:

npx rayfin up status

Return státusz JSON-ként szkriptekben való használatra:

npx rayfin up status --json

rayfin up list

Felsorolja az összes Fabric telepítést, amelyet ehhez a projekthez rögzítettek.

Argument	Leírás
--json	Küldd vissza a telepítési listát JSON formátumban.

Examples

Sorold fel az összes rögzített Fabric telepítést a projekthez:

npx rayfin up list

rayfin up switch [workspace]

Vált az aktív Fabric telepítést, és ennek megfelelően átírja rayfin/.env-et.

Argument	Leírás
-l, --list	Listázd fel a rendelkezésre álló telepítéseket cserék nélkül.
--no-emit-env	Hagyd ki az emittelt környezeti fájlok írását.

Examples

Felsorolja a lehetséges telepítéseket, amelyekre át lehet váltani:

npx rayfin up switch --list

Kapcsold át az aktív telepítést egy adott munkaterületre:

npx rayfin up switch my-workspace

Környezeti fájlok generálása

rayfin env

Használd rayfin env keret-specifikus .env.local értékek kibocsátására -ból rayfin/.env.

Argument	Leírás
--framework <vite|nextjs|plain>	Válaszd ki a célkeretformátumot.
--output <dir>	Írj generált fájlokat egy adott könyvtárba.
--show	Nyomtatd ki a kibocsátott értékeket fájlírás nélkül.

Examples

Vite-kompatibilis .env.localgenerálás:

npx rayfin env --framework vite

Előnézett kibocsátott környezeti értékek fájlok írása nélkül:

npx rayfin env --framework nextjs --show

Be- és kijelentkezés

rayfin login

Használd rayfin login bejelentkezésre a Rayfin platformra.

Argument	Leírás
--tenant <id>	Használj egy adott bérlőazonosítót.
--service-principal	Próbáld meg a szolgáltatási főbelépést. Ez a lehetőség a sajtóban szerepel, de jelenleg nem támogatott.
-u, --client-id <id>	Megadja az ügyfélazonosítót a szolgáltatásfő bejelentkezéshez. Ez a lehetőség a sajtóban szerepel, de jelenleg nem támogatott.
-p, --client-secret <secret>	Biztosítsd az ügyfél titkát a szolgáltatás fő bejelentkezéséhez. Ez a lehetőség a sajtóban szerepel, de jelenleg nem támogatott.
--select	Válassz a rendelkezésre álló bejelentkezett fiókok vagy kontextusok közül.
--encryption-fallback-enabled	Engedélyezze a titkosítás tartalék viselkedését.

Examples

Interaktívan jelentkezz be:

npx rayfin login

Jelentkezz be egy adott bérlőnél:

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

Váltás a bejelentkezett fiókok között:

npx rayfin login --select

Subcommand	Leírás
npx rayfin login status	Jelenítse meg a jelenlegi hitelesítési állapotot.

rayfin login status

Megjeleníti az aktuális hitelesítési állapotot.

Argument	Leírás
Nincs	Ez az alparancs nem tartalmaz semmilyen opciót a CLI súgó kimenetben.

Example

Ellenőrizd, hogy be voltál-e jelentkezve:

npx rayfin login status

rayfin logout

Kilép és töröli a gyorsítótárban tárolt adatokat.

Argument	Leírás
Nincs	Ez a parancs nem tartalmaz semmilyen opciót a Command help outputban.

Example

Kijelentkezz és töröld a gyorsítótári adatokat:

npx rayfin logout