Referencia na Rayfin CLI

Nájdite príkazy Rayfin CLI na tvorbu projektov, správu zmien schémy, nasadzovanie do Fabric a konfiguráciu nastavení prostredia. Každá sekcia uvádza syntax príkazov, možnosti a bežné využitia.

Inštalácia

Použite npm i @microsoft/rayfin-cli na inštaláciu CLI.

Začíname

Postupujte podľa krokov vo vašom termináli na vytvorenie aplikácie Fabric.

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

Tip

Pre existujúce alebo prázdne projekty použite npx rayfin init namiesto npm create pridania Rayfin do projektu, ktorý už má zdrojový kód alebo prázdny adresár. Príkaz init vás prevedie cez proces povolenia služieb, výber databázového dialektu a konfiguráciu statického hostingu bez vytvárania novej šablóny.

Pre kompletný návod pozri Vytvoriť a nasadiť svoju prvú Fabric aplikáciu s CLI a Nasadiť Fabric aplikáciu na Fabric.

Lešenie projektu s npm create

npm create (alias ) npm init bootstrapuje nový projekt spustením balíka Create Initializer. Na vytvorenie Fabric aplikácie ju použite s inicializátorom @microsoft/rayfin:

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

Referencia velenia

Príkazy a príznaky v tomto článku boli overené z lokálne nainštalovaného CLI help výstupu.

Najvyššie príkazy

Použite túto tabuľku na rýchle nájdenie správneho príkazu.

Príkaz	Použi ho na
npx rayfin init [directory]	Vytvorte alebo nakonfigurujte projekt Rayfin.
npx rayfin connector	Nájdi, konfiguruj, kontroluj a vyvolávaj Fabric dátové konektory.
npx rayfin functions init	Podpora balíka Functions.
npx rayfin dev	Spustite aplikáciu a funkcie lokálne.
npx rayfin init ai-files	Nainštalujte alebo skontrolujte kontextové súbory Rayfin agentov.
npx rayfin up	Nasadiť aplikáciu na Fabric a spravovať vzdialené nasadenia.
npx rayfin env	Generujte súbory prostredia špecifické pre rámec z rayfin/.env.
npx rayfin login	Prihláste sa na platformu Rayfin.
npx rayfin logout	Odhláste sa a vymažte uložené prihlasovacie údaje.

Vytvoriť alebo nakonfigurovať projekt

rayfin init [directory]

Použiť na rayfin init pridanie Rayfin do nového alebo existujúceho projektu.

Argument	Description
--project-name <name>	Nastavte názov projektu.
-t, --template <uri>	Špecifikujte šablónu URI, ktorú chcete použiť.
--template-name <name>	Vyberte šablónu podľa mena.
-l, --list-templates	Uveďte dostupné šablóny.
--dialect <dialect>	Nastavte databázový dialekt.
--services <list>	Vyberte si, ktoré služby povoliť.
--auth-methods <list>	Vyberte si autentifikačné metódy.
--static-hosting	Povolte nastavenie statického hostingu.
--overwrite	Prepíšte existujúce vygenerované súbory.
--workspace-id <id>	Použite špecifické ID pracovného priestoru Fabric.
--workspace-uri <uri>	Použite špecifické Fabric pracovné URI.
--base-api-url <url>	Prepíšte základnú URL API.
--item-id <id>	Zamerajte sa na konkrétne ID položky Fabric.

Príklady

Zoznam dostupných šablón pred scaffoldingom:

npx rayfin init --list-templates

Inicializujte Rayfin v aktuálnom adresári pomocou pomenovanej šablóny a konkrétneho dialektu:

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

Vytvoriť nový projekt neinteraktívne so službami a autentifikáciou nastavenými:

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

Príkazy konektora

Príkazová connector skupina spravuje externé zdroje dát Fabric.

rayfin connector types

Uvádza typy konektorov, ktoré môžete pridať do projektu.

Možnosť	Description
--json	Vydajte zoznam typov konektorov ako JSON.
-v, --verbose	Zahrňte podrobnosti o schopnostiach.

rayfin connector search [query]

Vyhľadáva Fabric zdroje, ktoré môže prihlásená identita pridať ako konektory.

