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
npx rayfin 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 npx rayfin init kullanınnpm create. 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
npx rayfin init [directory]	Bir Rayfin projesi oluşturun veya yapılandırın.
npx rayfin connector	Fabric veri bağlayıcılarını bul, yapılandırın, inceleyin ve çağırın.
npx rayfin functions init	Fonksiyon paketi için iskele yapın.
npx rayfin dev	Uygulamayı ve Fonksiyonları yerel olarak çalıştırın.
npx rayfin init ai-files	Rayfin ajanı bağlam dosyalarını kur veya kontrol et.
npx rayfin up	Uygulamayı Fabric'e yerleştirin ve uzaktan dağıtımları yönetin.
npx rayfin env	Çerçeveye özgü ortam dosyaları oluşturulur.rayfin/.env
npx rayfin login	Rayfin platformuna giriş yapın.
npx 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

Bağlantı komutları

Komuta grubu, connector harici Fabric veri kaynaklarını yönetir.

rayfin connector types

Bir projeye ekleyebileceğiniz konnektör türlerini listeler.

Seçenek	Açıklama
--json	Konnektör tipi listesini JSON olarak yayınlayın.
-v, --verbose	Yetenek detaylarını ekleyin.

rayfin connector search [query]

Giriş yapan kimliğin ekleyebileceği Fabric kaynaklarını arar.

Argüman veya seçenek	Açıklama
[query]	İstekli, büyük harf duyarsızlığı olmayan kaynak adı filtresi.
--query <text>	Adını alan kaynak-adı filtresi, öncelikli [query].
--type <type>	Virgülle ayrılmış konnektör türleri; veya --workspace-id--all-workspacesile gereklidir.
--workspace-id <id>	Bir Fabric çalışma alanı ara.
--all-workspaces	Kimliğin erişebileceği her çalışma alanını arayın.
-y, --yes	Etkileşimli ekleme devrini otomatik olarak kabul edin.
--limit <n>	Görüntülenen maksimum sonuç sayısı.
--output <interactive\|plain\|json>	Çıkış formatını seçin.
--json	Sonuçları JSON olarak yazdırın ve etkileşimli seçiciyi atlayın.
-v, --verbose	Ayrıntılı çıkışı etkinleştirin.

Her iki çalışma alanı seçeneği de sunulmadığında, komut mevcut proje dağıtımı için kaydedilen çalışma alanlarını arar.

rayfin connector add --type <type>

Bir bağlantı beyanı ekliyor ve proje dosyalarını destekleyecek.

Seçenek	Açıklama
--type <type>	Gerekli. Bağlantı tipi; türleri listelemek için kullanılır rayfin connector types .
--name <name>	Bağlantı adı; çıkarıldığında öğeden türetilmiştir.
--workspace-id <id>	Fabric workspace ID.
--item-id <id>	Fabric item ID.
--operations <ops>	İzin verilen işlemlerin virgülle ayrılmış alt kümesi.
-v, --verbose	Ayrıntılı çıkışı etkinleştirin.
-y, --yes	Otomatik olarak onayları kabul edin.
--json	JSON çıkışı yayımlayın.

rayfin connector list

Tanımlanan bağlayıcıları listeler rayfin.yml.

Seçenek	Açıklama
-v, --verbose	Bağlantı meta verisi ve yetenekleri ekleyin.
--json	JSON çıkışı yayımlayın.

rayfin connector inspect

Yapılandırma konnektörü veya doğrudan adresli bir Fabric kaynağını değişiklik yapmadan inceler.

Seçenek	Açıklama
--name <name>	Yapılandırılmış konnektör adı.
-w, --workspace <name>	Doğrudan inceleme için çalışma alanı adı.
--workspace-id <id>	Doğrudan inceleme için çalışma alanı kimliği.
--item <name>	Doğrudan inceleme için ürün adı.
--item-id <id>	Doğrudan inceleme için ürün kimliği.
--type <type>	Doğrudan inceleme için konnektör tipi.
--url <url>	Semantik model portalı URL'si; çalışma alanı ve öğe kimliklerini türetir.
--entity <name>	Örneklemek için varlık veya tablo; Varlıkları --query listelemek için atlayın.
--query <path>	.sql veya .dax sadece okunma modunda çalıştırmak için dosya kullanmak.
--rows <n>	Satır sınırı; örnekler için varsayılan olarak 10 ile sınırlandırılır ve 100 ile sınırlandırılır.
-v, --verbose	Ayrıntılı çıkışı etkinleştirin.
--output <interactive\|plain\|json>	Çıkış formatını seçin.
--json	JSON çıkışı yayımlayın.

