Rayfin CLI -viittaus

Löydä Rayfin CLI-komennot projektien luomiseen, skeemamuutosten hallintaan, Fabric-käyttöönottoon ja ympäristöasetusten konfigurointiin. Jokainen osio listaa komentosyntaksin, vaihtoehdot ja yleiset käyttötarkoitukset.

Asennus

Käytä npm i @microsoft/rayfin-cli CLI:n asentamiseen.

Aloittaminen

Seuraa terminaalisi ohjeita luodaksesi Fabric-sovelluksen.

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

Vinkki

Olemassa oleville tai tyhjille projekteille käytä npx rayfin init Rayfinin lisäämiseen projektiin, npm create jossa on jo lähdekoodi tai tyhjä hakemisto. Init-komento opastaa sinua palveluiden käyttöönotossa, tietokantamurteen valinnassa ja staattisen hostingin konfiguroinnissa ilman uuden mallipohjan rakentamista.

Koko läpipeluun löydät kohdista Luo ja ottele käyttöön ensimmäinen Fabric-sovelluksesi CLI ja Deploy a Fabric app Fabric.

Rakenna projekti npm create

npm create (alias ) npm init käynnistää uuden projektin kutsumalla Create Initializer -paketin. Fabric-sovelluksen rakentamiseksi käytä sitä @microsoft/rayfin alustuslaitteen kanssa:

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

Komentoviite

Tämän artikkelin komennot ja liput on vahvistettu paikallisesti asennetusta CLI-aputulosteesta.

Ylimmän tason komennot

Käytä tätä taulukkoa löytääksesi oikean komennon nopeasti.

Komento	Käytä sitä
npx rayfin init [directory]	Luo tai konfiguroi Rayfin-projekti.
npx rayfin connector	Etsi, konfiguroi, tarkasta ja kutsu Fabric-dataliittimet.
npx rayfin functions init	Rakenna Functions-paketti.
npx rayfin dev	Käynnistä sovellus ja Functions paikallisesti.
npx rayfin init ai-files	Asenna tai tarkista Rayfin-agentin kontekstitiedostot.
npx rayfin up	Ota sovellus käyttöön Fabric-palveluun ja hallinnoi etäkäyttöönottoja.
npx rayfin env	Luo kehyskohtaisia ympäristötiedostoja .rayfin/.env
npx rayfin login	Kirjaudu Rayfin-alustalle.
npx rayfin logout	Kirjaudu ulos ja tyhjennä välimuistissa olevat tunnukset.

Luo tai konfiguroi projekti

rayfin init [directory]

Käytä rayfin init Rayfinin lisäämiseen uuteen tai olemassa olevaan projektiin.

Argumentti	Description
--project-name <name>	Aseta projektin nimi.
-t, --template <uri>	Määritä käytettävä mallipohjan URI.
--template-name <name>	Valitse mallipohja nimen perusteella.
-l, --list-templates	Listaa saatavilla olevat mallipohjat.
--dialect <dialect>	Aseta tietokantamurre.
--services <list>	Valitse, mitkä palvelut otat käyttöön.
--auth-methods <list>	Valitse todennusmenetelmät.
--static-hosting	Ota staattinen hosting-asetus käyttöön.
--overwrite	Korvaa olemassa olevat generoidut tiedostot.
--workspace-id <id>	Käytä tiettyä Fabric-työtila-ID:tä.
--workspace-uri <uri>	Käytä tiettyä Fabric-työtilan URI:ta.
--base-api-url <url>	Ohita perus-API-URL.
--item-id <id>	Kohdista tietty Fabric-esine-ID.

Esimerkkejä

Listaa käytettävissä olevat mallit ennen telineitä:

npx rayfin init --list-templates

Alusta Rayfin nykyisessä hakemistossa käyttämällä nimettyä mallipohjaa ja tiettyä murretta:

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

Luo uusi projekti ei-interaktiivisesti, palvelut ja autentikointi konfiguroituina:

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

Liitinkomennot

Komentoryhmä connector hallinnoi ulkoisia Fabric-tietolähteitä.

rayfin connector types

Listaa liitintyypit, joita voit lisätä projektiin.

Vaihtoehto	Description
--json	Lähetä liitintyyppilista JSON-muodossa.
-v, --verbose	Sisällytä kyvykkyystiedot.

rayfin connector search [query]

Hakee Fabric-lähteitä, joita kirjautunut henkilöllisyys voi lisätä liittiminä.

