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
npx rayfin 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 connector	Najděte, konfigurujte, kontrolujte a vyvolávejte Fabric datové konektory.
npx rayfin functions init	Podpora balíčku Funkce.
npx rayfin dev	Spusťte aplikaci a funkce lokálně.
npx rayfin init ai-files	Nainstalujte nebo zkontrolujte kontextové soubory agenta 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

Příkazy konektoru

Skupina connector příkazů spravuje externí zdroje dat Fabric.

rayfin connector types

Uvádí typy konektorů, které můžete do projektu přidat.

Option	Description
--json	Seznam typů konektorů vysílejte jako JSON.
-v, --verbose	Uveďte podrobnosti o schopnostech.

rayfin connector search [query]

Hledá Fabric zdroje, které může přihlášená identita přidat jako konektory.

Argument nebo možnost	Description
[query]	Volitelný, na základě velikosti necitlivý filtr pro názvy zdrojů.
--query <text>	Filtr pojmenovaný zdrojový název, který má přednost před [query].
--type <type>	Typy konektorů oddělené čárkou; požadované s --workspace-id nebo --all-workspaces.
--workspace-id <id>	Prohledejte jedno pracovní místo Fabric.
--all-workspaces	Prohledejte každý pracovní prostor, ke kterému má identita přístup.
-y, --yes	Automaticky přijměte interaktivní předání přidaných hráčů.
--limit <n>	Maximální počet zobrazených výsledků.
--output <interactive\|plain\|json>	Vyberte formát výstupu.
--json	Výsledky vytisknout jako JSON a přeskočit interaktivní výběr.
-v, --verbose	Povolte podrobný výstup.

Pokud není nabídnuta žádná z možností pracovního prostoru, příkaz prohledá pracovní prostory zaznamenané pro aktuální nasazení projektu.

rayfin connector add --type <type>

Přidává deklaraci konektoru a podporuje soubory svých projektů.

Option	Description
--type <type>	Required. Typ konektoru; použití rayfin connector types k uvedení typů.
--name <name>	Název konektoru; odvozen z předmětu, když je vynechán.
--workspace-id <id>	Fabric workspace ID.
--item-id <id>	Fabric item ID.
--operations <ops>	Podmnožina povolených operací oddělená čárkou.
-v, --verbose	Povolte podrobný výstup.
-y, --yes	Automaticky přijímejte potvrzení.
--json	Vysílejte výstup JSON.

rayfin connector list

Uvádí konektory deklarované v rayfin.yml.

Option	Description
-v, --verbose	Zahrňte metadata a schopnosti konektorů.
--json	Vysílejte výstup JSON.

rayfin connector inspect

Kontroluje konfigurovaný konektor nebo přímo adresovaný Fabric zdroj bez nutnosti změn.

Option	Description
--name <name>	Konfigurovaný název konektoru.
-w, --workspace <name>	Název pracovního prostoru pro přímou kontrolu.
--workspace-id <id>	ID pracovního prostoru pro přímou kontrolu.
--item <name>	Název položky pro přímou kontrolu.
--item-id <id>	Položka ID pro přímou kontrolu.
--type <type>	Typ konektoru pro přímou kontrolu.
--url <url>	URL portálu sémantického modelu; odvozuje pracovní prostor a ID položek.
--entity <name>	Entita nebo tabulka pro vzorkování; vynechat s --query pro seznam entit.
--query <path>	.sql nebo .dax soubor pro spuštění pouze pro čtení.
--rows <n>	Limit řádků; výchozí 10 pro vzorky a je omezen na 100.
-v, --verbose	Povolte podrobný výstup.
--output <interactive\|plain\|json>	Vyberte formát výstupu.
--json	Vysílejte výstup JSON.

Použití --name pro konfigurovaný konektor, kompletní direct-source selector nebo --url pro sémantický model.

rayfin connector invoke [connector-name] [operation]

