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

Deploy to Fabric

rayfin up

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

Argumentti	Description
--tenant <id>	Käytä tiettyä vuokralaisen ID:tä.
--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.
--base-api-url <url>	Ohita perus-API-URL.
--force	Käytä voiman käyttöönottoa tarvittaessa.
--dry-run	Esikatso käyttöönoton toiminnot ilman niiden soveltamista.
--env-file <path>	Lataa ympäristön arvot tiedostosta.
--verbose	Näytä laaja käyttöönotto.
--json	Palauta käyttöönotto JSON-muodossa.
-y, --yes	Hyväksy kehotteet automaattisesti.
--encryption-fallback-enabled	Ota salaus varajärjestelmä käyttöön.

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

Subcommand	Description
npx rayfin up db apply	Luo ja sovella DAB-konfiguraatiota etä-Rayfin-esineen työkuorman päätepisteelle.
npx rayfin up staticapp deploy	Rakenna, paketoi ja julkaise staattista sisältöä etä-Rayfin-kohteeseen.
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 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