Reference na Rayfin CLI

Najděte příkazy Rayfin CLI pro vytváření projektů, správu změn schémat, nasazování do Fabric a konfiguraci nastavení prostředí. Každá sekce uvádí syntaxi příkazů, možnosti a běžné použití.

Instalace

Použijte npm i @microsoft/rayfin-cli k instalaci CLI.

Začínáme

Postupujte podle kroků ve svém terminálu a vytvořte aplikaci 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

Pro existující nebo prázdné projekty použijte npx rayfin init místo npm create přidání Rayfin k projektu, který už má zdrojový kód nebo prázdný adresář. Příkaz init vás provede aktivací služeb, výběrem databázového dialektu a konfigurací statického hostingu bez nutnosti vytvářet novou šablonu.

Pro kompletní návod viz Vytvořit a nasadit svou první Fabric aplikaci s CLI a Nasadit Fabric aplikaci na Fabric.

Lešení projektu s npm create

npm create (alias ) npm init bootstrapuje nový projekt vyvoláním balíčku Create Initializer. Pro podpoření Fabric aplikace ji použijte s inicializátorem @microsoft/rayfin:

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

Referenční informace k příkazům

Příkazy a příznaky v tomto článku byly ověřeny z lokálně instalovaného výstupu nápovědy CLI.

Příkazy nejvyšší úrovně

Použijte tuto tabulku k rychlému nalezení správného příkazu.

Command	Použijte ho k
npx rayfin init [directory]	Vytvořte nebo nakonfigurujte projekt Rayfin.
npx rayfin up	Nasadit aplikaci na Fabric a spravovat vzdálená nasazení.
npx rayfin env	Generujte soubory prostředí specifické pro rámec z rayfin/.env.
npx rayfin login	Přihlaste se na platformu Rayfin.
npx rayfin logout	Odhlásit se a vyčistit cacheované přihlašovací údaje.

Vytvořte nebo nakonfigurujte projekt

rayfin init [directory]

Použijte rayfin init k přidání Rayfinu do nového nebo stávajícího projektu.

Argument	Description
--project-name <name>	Nastavte název projektu.
-t, --template <uri>	Určete šablonu URI, kterou použijete.
--template-name <name>	Vyberte šablonu podle jména.
-l, --list-templates	Uveďte dostupné šablony.
--dialect <dialect>	Nastavte dialekt databáze.
--services <list>	Vyberte si, které služby povolit.
--auth-methods <list>	Vyberte metody ověřování.
--static-hosting	Povolte nastavení statického hostingu.
--overwrite	Přepisujte existující generované soubory.
--workspace-id <id>	Použijte konkrétní ID pracovního prostoru Fabric.
--workspace-uri <uri>	Použijte specifické uživatelské uživatelské rozhraní Fabric workspace.
--base-api-url <url>	Přepisujte základní URL API.
--item-id <id>	Zaměřte se na konkrétní ID položky Fabric.

Examples

Uveďte dostupné šablony před lešením:

npx rayfin init --list-templates

Inicializujte Rayfin v aktuálním adresáři pomocí pojmenované šablony a konkrétního dialektu:

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

Vytvořte nový projekt neinteraktivně s nakonfigurovanými službami a autentizací:

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

Nasazení do Fabric

rayfin up

Použijte rayfin up k nasazení aplikace na Fabric jako položku Rayfin.

Argument	Description
--tenant <id>	Použijte konkrétní tenant ID.
--workspace-id <id>	Nasadit na konkrétní ID pracovního prostoru Fabric.
--workspace-uri <uri>	Nasadit do konkrétního URI Fabric workspace.
--base-api-url <url>	Přepisujte základní URL API.
--force	Vynuťte kroky nasazení, když je to potřeba.
--dry-run	Zobrazit si akce nasazení bez jejich použití.
--env-file <path>	Načti hodnoty prostředí ze souboru.
--verbose	Ukažte podrobný výstup nasazení.
--json	Vraťte výstup nasazení ve formátu JSON.
-y, --yes	Přijímejte výzvy automaticky.
--encryption-fallback-enabled	Povolte záložní chování šifrování.

Examples

Nasadit do aktuálně zvoleného pracovního prostoru Fabric:

npx rayfin up

Předzvěst nasazení bez jejich aplikace:

npx rayfin up --dry-run --verbose

Nasazování do konkrétního pracovního prostoru neinteraktivně:

npx rayfin up --workspace-id 00000000-0000-0000-0000-000000000000 --yes