Spustí operaci na nakonfigurovaném konektoru.

Argument nebo možnost	Description
[connector-name]	Konfigurovaný název konektoru.
[operation]	Operace konektoru, například executeQuery.
--name <name>	Pojmenovaná alternativa k [connector-name].
--operation <operation>	Pojmenovaná alternativa k [operation].
--input <json>	Vstup operace JSON.
--file <path>	JSON soubor obsahující vstup operace.
--transport <auto\|deployed>	Invokační cesta; výchozí je .auto
-v, --verbose	Povolte podrobný výstup.
--output <interactive\|plain\|json>	Vyberte formát výstupu.
--output-file <path>	Zapište kompletní výsledek do souboru.
--max-inline-bytes <bytes>	Prahová hodnota velikosti výsledku pro zápis souboru; výchozí hodnota je 1 MiB.
--json	Vysílejte výstup JSON.

rayfin connector remove <name>

Odstraní deklaraci konektoru a její vygenerované soubory konektoru.

Argument nebo možnost	Description
<name>	Required. Název konektoru je potřeba odstranit.
-v, --verbose	Povolte podrobný výstup.
-y, --yes	Automaticky přijměte potvrzení o odstranění.
--json	Vysílejte výstup JSON.

Příkazy funkcí

rayfin functions init [directory]

Strukturu a konfiguraci balíčku Functions.

Argument nebo možnost	Description
[directory]	Project root; výchozí nastavení je aktuální adresář.
--force	Přepiš existující lešení Funkce.
--path <relative-path>	Umístění balíčku funkcí vzhledem ke kořeni projektu.

Umístění balíčku je výchozí na detekované umístění pracovního prostoru nebo rayfin/functions.

Vývojové příkazy

rayfin dev [project-path]

Spustí lokální vývojovou seanci proti backendu Rayfinu.

Argument nebo možnost	Description
[project-path]	Project root; výchozí nastavení je aktuální adresář.
--skip-db-apply	Přeskočit automatickou konfiguraci databáze aplikovat.
--env-file <path>	.env soubor použitý pro rayfin.yml interpolaci.
--provider <fabric>	Backend poskytovatel; výchozí nastavení na fabric.
-w, --workspace <name>	Fabric pracovní prostor pro první backend.
--workspace-id <id>	Fabric workspace ID pro backend prvního běhu.
--capacity-id <id>	Fabric capacity ID pro pracovní prostor bez využitelné kapacity.
-t, --tenant <id>	ID tenanta Microsoft Entra.
--encryption-fallback-enabled	Povolit ukládání tokenů v otevřeném textu, pokud není k dispozici žádný klíčový řetězec OS.
--no-emit-env	Negenerujte framework soubor..env.local
-v, --verbose	Povolte podrobné protokolování.

rayfin dev functions apply

Spustí lokální hostitel Functions proti aktivnímu nasazení.

Option	Description
--port <port>	Hostitelský port lokálních funkcí; výchozí na 7071.
--inspect-port <port>	Node.js inspector port; výchozí je .9229
--no-debug	Vypněte Node.js inspektora.
--no-emit-env	Negenerujte framework soubor..env.local
--verbose	Zobrazit diagnostický výstup.
--json	Vysílejte výstup JSON.
-y, --yes	Běžte bez interaktivních nápověd.

Správa souborů agentů

Příkaz rayfin init ai-files spravuje kontextové soubory agenta Rayfin ve vašem projektu: AGENTS.md, .mcp.json, a .agents/skills/rayfin/SKILL.md. CLI tyto soubory automaticky instaluje, když projekt scaffoldujete. Spusť níže uvedené příkazy pro instalaci nebo obnovení v existujícím projektu, nebo zkontroluj jejich stav.

rayfin init ai-files install

Nainstaluje nebo obnoví soubory agenta Rayfin. Příkaz je idempotentní a zachovává stávající uživatelskou konfiguraci.