Argumentti tai vaihtoehto	Description
[query]	Valinnainen, kirjainkoon liittymätön lähdenimisuodatin.
--query <text>	Nimetty lähdenimisuodatin, joka menee etusijalle [query].
--type <type>	Pilkulla eroteltujen liitintyyppejä; vaaditaan, kun --workspace-id tai --all-workspaces.
--workspace-id <id>	Etsi yksi Fabric-työtila.
--all-workspaces	Etsi jokainen työtila, johon identiteetti pääsee käsiksi.
-y, --yes	Hyväksy automaattisesti interaktiivinen lisäyksen siirto.
--limit <n>	Näytettyjen tulosten maksimimäärä.
--output <interactive\|plain\|json>	Valitse tulostusmuoto.
--json	Tulosta tulokset JSON-muodossa ja ohita interaktiivinen valitsija.
-v, --verbose	Ota käyttöön sanavalmis tulostus.

Kun kumpaakaan työtilavaihtoehtoa ei ole, komento hakee nykyisen projektin käyttöönoton tallennustiloista.

rayfin connector add --type <type>

Lisää liitäntä-ilmoituksen ja tukee projektitiedostoja.

Vaihtoehto	Description
--type <type>	Pakollinen. Liitintyyppi; käytetään rayfin connector types tyyppien listaamiseen.
--name <name>	Liittimen nimi; johdetaan kohteesta, kun se jätetään pois.
--workspace-id <id>	Fabric workspace ID.
--item-id <id>	Fabric item ID.
--operations <ops>	Pilkulla erotettu osajoukko sallituista operaatioista.
-v, --verbose	Ota käyttöön sanavalmis tulostus.
-y, --yes	Hyväksy vahvistukset automaattisesti.
--json	Lähetä JSON-ulostuloa.

rayfin connector list

Listaa liittimet, jotka on ilmoitettu .rayfin.yml

Vaihtoehto	Description
-v, --verbose	Sisällytä liittimen metatiedot ja ominaisuudet.
--json	Lähetä JSON-ulostuloa.

rayfin connector inspect

Tarkastaa konfiguroidun liittimen tai suoraan osoitetun Fabric-lähteen ilman muutoksia.

Vaihtoehto	Description
--name <name>	Konfiguroitu liittimen nimi.
-w, --workspace <name>	Työtilan nimi suoraa tarkastusta varten.
--workspace-id <id>	Työtilan tunnus suoraa tarkastusta varten.
--item <name>	Tuotteen nimi suoraa tarkastusta varten.
--item-id <id>	Tuotteen tunnus suoraa tarkastusta varten.
--type <type>	Liitintyyppi suoraa tarkastusta varten.
--url <url>	Semanttisen mallin portaalin URL; johtaa työtilan ja kohde-ID:t.
--entity <name>	Entiteetti tai taulukko näytteenottoon; jätä pois listataksesi --query entiteetit.
--query <path>	.sql tai .dax tiedoston suoritettavaksi vain luku -tilassa.
--rows <n>	Rivirajoitus; oletuksena on 10 näytteille ja rajoitettu 100:aan.
-v, --verbose	Ota käyttöön sanavalmis tulostus.
--output <interactive\|plain\|json>	Valitse tulostusmuoto.
--json	Lähetä JSON-ulostuloa.

Käyttö --name konfiguroidulle liittimelle, täydelliselle suoralähteen valitsimelle tai --url semanttiselle mallille.

rayfin connector invoke [connector-name] [operation]

Käynnistää operaation konfiguroidulla liittimellä.

Argumentti tai vaihtoehto	Description
[connector-name]	Konfiguroitu liittimen nimi.
[operation]	Liittimen toiminta, kuten executeQuery.
--name <name>	Nimetty vaihtoehto .[connector-name]
--operation <operation>	Nimetty vaihtoehto .[operation]
--input <json>	JSON-operaatiosyöte.
--file <path>	JSON-tiedosto, joka sisältää operaatiosyötteen.
--transport <auto\|deployed>	Kutsupolku; oletuksena .auto
-v, --verbose	Ota käyttöön sanavalmis tulostus.
--output <interactive\|plain\|json>	Valitse tulostusmuoto.
--output-file <path>	Kirjoita täydellinen tulos tiedostoon.
--max-inline-bytes <bytes>	Tuloskokokynnys tiedoston kirjoittamiseen; oletuksena 1 MiB.
--json	Lähetä JSON-ulostuloa.

rayfin connector remove <name>

Poistaa liittimen määrityksen ja sen luomat liitintiedostot.

