Rayfin CLI referansı

Projeler oluşturmak, şema değişikliklerini yönetmek, Fabric'e dağıtmak ve ortam ayarlarını yapılandırmak için Rayfin CLI komutlarını bulun. Her bölümde komut sözdizimi, seçenekler ve yaygın kullanımlar listelenir.

Yükleme

CLI'yı kurmak için kullanın npm i @microsoft/rayfin-cli .

Başlangıç Yapmak

Terminalinizdeki adımları takip ederek bir Fabric uygulaması oluşturun.

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

Tavsiye

Mevcut veya boş projeler için, kaynak kodu veya boş bir dizin olan bir projeye Rayfin eklemek yerine npm create kullanınnpx rayfin init. Init komutu size hizmetleri etkinleştirme, veritabanı diyalekti seçme ve yeni bir şablon eklemeden statik barındırmayı yapılandırmak konusunda rehberlik eder.

Tam yürütme için İlk Fabric uygulamanızı CLIile oluştur ve dağıt ve Deploy a Fabric uygulaması Fabric'a bakabilirsiniz.

Bir proje iskele yapın npm create

npm create (takma ad) npm init Bir Yarat başlatıcı paketi çağırarak yeni bir proje başlatır. Bir Fabric uygulamasını iskele etmek için @microsoft/rayfin başlatıcısı ile kullanın:

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

Komut Referansı

Bu makaledeki komutlar ve bayraklar, yerel olarak yüklü CLI yardım çıkışından doğrulanmıştır.

Üst düzey komutlar

Doğru komutu hızlıca bulmak için bu tabloyu kullanın.

Komut	Kullanmak için
rayfin init [directory]	Bir Rayfin projesi oluşturun veya yapılandırın.
rayfin up	Uygulamayı Fabric'e yerleştirin ve uzaktan dağıtımları yönetin.
rayfin env	Çerçeveye özgü ortam dosyaları oluşturulur.rayfin/.env
rayfin login	Rayfin platformuna giriş yapın.
rayfin logout	Çıkış yapın ve önbelleğe alınmış kimlik bilgilerini temizleyin.

Bir proje oluşturun veya yapılandırabilirsiniz

rayfin init [directory]

Yeni veya mevcut bir projeye Rayfin'i eklemek için kullanın rayfin init .

Argument	Açıklama
--project-name <name>	Proje adını belirleyin.
-t, --template <uri>	Kullanılacak şablon URI'sini belirtin.
--template-name <name>	İsme göre bir şablon seçin.
-l, --list-templates	Mevcut şablonları listeleyin.
--dialect <dialect>	Veritabanı lehçesini ayarlayın.
--services <list>	Hangi hizmetleri etkinleştireceğinizi seçin.
--auth-methods <list>	Kimlik doğrulama yöntemlerini seçin.
--static-hosting	Statik barındırma kurulumunu etkinleştir.
--overwrite	Mevcut oluşturulan dosyaların üzerine yazın.
--workspace-id <id>	Özel bir Fabric çalışma alanı kimliği kullanın.
--workspace-uri <uri>	Belirli bir Fabric çalışma alanı URI'si kullanın.
--base-api-url <url>	Temel API URL'sini geçersiz kılın.
--item-id <id>	Belirli bir Fabric öğe ID'sini hedefleyin.

Examples

İskele kurmadan önce mevcut şablonları listeleyin:

npx rayfin init --list-templates

Rayfin'i mevcut dizinde adlandırılmış bir şablon ve belirli bir lehçe kullanarak başlatın:

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

Hizmetler ve kimlik doğrulama yapılandırılmış, etkileşimsiz yeni bir proje oluşturun:

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

Fabric dağıtma

rayfin up

Uygulamayı Fabric'ye Rayfin öğesi olarak dağıtmak için rayfin up kullanın.

Argument	Açıklama
--tenant <id>	Belirli bir kiracı kimliği kullanın.
--workspace-id <id>	Belirli bir Fabric workspace ID'sine dağıtın.
--workspace-uri <uri>	Belirli bir Fabric çalışma alanı URI'sine dağıtın.
--base-api-url <url>	Temel API URL'sini geçersiz kılın.
--force	Gerektiğinde güç yerleştirme adımlarını kullanın.
--dry-run	Uygulama eylemlerini uygulamadan önizlemek.
--env-file <path>	Bir dosyadan ortam değerlerini yükleyin.
--verbose	Ayrıntılı dağıtım çıktısını göster.
--json	JSON formatında dağıtım çıktısını geri döndür.
-y, --yes	İstemleri otomatik olarak kabul edin.
--encryption-fallback-enabled	Şifreleme yedek davranışını etkinleştir.

Examples

Şu anda seçilmiş Fabric çalışma alanına dağıtın:

npx rayfin up

Uygulama eylemlerini uygulamadan önizleme:

npx rayfin up --dry-run --verbose

Belirli bir çalışma alanına etkileşimsiz olarak dağıtın:

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