Argument alebo možnosť	Description
[query]	Voliteľný filter podľa názvu zdroja bez ohľadu na veľkosť písmen.
--query <text>	Pomenovaný filter zdrojového mena, ktorý má prednosť pred [query].
--type <type>	Typy konektorov oddelených čiarkami; požadované s --workspace-id alebo --all-workspaces.
--workspace-id <id>	Vyhľadajte jeden pracovný priestor Fabric.
--all-workspaces	Prehľadajte každý pracovný priestor, ku ktorému má identita prístup.
-y, --yes	Automaticky prijímajte interaktívne odovzdanie pridaní.
--limit <n>	Maximálny počet zobrazených výsledkov.
--output <interactive\|plain\|json>	Vyberte formát výstupu.
--json	Vytlačte výsledky ako JSON a preskočte interaktívny výber.
-v, --verbose	Povolte rozvláčny výstup.

Keď nie je poskytnutá žiadna z možností pracovného priestoru, príkaz prehľadá pracovné priestory zaznamenané pre aktuálne nasadenie projektu.

rayfin connector add --type <type>

Pridáva deklaráciu konektora a podporuje svoje projektové súbory.

Možnosť	Description
--type <type>	Povinný argument. Typ konektora; použitie rayfin connector types na uvedenie typov.
--name <name>	Názov konektora; odvodený od predmetu, keď je vynechaný.
--workspace-id <id>	Fabric workspace ID.
--item-id <id>	Fabric item ID.
--operations <ops>	Podmnožina povolených operácií oddelená čiarkami.
-v, --verbose	Povolte rozvláčny výstup.
-y, --yes	Automaticky prijímajte potvrdenia.
--json	Emitujte výstup JSON.

rayfin connector list

Uvádza konektory deklarované v rayfin.yml.

Možnosť	Description
-v, --verbose	Zahrňte metadáta a schopnosti konektora.
--json	Emitujte výstup JSON.

rayfin connector inspect

Kontroluje konfigurovaný konektor alebo priamo adresovaný Fabric zdroj bez úprav.

Možnosť	Description
--name <name>	Konfigurovaný názov konektora.
-w, --workspace <name>	Názov pracovného priestoru na priamu kontrolu.
--workspace-id <id>	Workspace ID na priamu kontrolu.
--item <name>	Názov položky na priamu kontrolu.
--item-id <id>	ID položky na priamu kontrolu.
--type <type>	Typ konektora na priamu kontrolu.
--url <url>	URL portálu sémantického modelu; odvodzuje pracovné priestory a ID položiek.
--entity <name>	Entita alebo tabuľka na vzorku; vynechať s --query na zoznam entít.
--query <path>	.sql alebo .dax súbor na spustenie v režime iba na čítanie.
--rows <n>	Limit riadkov; predvolene je nastavený na 10 pre vzorky a je obmedzený na 100.
-v, --verbose	Povolte rozvláčny výstup.
--output <interactive\|plain\|json>	Vyberte formát výstupu.
--json	Emitujte výstup JSON.

Použitie --name pre konfigurovaný konektor, kompletný priamy výber zdroja alebo --url pre sémantický model.

rayfin connector invoke [connector-name] [operation]

Vyvolá operáciu na nakonfigurovanom konektore.

Argument alebo možnosť	Description
[connector-name]	Konfigurovaný názov konektora.
[operation]	Prevádzka konektora, napríklad executeQuery.
--name <name>	Alternatíva k [connector-name].
--operation <operation>	Alternatíva k [operation].
--input <json>	Vstup operácie JSON.
--file <path>	JSON súbor obsahujúci vstup operácie.
--transport <auto\|deployed>	Invokačná cesta; predvolene je .auto
-v, --verbose	Povolte rozvláčny výstup.
--output <interactive\|plain\|json>	Vyberte formát výstupu.
--output-file <path>	Zapíšte kompletný výsledok do súboru.
--max-inline-bytes <bytes>	Prahová hodnota veľkosti výsledku pre zápis súboru; predvolene je 1 MiB.
--json	Emitujte výstup JSON.

rayfin connector remove <name>

Odstráni deklaráciu konektora a jej vygenerované súbory konektora.