Subcommand	Description
npx rayfin up db apply	Generujte a aplikujte DAB konfiguraci na vzdálený endpoint zátěže položek Rayfin.
npx rayfin up staticapp deploy	Postavte, zabalte a nasazujte statický obsah na vzdálený Rayfin předmět.
npx rayfin up status	Zobrazit aktuální stav nasazení.
npx rayfin up list	Uveďte všechna nasazení Fabric zaznamenaná pro tento projekt.
npx rayfin up switch [workspace]	Přepněte aktivní Fabric nasazení a přepište rayfin/.env.

rayfin up db apply

Generuje a aplikuje DAB konfiguraci na vzdálený endpoint zátěže položek Rayfin.

Argument	Description
--verbose	Zobrazení podrobného výstupu
--force	Vynuť regeneraci a aplikovat konfiguraci.
--json	Vraťte výstup ve formátu JSON.

Examples

Aplikujte změny konfigurace databáze na vzdálený Rayfin prvek:

npx rayfin up db apply

Vynucování regenerace a zachycení strojově čitelného výstupu:

npx rayfin up db apply --force --json

rayfin up staticapp deploy

Staví, balí a nasazuje statický obsah na vzdálený Rayfin předmět.

Argument	Description
--verbose	Zobrazení podrobného výstupu
--skip-build	Nasadit bez spuštění kroku buildu.
--json	Vraťte výstup ve formátu JSON.

Examples

Sestavujte a nasazujte statický obsah:

npx rayfin up staticapp deploy

Nasadit předpřipravenou dist složku bez nutnosti restartovat build:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Zobrazuje stav nasazení do cloudu.

Argument	Description
--json	Stav návratu v JSON formátu.
--verbose	Zobrazení podrobného výstupu

Examples

Zkontrolujte aktuální stav nasazení:

npx rayfin up status

Vrátit status jako JSON pro použití ve skriptech:

npx rayfin up status --json

rayfin up list

Uvádí všechna nasazení Fabric zaznamenaná pro tento projekt.

Argument	Description
--json	Vraťte seznam nasazení ve formátu JSON.

Examples

Uveďte všechna zaznamenaná nasazení Fabric pro tento projekt:

npx rayfin up list

rayfin up switch [workspace]

Přepíná aktivní Fabric nasazení a přepisuje rayfin/.env podle toho.

Argument	Description
-l, --list	Vyveďte dostupné nasazení bez přepínání.
--no-emit-env	Přeskočte zápis souborů vygenerovaného prostředí.

Examples

Uveďte dostupná nasazení k přepnutí na:

npx rayfin up switch --list

Přepněte aktivní nasazení do konkrétního pracovního prostoru:

npx rayfin up switch my-workspace

Generování souborů prostředí

rayfin env

Použijte rayfin env pro generování hodnot specifických .env.localrayfin/.envpro rámec z .

Argument	Description
--framework <vite|nextjs|plain>	Vyberte formát cílového rámce.
--output <dir>	Zapisujte vygenerované soubory do konkrétního adresáře.
--show	Vytisknout vydané hodnoty bez zápisu souborů.

Examples

Vygenerujte kompatibilní .env.locals Vite:

npx rayfin env --framework vite

Náhled generovaných hodnot prostředí bez zápisu souborů:

npx rayfin env --framework nextjs --show

Přihlášení a odhlášení

rayfin login

Použijte k rayfin login přihlášení na platformu Rayfin.

Argument	Description
--tenant <id>	Použijte konkrétní tenant ID.
--service-principal	Zkuste se přihlásit jako hlavní pracovník. Tato možnost je uvedena v nápovědě, ale momentálně není podporována.
-u, --client-id <id>	Zadejte ID klienta pro přihlášení zástupce služby. Tato možnost je uvedena v nápovědě, ale momentálně není podporována.
-p, --client-secret <secret>	Zadejte klientské tajemství pro přihlášení principa služby. Tato možnost je uvedena v nápovědě, ale momentálně není podporována.
--select	Vyberte si z dostupných přihlášených účtů nebo kontextů.
--encryption-fallback-enabled	Povolte záložní chování šifrování.

Examples

Přihlaste se interaktivně:

npx rayfin login

Přihlaste se ke konkrétnímu nájemci:

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

Přepínání mezi přihlášenými účty:

npx rayfin login --select

Subcommand	Description
npx rayfin login status	Zobrazit aktuální stav autentizace.

rayfin login status

Zobrazuje aktuální stav autentizace.

Argument	Description
None	Tento podpříkaz nezobrazuje žádné možnosti v nápovědě CLI.

Example

Zkontrolujte, zda jste přihlášeni:

npx rayfin login status

rayfin logout

Odhlásí se a vymaže cacheované přihlašovací údaje.

Argument	Description
None	Tento příkaz neuvádí žádné možnosti v nápovědě CLI.

Example

Odhlásit se a vymazat cacheované přihlašovací údaje:

npx rayfin logout