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
npm run 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 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

Nasadenie na Fabric

rayfin up

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

Argument	Description
--tenant <id>	Použite konkrétne ID nájomcu.
--workspace-id <id>	Nasadiť na konkrétny Fabric workspace ID.
--workspace-uri <uri>	Nasadiť do konkrétneho URI pracovného priestoru Fabric.
--base-api-url <url>	Prepíšte základnú URL API.
--force	Kroky nasadenia núte, keď je to potrebné.
--dry-run	Zobraziť si akcie nasadenia bez ich aplikácie.
--env-file <path>	Načítajte hodnoty prostredia zo súboru.
--verbose	Ukážte rozvláčne výstupy nasadenia.
--json	Vráťte výstup nasadenia v JSON formáte.
-y, --yes	Prijímajte výzvy automaticky.
--encryption-fallback-enabled	Povolte záložné správanie šifrovania.

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 00000000-0000-0000-0000-000000000000 --yes

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 staticapp deploy	Postavte, zabalte a nasadzujte statický obsah na vzdialený Rayfin predmet.
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 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