Argument alebo možnosť	Description
<name>	Povinný argument. Názov konektora treba odstrániť.
-v, --verbose	Povolte rozvláčny výstup.
-y, --yes	Automaticky prijmite potvrdenie o odstránení.
--json	Emitujte výstup JSON.

Príkazy funkcií

rayfin functions init [directory]

Scaffold a konfiguruje balík Functions.

Argument alebo možnosť	Description
[directory]	Project root; predvolene zobrazuje aktuálny adresár.
--force	Prepíšte existujúcu štruktúru Funkcií.
--path <relative-path>	Umiestnenie balíka funkcií vzhľadom na koreňový bod projektu.

Umiestnenie balíka je predvolene detekované miesto pracovného priestoru alebo rayfin/functions.

Vývojové velenia

rayfin dev [project-path]

Začína lokálnu vývojovú reláciu proti backendu Rayfin.

Argument alebo možnosť	Description
[project-path]	Project root; predvolene zobrazuje aktuálny adresár.
--skip-db-apply	Preskočite automatickú konfiguráciu databázy.
--env-file <path>	.env súbor použitý na rayfin.yml interpoláciu.
--provider <fabric>	Backend poskytovateľ; predvolene na fabric.
-w, --workspace <name>	Fabric workspace názov pre backend pri prvom behu.
--workspace-id <id>	Fabric workspace ID pre backend pri prvom spustení.
--capacity-id <id>	Fabric capacity ID pre pracovný priestor bez použiteľnej kapacity.
-t, --tenant <id>	Microsoft Entra tenant ID.
--encryption-fallback-enabled	Povoľte ukladanie tokenov v čistom texte, keď nie je dostupný žiadny OS keychain.
--no-emit-env	Negenerujte framework súbor..env.local
-v, --verbose	Povoľte rozvláčne logovanie.

rayfin dev functions apply

Spustí lokálny Functions hostiteľ proti aktívnemu nasadeniu.

Možnosť	Description
--port <port>	port hostiteľa lokálnych funkcií; predvolene na 7071.
--inspect-port <port>	Node.js port inšpektora; predvolene používa .9229
--no-debug	Vypnite Node.js inšpektora.
--no-emit-env	Negenerujte framework súbor..env.local
--verbose	Zobraziť diagnostický výstup.
--json	Emitujte výstup JSON.
-y, --yes	Bežte bez interaktívnych podnetov.

Spravovať súbory agentov

Príkaz rayfin init ai-files spravuje kontextové súbory Rayfin agenta vo vašom projekte: AGENTS.md, .mcp.json, a .agents/skills/rayfin/SKILL.md. CLI tieto súbory automaticky nainštaluje, keď scaffoldujete projekt. Spustite nižšie uvedené príkazy na inštaláciu alebo obnovenie ich v existujúcom projekte, alebo skontrolujte ich stav.

rayfin init ai-files install

Nainštaluje alebo obnoví súbory agenta Rayfin. Príkaz je idempotentný a zachováva existujúcu používateľskú konfiguráciu.

Možnosť	Description
--enable <id>	Nainštalujte alebo ponechajte konkrétnu položku podľa jej namespaced ID, napríklad skill:rayfin. Opakovateľné.
--disable <id>	Prestaňte spravovať konkrétnu položku bez vymazania jej súboru. Opakovateľné.
--remove-files	Odstráňte súbor na disku pri deaktivácii položky. Vyžaduje sa .--disable
--force [ids...]	Prepísať upravené položky, obnoviť chýbajúce predmety alebo znovu vytvoriť deformované .mcp.json. Akceptuje voliteľné ID v mennom priestore na rozsah operácie. Nikdy neprepíše AGENTS.md.
-n, --dry-run	Nahláste zmeny bez písania súborov.
--json	Emitovať štruktúrovaný výstup ako JSON; implikuje neinteraktívny režim.
-y, --yes --non-interactive	Preskočte interaktívnu výzvu a prijmite predvolené nastavenia.

Napríklad, inštalácia sa predvolene nastaví bez výzvy:

npx rayfin init ai-files install --yes

rayfin init ai-files status

Vytlačí stav každého súboru spravovaného agenta. Použitie --json na štruktúrovaný výstup.