Subcommand	Açıklama
rayfin up db apply	DAB yapılandırmasını uzak Rayfin öğe iş yükü uç noktasına oluşturun ve uygulayın.
rayfin up staticapp deploy	Uzak Rayfin öğesine statik içerik oluşturun, paketleyin ve dağıtın.
rayfin up status	Mevcut dağıtım durumunu göster.
rayfin up list	Proje için kaydedilen tüm Fabric dağıtımlarını listeleyin.
rayfin up switch [workspace]	Aktif Fabric dağıtımını değiştirin ve rayfin/.env'yi yeniden yazın.

rayfin up db apply

Uzak Rayfin öğe iş yükü uç noktasına DAB yapılandırması oluşturur ve uygular.

Argument	Açıklama
--verbose	Ayrıntılı çıkışı göster.
--force	Güç yenileme ve yapılandırma uygula.
--json	JSON formatında çıkış geri döndürün.

Examples

Veritabanı yapılandırma değişikliklerini uzak Rayfin öğesine uygulayın:

npx rayfin up db apply

Zorla yenileme ve makine tarafından okunabilir çıktıyı yakalama:

npx rayfin up db apply --force --json

rayfin up staticapp deploy

Uzak Rayfin öğesine statik içerik oluşturur, paketler ve dağıtır.

Argument	Açıklama
--verbose	Ayrıntılı çıkışı göster.
--skip-build	Build adımını çalıştırmadan dağıt.
--json	JSON formatında çıkış geri döndürün.

Examples

Statik içerik oluştur ve dağıt:

npx rayfin up staticapp deploy

Hazır bir dist klasörü deri yeniden çalıştırmadan dağıtın:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Bulut dağıtımının durumunu gösterir.

Argument	Açıklama
--json	JSON formatında dönüş durumu.
--verbose	Ayrıntılı çıkışı göster.

Examples

Mevcut dağıtım durumunu kontrol edin:

npx rayfin up status

Scriptlerde kullanmak için JSON olarak döndürülme durumu:

npx rayfin up status --json

rayfin up list

Bu proje için kaydedilen tüm Fabric dağıtımlarını listeler.

Argument	Açıklama
--json	Dağıtım listesini JSON formatında döndür.

Examples

Proje için kaydedilen tüm Fabric dağıtımlarını listeleyin:

npx rayfin up list

rayfin up switch [workspace]

Aktif Fabric dağıtımını değiştirir ve rayfin/.env buna göre yeniden yazar.

Argument	Açıklama
-l, --list	Mevcut dağıtımları değiştirmeden listeleyin.
--no-emit-env	Yayımlanan ortam dosyalarını yazmayı atlayın.

Examples

Geçiş için mevcut dağıtımları listeleyin:

npx rayfin up switch --list

Aktif dağıtımı belirli bir çalışma alanına geçirin:

npx rayfin up switch my-workspace

Ortam dosyaları oluşturun

rayfin env

rayfin env Framework-specific .env.local değerleri için kullanılırrayfin/.env.

Argument	Açıklama
--framework <vite|nextjs|plain>	Hedef çerçeve formatını seçin.
--output <dir>	Oluşturulan dosyaları belirli bir dizine yaz.
--show	Gönderilen değerleri dosya yazmadan yazdırın.

Examples

Vite uyumlu .env.localbir ürün oluşturun :

npx rayfin env --framework vite

Dosya yazmadan yayımlanan ortam değerlerini önizleme:

npx rayfin env --framework nextjs --show

Oturum açma ve oturum kapatma

rayfin login

Rayfin platformuna giriş yapmak için kullanılır rayfin login .

Argument	Açıklama
--tenant <id>	Belirli bir kiracı kimliği kullanın.
--service-principal	Hizmet ana girişini dene. Bu seçenek yardımda listelenmiş ama şu anda desteklenmiyor.
-u, --client-id <id>	Hizmet ana girişi için istemci kimliğini verin. Bu seçenek yardımda listelenmiş ama şu anda desteklenmiyor.
-p, --client-secret <secret>	Hizmet ana girişi için istemci sırrını sağla. Bu seçenek yardımda listelenmiş ama şu anda desteklenmiyor.
--select	Mevcut giriş hesapları veya bağlamlar arasından seçim yapın.
--encryption-fallback-enabled	Şifreleme yedek davranışını etkinleştir.

Examples

Etkileşimli olarak giriş yapın:

npx rayfin login

Belirli bir kiracıya giriş yapın:

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

Giriş yapan hesaplar arasında geçiş:

npx rayfin login --select

Subcommand	Açıklama
rayfin login status	Mevcut kimlik doğrulama durumunu gösterin.

rayfin login status

Güncel kimlik doğrulama durumunu gösterir.

Argument	Açıklama
Hiçbiri	Bu alt komut, CLI yardım çıktısında hiçbir seçenek listelemiyor.

Example

Giriş yapıp yapmadığınızı kontrol edin:

npx rayfin login status

rayfin logout

Çıkış yapıyor ve önbelleğe alınmış kimlik bilgilerini temizliyor.

Argument	Açıklama
Hiçbiri	Bu komut, CLI yardım çıktısında hiçbir seçeneği listelemiyor.

Example

Çıkış yapın ve önbelleğe alınmış kimlik bilgilerini temizleyin:

npx rayfin logout