Yapılandırılmış bir konnektör, tam bir doğrudan kaynak seçici veya --url anlamsal model için kullanım--name.

rayfin connector invoke [connector-name] [operation]

Yapılandırılmış bir konnektörde bir işlem çağrılıyor.

Argüman veya seçenek	Açıklama
[connector-name]	Yapılandırılmış konnektör adı.
[operation]	Konnektör işlemi, örneğin executeQuery.
--name <name>	Alternatif [connector-name]olarak adlandırılmıştır.
--operation <operation>	Alternatif [operation]olarak adlandırılmıştır.
--input <json>	JSON işlem girişi.
--file <path>	Operasyon girişi içeren JSON dosyası.
--transport <auto\|deployed>	Çağrı yolu; varsayılan olarak .auto
-v, --verbose	Ayrıntılı çıkışı etkinleştirin.
--output <interactive\|plain\|json>	Çıkış formatını seçin.
--output-file <path>	Tam sonucu bir dosyaya yaz.
--max-inline-bytes <bytes>	Dosya yazmak için sonuç boyutu eşiği; varsayılan olarak 1 MiB'dir.
--json	JSON çıkışı yayımlayın.

rayfin connector remove <name>

Bir konnektör beyanını ve oluşturulan bağlayıcı dosyalarını kaldırır.

Argüman veya seçenek	Açıklama
<name>	Gerekli. Kaldırılması gereken bağlantı adı.
-v, --verbose	Ayrıntılı çıkışı etkinleştirin.
-y, --yes	Kaldırma onayını otomatik olarak kabul edin.
--json	JSON çıkışı yayımlayın.

Fonksiyon komutları

rayfin functions init [directory]

Bir Fonksiyon paketi iskele yapıp yapılandırır.

Argüman veya seçenek	Açıklama
[directory]	Project root; varsayılan olarak mevcut dizine geçer.
--force	Mevcut bir Fonksiyon iskelesini üzerine yaz.
--path <relative-path>	Fonksiyonlar paket konumunu proje köküne göre gösterir.

Paket konumu, varsayılan olarak algılanan bir çalışma alanı konumu veya rayfin/functions.

Geliştirme komutanlıkları

rayfin dev [project-path]

Rayfin arka uçuna karşı yerel bir geliştirme oturumu başlatıyor.

Argüman veya seçenek	Açıklama
[project-path]	Project root; varsayılan olarak mevcut dizine geçer.
--skip-db-apply	Otomatik veritabanı yapılandırmasını atlayın.
--env-file <path>	.env Ara geçirme için rayfin.yml kullanılan dosya.
--provider <fabric>	Arka uç sağlayıcı; varsayılan olarak .fabric
-w, --workspace <name>	Fabric çalışma alanı adı, ilk çalıştırılan backend için.
--workspace-id <id>	İlk çalıştırılan arka uç için Fabric workspace ID.
--capacity-id <id>	Kullanılabilir kapasite olmayan bir çalışma alanı için Fabric kapasite ID'si.
-t, --tenant <id>	Microsoft Entra kiracı kimliği.
--encryption-fallback-enabled	Herhangi bir işletim sistemi anahtar zinciri yokken açık metin token depolamasına izin verin.
--no-emit-env	Framework .env.local dosyasını yeniden oluşturma.
-v, --verbose	Ayrıntılı günlük kaydını etkinleştirin.

rayfin dev functions apply

Aktif dağıtıma karşı yerel Functions konakını başlatır.

Seçenek	Açıklama
--port <port>	Local Functions ana portu; varsayılan olarak 7071.
--inspect-port <port>	Node.js müfettiş portu; varsayılan olarak .9229
--no-debug	Node.js müfettişini devre dışı bırakın.
--no-emit-env	Framework .env.local dosyasını yeniden oluşturma.
--verbose	Tanı çıktısını göster.
--json	JSON çıkışı yayımlayın.
-y, --yes	Etkileşimli istemler olmadan çalışın.

Ajan dosyalarını yönet

Komut, rayfin init ai-files projenizdeki Rayfin ajan bağlam dosyalarını yönetir: AGENTS.md, .mcp.json, ve .agents/skills/rayfin/SKILL.md. CLI, bir projeyi iskelete aldığınızda bu dosyaları otomatik olarak yükler. Aşağıdaki komutları çalıştırarak mevcut bir projede onları kurup veya yenileyin, ya da durumlarını kontrol edin.

rayfin init ai-files install

Rayfin ajan dosyalarını yükler veya yeniler. Komut idempotenttir ve mevcut kullanıcı konfigürasyonunu korur.