Možné stavy zahŕňajú , , , , , , disabled, orphaneda .unreadablenot-installedmissinguser-modifiedupdate-availableup-to-date Spustiť rayfin init ai-files install na obnovenie súborov alebo rayfin init ai-files install --force <id> prepísanie konkrétnej spravovanej položky.

Nasadenie na Fabric

rayfin up

Použite rayfin up na nasadenie aplikácie na Fabric ako položku Rayfin.

Argument	Description
-t, --tenant <id>	Použite konkrétne ID nájomcu.
-w, --workspace <name>	Nasadiť do pracovného priestoru Fabric podľa názvu; predvolene .My Workspace
--workspace-id <id>	Nasadiť na konkrétny Fabric workspace ID.
--workspace-uri <uri>	Nasadiť do konkrétneho URI pracovného priestoru Fabric.
--item-name <name>	Fabric item display name; predvolene sa zobrazuje na ID projektu.
--capacity-id <id>	Fabric capacity ID, keď cieľový pracovný priestor potrebuje kapacitu.
--force	Povoľte deštruktívne zmeny dátovej schémy.
-n, --dry-run	Overiť vstupy a vyriešiť pracovný priestor bez nasadenia.
--env-file <path>	.envsúbor pre vlastnosti nasadenia; predvolene .rayfin/.env
-v, --verbose	Povolte rozvláčny výstup.
--json	Vráťte výstup nasadenia v JSON formáte.
-y, --yes	Automaticky prijímajte potvrdenia.
--encryption-fallback-enabled	Povoľte ukladanie tokenov v čistom texte, keď nie je dostupný žiadny OS keychain.
--exclude-services <names>	Služby oddelené čiarkami na preskakovanie počas zostavovania a nasadenia: staticHosting alebo functions.
--provider <fabric>	Poskytovateľ nasadenia; predvolene na fabric.

Príklady

Nasadiť do aktuálne vybraného pracovného priestoru Fabric:

npx rayfin up

Ukážte si akcie nasadenia bez ich aplikácie:

npx rayfin up --dry-run --verbose

Nasadzujte do konkrétneho pracovného priestoru neinteraktívne:

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

Nasadzujte bez budovania alebo nasadenia Funkcie:

npx rayfin up --exclude-services functions

--capacity-id Nemožno kombinovať s --workspace, --workspace-id, alebo --workspace-uri.

Podvelenie	Description
npx rayfin up db apply	Generujte a aplikujte DAB konfiguráciu na vzdialený koncový bod záťaže položiek Rayfin.
npx rayfin up functions deploy	Postavte, zabalte a nasadzujte Funkcie na aktívny vzdialený predmet.
npx rayfin up staticapp deploy	Postavte, zabalte a nasadzujte statický obsah na vzdialený Rayfin predmet.
npx rayfin up connector apply	Aplikujte databázovú konfiguráciu pre deklarované GraphQL konektory.
npx rayfin up status	Zobraziť aktuálny stav nasadenia.
npx rayfin up list	Uveďte všetky nasadenia Fabric zaznamenané pre tento projekt.
npx rayfin up switch [workspace]	Prepnite aktívny Fabric nasadenia a prepíšte rayfin/.env.

rayfin up db apply

Generuje a aplikuje DAB konfiguráciu na vzdialený koncový bod záťaže položiek Rayfin.

Argument	Description
--verbose	Ukážte rozvláčny výstup.
--force	Vynúť regeneráciu a aplikovať konfiguráciu.
--json	Vráťte výstup vo formáte JSON.

Príklady

Aplikujte zmeny konfigurácie databázy na vzdialenú položku Rayfin:

npx rayfin up db apply

Vynútenie regenerácie a zachytenie strojovo čitateľného výstupu:

npx rayfin up db apply --force --json

rayfin up functions deploy

Vytvára, balí a nasadzuje Funkcie na aktívny vzdialený predmet.

Možnosť	Description
--verbose	Ukážte rozvláčny výstup.
--skip-build	Nasadiť existujúci výstup Functions bez zostavovania.
--json	Emitujte výstup JSON.

rayfin up connector apply

Aplikuje databázovú konfiguráciu pre deklarované GraphQL konektory.