Argumentti tai vaihtoehto	Description
<name>	Pakollinen. Liittimen nimi poistettavaksi.
-v, --verbose	Ota käyttöön sanavalmis tulostus.
-y, --yes	Hyväksy automaattisesti poistovahvistus.
--json	Lähetä JSON-ulostuloa.

Funktiokomennot

rayfin functions init [directory]

Rakentaa ja konfiguroi toimintopaketin.

Argumentti tai vaihtoehto	Description
[directory]	Project root; oletuksena nykyinen hakemisto.
--force	Korvaa olemassa oleva funktioiden rakenne.
--path <relative-path>	Funktiot paketoivat sijainnin suhteessa projektin juureen.

Paketin sijainti on oletuksena havaittu työtilan sijainti tai rayfin/functions.

Kehityskomennot

rayfin dev [project-path]

Aloittaa paikallisen kehityssession Rayfin-taustajärjestelmää vastaan.

Argumentti tai vaihtoehto	Description
[project-path]	Project root; oletuksena nykyinen hakemisto.
--skip-db-apply	Ohita automaattinen tietokannan konfigurointi.
--env-file <path>	.env tiedostoa käytetään interpolointiin rayfin.yml .
--provider <fabric>	Backend-palveluntarjoaja; oletuksena .fabric
-w, --workspace <name>	Fabric-työtilan nimi ensitoimiselle backendille.
--workspace-id <id>	Fabric workspace ID ensimmäisen suoritetun taustajärjestelmän osalta.
--capacity-id <id>	Fabric capacity ID työtilalle, jossa ei ole käyttökelpoista kapasiteettia.
-t, --tenant <id>	Microsoft Entra tenant ID.
--encryption-fallback-enabled	Salli selväkielinen token-tallennus, kun käyttöjärjestelmän avaimenperää ei ole saatavilla.
--no-emit-env	Älä generoi framework-tiedostoa .env.local uudelleen.
-v, --verbose	Ota yksityiskohtainen kirjaaminen käyttöön.

rayfin dev functions apply

Käynnistää paikallisen funktioiden isännän aktiivista käyttöönottoa vastaan.

Vaihtoehto	Description
--port <port>	Local Functions -isäntäportti; oletuksena .7071
--inspect-port <port>	Node.js tarkastajan portti; oletuksena .9229
--no-debug	Poista Node.js tarkastaja käytöstä.
--no-emit-env	Älä generoi framework-tiedostoa .env.local uudelleen.
--verbose	Näytä diagnostiikka.
--json	Lähetä JSON-ulostuloa.
-y, --yes	Juokse ilman interaktiivisia kehotuksia.

Hallinnoi agenttitiedostoja

Komento rayfin init ai-files hallinnoi Rayfin-agentin kontekstitiedostoja projektissasi: AGENTS.md, .mcp.json, ja .agents/skills/rayfin/SKILL.md. Komentorivi asentaa nämä tiedostot automaattisesti, kun rakentat projektin. Suorita alla olevat komennot asentaaksesi tai päivittääksesi ne olemassa olevaan projektiin, tai tarkista niiden tila.

rayfin init ai-files install

Asentaa tai päivittää Rayfin-agenttitiedostot. Komento on idempotentti ja säilyttää olemassa olevan käyttäjäkonfiguraation.

Vaihtoehto	Description
--enable <id>	Asenna tai pidä tietty kohde nimivälitunnuksellaan, kuten skill:rayfin. Toistettavissa.
--disable <id>	Lopeta tietyn tuotteen hallinta poistamatta sen tiedostoa. Toistettavissa.
--remove-files	Poista levyllä olevaa tiedostoa, kun poistat tuotteen käytöstä. Vaatii :n --disable.
--force [ids...]	Korvaa muokatut esineet, palauttaa puuttuvat esineet tai rakentaa virheelliset .mcp.jsonesineet uudelleen. Hyväksyy valinnaiset nimivälilliset ID:t operaation laajuudelle. Ei koskaan ylikirjoita AGENTS.md.
-n, --dry-run	Ilmoita muutokset ilman tiedostojen kirjoittamista.
--json	Lähetä rakenteellista ulostuloa JSON-muodossa; tarkoittaa ei-interaktiivista tilaa.
-y, --yes, --non-interactive	Ohita interaktiivinen kehote ja hyväksy oletusasetukset.

Esimerkiksi asenna oletusasetukset ilman kehotusta:

npx rayfin init ai-files install --yes

rayfin init ai-files status

Tulostaa kunkin hallitun agentin tiedoston tilan. Käyttö --json rakenteellisessa tuotannossa.