Seçenek	Açıklama
--enable <id>	Belirli bir öğeyi isim aralığı kimliğiyle kurmak veya saklamak için, örneğin skill:rayfin. Tekrarlanabilir.
--disable <id>	Belirli bir öğeyi dosyasını silmeden yönetmeyi bırakın. Tekrarlanabilir.
--remove-files	Bir öğeyi devre dışı bırakırken disk üzerindeki dosyayı kaldırın. gerektirir --disable.
--force [ids...]	Değiştirilmiş öğelerin üzerine yaz, eksik öğeleri geri getir veya bozulmuş .mcp.jsonöğeleri yeniden inşa et. İşlemi kapsama alanı için isteğe bağlı isim aralığına bağlı kimlikleri kabul eder. Asla üzerine yazmıyor AGENTS.md.
-n, --dry-run	Dosya yazmadan değişiklikleri bildirin.
--json	JSON olarak yapılandırılmış çıktı yayım; etkileşimsiz modu ima eder.
-y, --yes, --non-interactive	Etkileşimli isteği atlayın ve varsayılanları kabul edin.

Örneğin, varsayılan ayarları istemeden kurun:

npx rayfin init ai-files install --yes

rayfin init ai-files status

Her yönetilen ajan dosyasının durumunu yazdırır. Yapılandırılmış çıktı için kullanım --json .

Olası durumlar arasında up-to-date, update-available, user-modified, disabledorphanedmissingnot-installedve .unreadable Dosyaları yenilemek veya rayfin init ai-files install --force <id> belirli bir yönetilen öğenin üzerine yazmak için çalıştırınrayfin init ai-files install.

Fabric dağıtma

rayfin up

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

Argument	Açıklama
-t, --tenant <id>	Belirli bir kiracı kimliği kullanın.
-w, --workspace <name>	Bir Fabric çalışma alanına isimle dağıtın; varsayılan olarak .My Workspace
--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.
--item-name <name>	Fabric öğesi gösterim adı; varsayılan olarak proje kimliği olur.
--capacity-id <id>	Fabric kapasite ID'si hedef çalışma alanı kapasiteye ihtiyaç duyduğunda.
--force	Yıkıcı veri şeması değişikliklerine izin verin.
-n, --dry-run	Girdileri doğrulayın ve çalışma alanını dağıtmadan çözebilirsiniz.
--env-file <path>	.envdağıtım özellikleri için dosya; varsayılan olarak .rayfin/.env
-v, --verbose	Ayrıntılı çıkışı etkinleştirin.
--json	JSON formatında dağıtım çıktısını geri döndür.
-y, --yes	Otomatik olarak onayları kabul edin.
--encryption-fallback-enabled	Herhangi bir işletim sistemi anahtar zinciri yokken açık metin token depolamasına izin verin.
--exclude-services <names>	Virgülle ayrılmış servisler, derleme ve dağıtım sırasında atlanacak: staticHosting veya functions.
--provider <fabric>	Dağıtım sağlayıcısı; varsayılan olarak .fabric

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

Fonksiyonlar oluşturmadan veya dağıtmadan dağıtın:

npx rayfin up --exclude-services functions

--capacity-id, , veya --workspace-uriile birleştirilemez. --workspace-id--workspace

Subcommand	Açıklama
npx rayfin up db apply	DAB yapılandırmasını uzak Rayfin öğe iş yükü uç noktasına oluşturun ve uygulayın.
npx rayfin up functions deploy	Aktif uzak öğeye Fonksiyonlar oluşturun, paketleyin ve dağıtın.
npx rayfin up staticapp deploy	Uzak Rayfin öğesine statik içerik oluşturun, paketleyin ve dağıtın.
npx rayfin up connector apply	Bildirilen GraphQL bağlayıcıları için veritabanı yapılandırmasını uygulayın.
npx rayfin up status	Mevcut dağıtım durumunu göster.
npx rayfin up list	Proje için kaydedilen tüm Fabric dağıtımlarını listeleyin.
npx 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 functions deploy

Aktif uzak öğeye Fonksiyonlar oluşturur, paketler ve dağıtır.

Seçenek	Açıklama
--verbose	Ayrıntılı çıkışı göster.
--skip-build	Mevcut Fonksiyon çıktısını inşa etmeden dağıtın.
--json	JSON çıkışı yayımlayın.

rayfin up connector apply

Bildirilen GraphQL bağlayıcıları için veritabanı yapılandırmasını uygular.

Seçenek	Açıklama
--name <name>	Sadece adlandırılmış konnektörü uygulayın.
--verbose	Ayrıntılı çıkışı etkinleştirin.
--json	JSON çıkışı yayımlayın.

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
npx 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