Option	Description
--enable <id>	Nainstalujte nebo ponechte konkrétní položku podle jejího jmenného ID, například skill:rayfin. Opakovatelný.
--disable <id>	Přestaňte spravovat konkrétní položku bez mazání jejího souboru. Opakovatelný.
--remove-files	Při deaktivaci položky odstraňte soubor na disku. Vyžaduje --disable.
--force [ids...]	Přepis upravených položek, obnovení chybějících položek nebo obnovení deformovaných .mcp.jsonpoložek. Přijímá volitelná jmenná ID pro rozsah operace. Nikdy nepřepisuje AGENTS.md.
-n, --dry-run	Nahlaste změny bez psaní souborů.
--json	Emitovat strukturovaný výstup jako JSON; implikuje neinteraktivní režim.
-y, --yes, --non-interactive	Přeskočte interaktivní výzvu a přijměte výchozí nastavení.

Například instalace se nastaví bez výzvy:

npx rayfin init ai-files install --yes

rayfin init ai-files status

Vytiskne stav každého souboru spravovaného agenta. Použití --json pro strukturovaný výstup.

Možné stavy zahrnují up-to-date, update-available, user-modified, missing, not-installed, disabled, , orphaneda .unreadable Spouštějte rayfin init ai-files install pro obnovení souborů nebo rayfin init ai-files install --force <id> přepsání konkrétní spravované položky.

Nasazení do Fabric

rayfin up

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

Argument	Description
-t, --tenant <id>	Použijte konkrétní tenant ID.
-w, --workspace <name>	Nasadit do pracovního prostoru Fabric podle jména; výchozí je .My Workspace
--workspace-id <id>	Nasadit na konkrétní ID pracovního prostoru Fabric.
--workspace-uri <uri>	Nasadit do konkrétního URI Fabric workspace.
--item-name <name>	Fabric display name items; výchozí je ID projektu.
--capacity-id <id>	Fabric capacity ID, když cílový pracovní prostor potřebuje kapacitu.
--force	Povolit destruktivní změny datového schématu.
-n, --dry-run	Ověřte vstupy a vyřešte pracovní prostor bez nasazení.
--env-file <path>	.envsoubor pro vlastnosti nasazení; výchozí je .rayfin/.env
-v, --verbose	Povolte podrobný výstup.
--json	Vraťte výstup nasazení ve formátu JSON.
-y, --yes	Automaticky přijímejte potvrzení.
--encryption-fallback-enabled	Povolit ukládání tokenů v otevřeném textu, pokud není k dispozici žádný klíčový řetězec OS.
--exclude-services <names>	Služby oddělené čárkou, které se přeskakují během sestavování a nasazení: staticHosting nebo functions.
--provider <fabric>	Poskytovatel nasazení; výchozí nastavení na fabric.

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

Nasazení bez budování nebo nasazení Funkce:

npx rayfin up --exclude-services functions

--capacity-id Nelze kombinovat s --workspace, --workspace-id, nebo --workspace-uri.

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 functions deploy	Postavte, zabalte a nasaděte Funkce na aktivní vzdálenou položku.
npx rayfin up staticapp deploy	Postavte, zabalte a nasazujte statický obsah na vzdálený Rayfin předmět.
npx rayfin up connector apply	Aplikujte databázovou konfiguraci pro deklarované konektory GraphQL.
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 functions deploy

Sestavuje, balí a nasazuje Funkce na aktivní vzdálený předmět.

Option	Description
--verbose	Zobrazení podrobného výstupu
--skip-build	Nasadit existující výstup Functions bez sestavování.
--json	Vysílejte výstup JSON.

rayfin up connector apply

Aplikuje databázovou konfiguraci pro deklarované GraphQL konektory.

Option	Description
--name <name>	Aplikujte pouze pojmenovaný konektor.
--verbose	Povolte podrobný výstup.
--json	Vysílejte výstup 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