Mahdollisia tiloja ovat up-to-date, update-available, user-modified, missing, disablednot-installedorphaned, ja unreadable. Juokse rayfin init ai-files install päivittämään tiedostoja tai rayfin init ai-files install --force <id> ylikirjoittamaan tietyn hallitun kohteen.

Deploy to Fabric

rayfin up

Käytä rayfin up sovelluksen käyttöönottoon Fabric:lle Rayfin-tuotteena.

Argumentti	Description
-t, --tenant <id>	Käytä tiettyä vuokralaisen ID:tä.
-w, --workspace <name>	Deploy Fabric-työtilaan nimellä; oletuksena .My Workspace
--workspace-id <id>	Ota käyttöön tiettyyn Fabric-työtila-ID:hen.
--workspace-uri <uri>	Ota käyttöön tiettyyn Fabric-työtilan URI:hin.
--item-name <name>	Fabric-kohteen näyttönimi; oletuksena projekti-ID.
--capacity-id <id>	Fabric capacity ID, kun kohdetyötila tarvitsee kapasiteettia.
--force	Salli tuhoisat dataskeeman muutokset.
-n, --dry-run	Validoi syötteet ja ratkaise työtila ilman käyttöönottoa.
--env-file <path>	.envtiedosto käyttöönoton ominaisuuksille; oletuksena .rayfin/.env
-v, --verbose	Ota käyttöön sanavalmis tulostus.
--json	Palauta käyttöönotto JSON-muodossa.
-y, --yes	Hyväksy vahvistukset automaattisesti.
--encryption-fallback-enabled	Salli selväkielinen token-tallennus, kun käyttöjärjestelmän avaimenperää ei ole saatavilla.
--exclude-services <names>	Pilkulla eroteltuja palveluita ohitettavaksi rakentamisen ja käyttöönoton aikana: staticHosting tai functions.
--provider <fabric>	Käyttöönottopalveluntarjoaja; oletuksena .fabric

Esimerkkejä

Ota käyttöön valittuun Fabric-työtilaan:

npx rayfin up

Esitarkastele käyttöönottotoimintoja ilman niiden soveltamista:

npx rayfin up --dry-run --verbose

Julkaise tiettyyn työtilaan ei-interaktiivisesti:

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

Ota käyttöön ilman rakentamista tai käyttöönottoa Funktiot:

npx rayfin up --exclude-services functions

--capacity-idei voi yhdistää , --workspace--workspace-id, tai --workspace-uri.

Subcommand	Description
npx rayfin up db apply	Luo ja sovella DAB-konfiguraatiota etä-Rayfin-esineen työkuorman päätepisteelle.
npx rayfin up functions deploy	Rakenna, paketoi ja ota funktiot käyttöön aktiiviseen etäkohteeseen.
npx rayfin up staticapp deploy	Rakenna, paketoi ja julkaise staattista sisältöä etä-Rayfin-kohteeseen.
npx rayfin up connector apply	Sovella tietokantakonfiguraatiota ilmoitetuille GraphQL-liittimille.
npx rayfin up status	Näytä nykyinen käyttöönoton tila.
npx rayfin up list	Listaa kaikki projektiin tallennetut Fabric-käyttöönotot.
npx rayfin up switch [workspace]	Vaihda aktiivinen Fabric käyttöönotto ja kirjoita uudelleen rayfin/.env.

rayfin up db apply

Luo ja soveltaa DAB-konfiguraatiota etäiseen Rayfin-esineen työkuorman päätepisteeseen.

Argumentti	Description
--verbose	Näytä sanallista sisältöä.
--force	Pakota regeneraatio ja sovella konfiguraatio.
--json	Palauta tulos JSON-muodossa.

Esimerkkejä

Sovella tietokannan konfiguraatiomuutoksia etä-Rayfin-kohteeseen:

npx rayfin up db apply

Pakota regenerointi ja koneellisesti luettavan ulostulon kaappaus:

npx rayfin up db apply --force --json

rayfin up functions deploy

Rakentaa, paketoi ja ottaa käyttöön funktiot aktiiviseen etäkohteeseen.

Vaihtoehto	Description
--verbose	Näytä sanallista sisältöä.
--skip-build	Ota olemassa oleva funktioiden ulostulo käyttöön ilman rakentamista.
--json	Lähetä JSON-ulostuloa.

rayfin up connector apply

Soveltaa tietokantakonfiguraatiota ilmoitetuille GraphQL-liittimille.

Vaihtoehto	Description
--name <name>	Käytä vain nimettyä liitintä.
--verbose	Ota käyttöön sanavalmis tulostus.
--json	Lähetä JSON-ulostuloa.