Možnosť	Description
--name <name>	Aplikujte len pomenovaný konektor.
--verbose	Povolte rozvláčny výstup.
--json	Emitujte výstup JSON.

rayfin up staticapp deploy

Zostavuje, balí a nasadzuje statický obsah na vzdialený Rayfin predmet.

Argument	Description
--verbose	Ukážte rozvláčny výstup.
--skip-build	Nasadiť bez spustenia build kroku.
--json	Vráťte výstup vo formáte JSON.

Príklady

Vytvárajte a nasadzujte statický obsah:

npx rayfin up staticapp deploy

Nasadiť predpripravený dist priečinok bez opätovného spustenia buildu:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Zobrazuje stav nasadenia v cloude.

Argument	Description
--json	Stav návratu v JSON formáte.
--verbose	Ukážte rozvláčny výstup.

Príklady

Skontrolujte aktuálny stav nasadenia:

npx rayfin up status

Vrátiť stav ako JSON na použitie v skriptoch:

npx rayfin up status --json

rayfin up list

Uvádza všetky nasadenia Fabric zaznamenané pre tento projekt.

Argument	Description
--json	Vráťte zoznam nasadení vo formáte JSON.

Príklady

Uveďte všetky zaznamenané nasadenia Fabric pre tento projekt:

npx rayfin up list

rayfin up switch [workspace]

Prepína aktívne nasadenie Fabric a podľa toho prepíše rayfin/.env.

Argument	Description
-l, --list	Zoznam dostupných nasadení bez prepínania.
--no-emit-env	Preskočte písanie vygenerovaných súborov prostredia.

Príklady

Uveďte dostupné nasadenia na prechod na:

npx rayfin up switch --list

Prepnite aktívne nasadenie do konkrétneho pracovného priestoru:

npx rayfin up switch my-workspace

Generujte súbory prostredia

rayfin env

Použite rayfin env na generovanie hodnôt špecifických .env.local pre rámec z rayfin/.env.

Argument	Description
--framework <vite|nextjs|plain>	Vyberte si formát cieľového rámca.
--output <dir>	Zapíšte vygenerované súbory do konkrétneho adresára.
--show	Vytlačiť vydané hodnoty bez zapisovania súborov.

Príklady

Vygenerujte Vite-kompatibilný .env.local:

npx rayfin env --framework vite

Náhľad generovaných hodnôt prostredia bez zápisu súborov:

npx rayfin env --framework nextjs --show

Prihlásiť sa a odhlásiť sa

rayfin login

Použite rayfin login na prihlásenie na platformu Rayfin.

Argument	Description
--tenant <id>	Použite konkrétne ID nájomcu.
--service-principal	Skúste sa prihlásiť ako vedúci služby. Táto možnosť je uvedená v pomoci, ale momentálne nie je podporovaná.
-u, --client-id <id>	Uveďte ID klienta na prihlásenie hlavného operátora. Táto možnosť je uvedená v pomoci, ale momentálne nie je podporovaná.
-p, --client-secret <secret>	Uveďte klientské tajomstvo pri prihlásení hlavného operátora služby. Táto možnosť je uvedená v pomoci, ale momentálne nie je podporovaná.
--select	Vyberte si z dostupných prihlásených účtov alebo kontextov.
--encryption-fallback-enabled	Povolte záložné správanie šifrovania.

Príklady

Prihláste sa interaktívne:

npx rayfin login

Prihláste sa k konkrétnemu nájomcovi:

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

Prepínanie medzi prihlásenými účtami:

npx rayfin login --select

Podvelenie	Description
npx rayfin login status	Zobraziť aktuálny stav autentifikácie.

rayfin login status

Zobrazuje aktuálny stav autentifikácie.

Argument	Description
Žiadne	Tento podpríkaz neuvádza žiadne možnosti vo výstupe pomoci CLI.

Príklad

Skontrolujte, či ste prihlásení:

npx rayfin login status

rayfin logout

Odhlási sa a vymaže uložené prihlasovacie údaje.

Argument	Description
Žiadne	Tento príkaz neuvádza žiadne možnosti vo výstupe pomoci CLI.

Príklad

Odhláste sa a vymažte uložené prihlasovacie údaje:

npx rayfin logout