rayfin up staticapp deploy

Rakentaa, pakkaa ja ottaa staattisen sisällön käyttöön etä-Rayfin-kohteeseen.

Argumentti	Description
--verbose	Näytä sanallista sisältöä.
--skip-build	Ota käyttöön ilman rakennusvaihetta.
--json	Palauta tulos JSON-muodossa.

Esimerkkejä

Rakenna ja ota käyttöön staattista sisältöä:

npx rayfin up staticapp deploy

Ota valmiiksi dist rakennettu kansio käyttöön ilman, että suoritat buildin uudelleen:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Näyttää pilven käyttöönoton tilan.

Argumentti	Description
--json	Palautustila JSON-muodossa.
--verbose	Näytä sanallista sisältöä.

Esimerkkejä

Tarkista nykyinen käyttöönoton tila:

npx rayfin up status

Palauta tila JSON-muodossa skripteissä käytettäväksi:

npx rayfin up status --json

rayfin up list

Listaa kaikki tämän projektin Fabric-käyttöönotot.

Argumentti	Description
--json	Palauta käyttöönottolista JSON-muodossa.

Esimerkkejä

Listaa kaikki projektin tallennetut Fabric-käyttöönotot:

npx rayfin up list

rayfin up switch [workspace]

Vaihtaa aktiivisen Fabric käyttöönoton ja kirjoittaa rayfin/.env uudelleen sen mukaan.

Argumentti	Description
-l, --list	Listaa käytettävissä olevat käyttöönotot ilman vaihtoa.
--no-emit-env	Ohittakaa lähetettyjen ympäristötiedostojen kirjoittaminen.

Esimerkkejä

Listaa käytettävissä olevat käyttöönotot, joihin voi vaihtaa:

npx rayfin up switch --list

Siirrä aktiivinen käyttöönotto tiettyyn työtilaan:

npx rayfin up switch my-workspace

Luo ympäristötiedostot

rayfin env

Käytä rayfin env kehyskohtaisten .env.local arvojen lähettämiseen .rayfin/.env

Argumentti	Description
--framework <vite|nextjs|plain>	Valitse kohdekehysmuoto.
--output <dir>	Kirjoita generoidut tiedostot tiettyyn hakemistoon.
--show	Tulosta lähetetyt arvot ilman tiedostojen kirjoittamista.

Esimerkkejä

Luo Vite-yhteensopiva .env.local:

npx rayfin env --framework vite

Esikatselu lähetettyjen ympäristöarvojen esikatselu ilman tiedostojen kirjoittamista:

npx rayfin env --framework nextjs --show

Kirjaudu sisään ja ulos

rayfin login

Kirjautumiseen Rayfin-alustalle rayfin login .

Argumentti	Description
--tenant <id>	Käytä tiettyä vuokralaisen ID:tä.
--service-principal	Yritä kirjautua palvelupäähenkilön sisään. Tämä vaihtoehto on listattu ohjeessa, mutta sitä ei tällä hetkellä tueta.
-u, --client-id <id>	Anna asiakastunnus palvelun päähenkilön kirjautumista varten. Tämä vaihtoehto on listattu ohjeessa, mutta sitä ei tällä hetkellä tueta.
-p, --client-secret <secret>	Anna asiakkaalle salainen palvelupäähenkilön kirjautuminen. Tämä vaihtoehto on listattu ohjeessa, mutta sitä ei tällä hetkellä tueta.
--select	Valitse saatavilla olevista kirjautuneista tileistä tai yhteyksistä.
--encryption-fallback-enabled	Ota salaus varajärjestelmä käyttöön.

Esimerkkejä

Kirjaudu sisään interaktiivisesti:

npx rayfin login

Kirjaudu tiettyyn vuokralaiseen:

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

Vaihda kirjautuneiden tilien välillä:

npx rayfin login --select

Subcommand	Description
npx rayfin login status	Näytä nykyinen todennustila.

rayfin login status

Näyttää nykyisen todennuksen tilan.

Argumentti	Description
Ei mikään	Tämä alikomento ei listaa mitään vaihtoehtoja komentorivin ohjetulosteessa.

Esimerkki

Tarkista, oletko kirjautunut sisään:

npx rayfin login status

rayfin logout

Kirjautuu ulos ja tyhjentää välimuistissa olevat tunnukset.

Argumentti	Description
Ei mikään	Tämä komento ei listaa mitään vaihtoehtoja CLI-ohjeen tulosteessa.

Esimerkki

Kirjaudu ulos ja tyhjennä välimuistissa olevat tunnukset:

npx rayfin logout