Referensi CLI Rayfin

Temukan perintah Rayfin CLI untuk membuat proyek, mengelola perubahan skema, menyebarkan ke Fabric, dan mengonfigurasi pengaturan lingkungan. Setiap bagian mencantumkan sintaks perintah, opsi, dan penggunaan umum.

Installation

Gunakan npm i @microsoft/rayfin-cli untuk menginstal CLI.

Memulai Langkah Pertama

Ikuti langkah-langkah di terminal Anda untuk membuat aplikasi 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

Untuk proyek yang ada atau kosong, gunakan npx rayfin init alih-alih npm create untuk menambahkan Rayfin ke proyek yang sudah memiliki kode sumber atau direktori kosong. Perintah init memandu Anda melalui layanan pengaktifan, memilih dialek database, dan mengonfigurasi hosting statis tanpa perancah templat baru.

Untuk panduan lengkap, lihat Membuat dan menyebarkan aplikasi Fabric pertama Anda dengan CLI dan Menyebarkan aplikasi Fabric ke Fabric.

Perancah proyek dengan npm create

npm create (alias dari npm init) bootstrap proyek baru dengan memanggil paket create initializer. Untuk merancah aplikasi Fabric, gunakan dengan inisialisasi @microsoft/rayfin:

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

Referensi perintah

Perintah dan bendera dalam artikel ini diverifikasi dari output bantuan CLI yang diinstal secara lokal.

Perintah tingkat atas

Gunakan tabel ini untuk menemukan perintah yang tepat dengan cepat.

Perintah	Gunakan untuk
npx rayfin init [directory]	Buat atau konfigurasikan proyek Rayfin.
npx rayfin connector	Temukan, konfigurasikan, periksa, dan panggil konektor data Fabric.
npx rayfin functions init	Scaffold paket Fungsi.
npx rayfin dev	Jalankan aplikasi dan Functions secara lokal.
npx rayfin init ai-files	Instal atau periksa file konteks agen Rayfin.
npx rayfin up	Sebarkan aplikasi ke Fabric dan kelola penyebaran jarak jauh.
npx rayfin env	Hasilkan file lingkungan khusus kerangka kerja dari rayfin/.env.
npx rayfin login	Masuk ke platform Rayfin.
npx rayfin logout	Keluar dan hapus kredensial yang di-cache.

Membuat atau mengonfigurasi proyek

rayfin init [directory]

Gunakan rayfin init untuk menambahkan Rayfin ke proyek baru atau yang sudah ada.

Argument	Description
--project-name <name>	Atur nama proyek.
-t, --template <uri>	Tentukan URI templat yang akan digunakan.
--template-name <name>	Pilih templat berdasarkan nama.
-l, --list-templates	Cantumkan templat yang tersedia.
--dialect <dialect>	Atur dialek database.
--services <list>	Pilih layanan mana yang akan diaktifkan.
--auth-methods <list>	Pilih metode autentikasi.
--static-hosting	Aktifkan penyiapan hosting statis.
--overwrite	Menimpa file yang dihasilkan yang ada.
--workspace-id <id>	Gunakan ID ruang kerja Fabric tertentu.
--workspace-uri <uri>	Gunakan URI ruang kerja Fabric tertentu.
--base-api-url <url>	Mengganti URL API dasar.
--item-id <id>	Targetkan ID item Fabric tertentu.

Contoh

Cantumkan templat yang tersedia sebelum perancah:

npx rayfin init --list-templates

Inisialisasi Rayfin di direktori saat ini dengan menggunakan templat bernama dan dialek tertentu:

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

Buat proyek baru secara non-interaktif dengan layanan dan autentikasi yang dikonfigurasi:

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

Perintah konektor

connector Grup perintah mengelola sumber data Fabric eksternal.

rayfin connector types

Menampilkan jenis konektor yang dapat Anda tambahkan ke proyek.

Option	Description
--json	Emisi daftar tipe konektor sebagai JSON.
-v, --verbose	Sertakan detail kemampuan.

rayfin connector search [query]

Mencari sumber Fabric yang dapat ditambahkan sebagai konektor oleh identitas yang dimasukkan.

Argumen atau opsi	Description
[query]	Filter nama sumber opsional tanpa huruf besar/kecil.
--query <text>	Filter nama sumber bernama yang lebih diutamakan dari [query].
--type <type>	Jenis konektor yang dipisahkan koma; diperlukan dengan --workspace-id atau --all-workspaces.
--workspace-id <id>	Cari satu ruang kerja Fabric.
--all-workspaces	Cari setiap workspace yang dapat diakses oleh identitas.
-y, --yes	Secara otomatis menerima transfer add interaktif.
--limit <n>	Jumlah maksimum hasil yang ditampilkan.
--output <interactive\|plain\|json>	Pilih format output.
--json	Cetak hasil sebagai JSON dan lewati pemilih interaktif.
-v, --verbose	Aktifkan keluaran yang lebih rinci.

Ketika tidak ada opsi workspace yang disertakan, perintah ini akan mencari workspace yang tercatat untuk deployment proyek saat ini.

rayfin connector add --type <type>

Menambahkan deklarasi konektor dan menancah file proyeknya.

Option	Description
--type <type>	Required. Jenis konektor; digunakan rayfin connector types untuk mencantumkan tipe.
--name <name>	Nama konektor; diturunkan dari item jika dihilangkan.
--workspace-id <id>	ID ruang kerja Fabric.
--item-id <id>	Fabric item ID.
--operations <ops>	Subset operasi yang diizinkan dipisahkan koma.
-v, --verbose	Aktifkan keluaran yang lebih rinci.
-y, --yes	Terima konfirmasi secara otomatis.
--json	Keluarkan output JSON.

rayfin connector list

Menampilkan konektor yang dideklarasikan dalam rayfin.yml.

Option	Description
-v, --verbose	Sertakan metadata dan kemampuan konektor.
--json	Keluarkan output JSON.

rayfin connector inspect

Memeriksa konektor yang dikonfigurasi atau sumber Fabric yang dialamatkan langsung tanpa melakukan perubahan.

Option	Description
--name <name>	Nama konektor yang dikonfigurasi.
-w, --workspace <name>	Nama workspace untuk inspeksi langsung.
--workspace-id <id>	ID Workspace untuk inspeksi langsung.
--item <name>	Nama barang untuk inspeksi langsung.
--item-id <id>	ID barang untuk pemeriksaan langsung.
--type <type>	Jenis konektor untuk inspeksi langsung.
--url <url>	URL portal model semantik; menurunkan workspace dan ID item.
--entity <name>	Entitas atau tabel untuk disampel; hilangkan dengan --query entitas daftar.
--query <path>	.sql atau .dax file untuk dijalankan dalam mode hanya-baca.
--rows <n>	Batas baris; default 10 untuk sampel dan dibatasi pada 100.
-v, --verbose	Aktifkan keluaran yang lebih rinci.
--output <interactive\|plain\|json>	Pilih format output.
--json	Keluarkan output JSON.

Digunakan --name untuk konektor yang dikonfigurasi, selector sumber langsung lengkap, atau --url untuk model semantik.

rayfin connector invoke [connector-name] [operation]

Memanggil operasi pada konektor yang dikonfigurasi.

Argumen atau opsi	Description
[connector-name]	Nama konektor yang dikonfigurasi.
[operation]	Operasi konektor, seperti executeQuery.
--name <name>	Alternatif bernama dari [connector-name].
--operation <operation>	Alternatif bernama dari [operation].
--input <json>	Input operasi JSON.
--file <path>	File JSON yang berisi input operasi.
--transport <auto\|deployed>	Jalur pemanggilan; default ke auto.
-v, --verbose	Aktifkan keluaran yang lebih rinci.
--output <interactive\|plain\|json>	Pilih format output.
--output-file <path>	Tulis hasil lengkap ke sebuah file.
--max-inline-bytes <bytes>	Ambang batas ukuran hasil untuk menulis file; default adalah 1 MiB.
--json	Keluarkan output JSON.

rayfin connector remove <name>

Menghapus deklarasi konektor dan file konektor yang dihasilkan.

Argumen atau opsi	Description
<name>	Required. Nama konektor untuk dihapus.
-v, --verbose	Aktifkan keluaran yang lebih rinci.
-y, --yes	Terima konfirmasi penghapusan secara otomatis.
--json	Keluarkan output JSON.

Perintah Functions

rayfin functions init [directory]

Membuat perancah dan mengonfigurasi paket Fungsi.

Argumen atau opsi	Description
[directory]	Project root; secara default ke direktori saat ini.
--force	Timpa scaffold Functions yang sudah ada.
--path <relative-path>	Lokasi paket fungsi relatif terhadap root proyek.

Lokasi paket secara default adalah lokasi workspace yang terdeteksi atau rayfin/functions.

Perintah pengembangan

rayfin dev [project-path]

Memulai sesi pengembangan lokal melawan backend Rayfin.

Argumen atau opsi	Description
[project-path]	Project root; secara default ke direktori saat ini.
--skip-db-apply	Lewati konfigurasi database otomatis berlaku.
--env-file <path>	.env file yang digunakan untuk rayfin.yml interpolasi.
--provider <fabric>	Penyedia backend; default ke fabric.
-w, --workspace <name>	Nama workspace Fabric untuk backend yang pertama kali dijalankan.
--workspace-id <id>	ID ruang kerja Fabric untuk backend pertama kali.
--capacity-id <id>	Fabric capacity ID untuk ruang kerja tanpa kapasitas yang dapat digunakan.
-t, --tenant <id>	ID penyewa Microsoft Entra.
--encryption-fallback-enabled	Izinkan penyimpanan token plaintext ketika tidak ada keychain OS yang tersedia.
--no-emit-env	Jangan regenerasi file framework .env.local .
-v, --verbose	Aktifkan pengelogan verbose.

rayfin dev functions apply

Memulai host Functions lokal terhadap deployment aktif.

Option	Description
--port <port>	Port host Fungsi Lokal; default ke 7071.
--inspect-port <port>	Node.js port inspector; default ke 9229.
--no-debug	Nonaktifkan Node.js inspector.
--no-emit-env	Jangan regenerasi file framework .env.local .
--verbose	Tampilkan output diagnostik.
--json	Keluarkan output JSON.
-y, --yes	Jalankan tanpa prompt interaktif.

Kelola file agen

Perintah ini rayfin init ai-files mengelola file konteks agen Rayfin di proyek Anda: AGENTS.md, , .mcp.jsondan .agents/skills/rayfin/SKILL.md. CLI menginstal file-file ini secara otomatis saat Anda melakukan scaffolding pada sebuah proyek. Jalankan perintah di bawah ini untuk menginstal atau menyegarkannya dalam proyek yang sudah ada, atau memeriksa statusnya.

rayfin init ai-files install

Menginstal atau menyegarkan file agen Rayfin. Perintah ini bersifat idempoten dan mempertahankan konfigurasi pengguna yang sudah ada.

Option	Description
--enable <id>	Instal atau pertahankan item tertentu dengan ID berspasi nama, seperti skill:rayfin. Berulang.
--disable <id>	Berhenti mengelola item tertentu tanpa menghapus filenya. Berulang.
--remove-files	Hapus file di disk saat menonaktifkan sebuah item. Membutuhkan --disable.
--force [ids...]	Timpa item yang dimodifikasi, pulihkan item yang hilang, atau bangun kembali yang cacat .mcp.json. Menerima ID berspasi nama opsional untuk mencakupan operasi. Tidak pernah menimpa AGENTS.md.
-n, --dry-run	Laporkan perubahan tanpa menulis file.
--json	Keluarkan output terstruktur sebagai JSON; mengimplikasikan mode non-interaktif.
-y, --yes, --non-interactive	Lewati prompt interaktif dan terima default.

Misalnya, instalasi default tanpa meminta permintaan:

npx rayfin init ai-files install --yes

rayfin init ai-files status

Mencetak status setiap file agen yang dikelola. Gunakan --json untuk output terstruktur.

Keadaan yang mungkin meliputi up-to-date, update-available, user-modified, missing, orphanednot-installeddisableddan .unreadable Jalankan rayfin init ai-files install untuk menyegarkan file atau rayfin init ai-files install --force <id> menimpa item yang dikelola tertentu.

Menyebarkan ke Fabric

rayfin up

Gunakan rayfin up untuk menyebarkan aplikasi ke Fabric sebagai item Rayfin.

Argument	Description
-t, --tenant <id>	Gunakan ID penyewa tertentu.
-w, --workspace <name>	Sebarkan ke workspace Fabric berdasarkan nama; secara default adalah My Workspace.
--workspace-id <id>	Sebarkan ke ID ruang kerja Fabric tertentu.
--workspace-uri <uri>	Sebarkan ke URI ruang kerja Fabric tertentu.
--item-name <name>	Nama tampilan item Fabric; secara default menggunakan ID proyek.
--capacity-id <id>	Fabric capacity ID ketika workspace target membutuhkan kapasitas.
--force	Izinkan perubahan skema data yang destruktif.
-n, --dry-run	Validasi input dan selesaikan workspace tanpa deployment.
--env-file <path>	.env file untuk properti deployment; default ke rayfin/.env.
-v, --verbose	Aktifkan keluaran yang lebih rinci.
--json	Kembalikan output penyebaran dalam format JSON.
-y, --yes	Terima konfirmasi secara otomatis.
--encryption-fallback-enabled	Izinkan penyimpanan token plaintext ketika tidak ada keychain OS yang tersedia.
--exclude-services <names>	Layanan yang dipisahkan koma untuk dilewati selama pembangunan dan penerapan: staticHosting atau functions.
--provider <fabric>	Penyedia deployment; default ke fabric.

Contoh

Sebarkan ke ruang kerja Fabric yang saat ini dipilih:

npx rayfin up

Pratinjau tindakan penyebaran tanpa menerapkannya:

npx rayfin up --dry-run --verbose

Sebarkan ke ruang kerja tertentu secara non-interaktif:

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

Deploy tanpa membangun atau menerapkan Fungsi:

npx rayfin up --exclude-services functions

--capacity-id tidak dapat dikombinasikan dengan --workspace, --workspace-id, atau --workspace-uri.

Subcommand	Description
npx rayfin up db apply	Hasilkan dan terapkan konfigurasi DAB ke titik akhir beban kerja item Rayfin jarak jauh.
npx rayfin up functions deploy	Bangun, paketkan, dan terapkan Fungsi ke item remote aktif.
npx rayfin up staticapp deploy	Membangun, mengemas, dan menyebarkan konten statis ke item Rayfin jarak jauh.
npx rayfin up connector apply	Terapkan konfigurasi basis data untuk konektor GraphQL yang dideklarasikan.
npx rayfin up status	Tampilkan status penyebaran saat ini.
npx rayfin up list	Cantumkan semua penyebaran Fabric yang direkam untuk proyek.
npx rayfin up switch [workspace]	Alihkan penyebaran Fabric aktif dan tulis ulang rayfin/.env.

rayfin up db apply

Menghasilkan dan menerapkan konfigurasi DAB ke titik akhir beban kerja item Rayfin jarak jauh.

Argument	Description
--verbose	Tampilkan output verbose.
--force	Paksa regenerasi dan terapkan konfigurasi.
--json	Kembalikan output dalam format JSON.

Contoh

Terapkan perubahan konfigurasi database ke item Rayfin jarak jauh:

npx rayfin up db apply

Paksa regenerasi dan tangkap output yang dapat dibaca mesin:

npx rayfin up db apply --force --json

rayfin up functions deploy

Membangun, mengemas, dan mendistribusikan Fungsi ke item remote aktif.

Option	Description
--verbose	Tampilkan output verbose.
--skip-build	Terapkan output Functions yang sudah ada tanpa membangun.
--json	Keluarkan output JSON.

rayfin up connector apply

Menerapkan konfigurasi basis data untuk konektor GraphQL yang dideklarasikan.

Option	Description
--name <name>	Terapkan hanya konektor yang disebutkan.
--verbose	Aktifkan keluaran yang lebih rinci.
--json	Keluarkan output JSON.

rayfin up staticapp deploy

Membangun, mengemas, dan menyebarkan konten statis ke item Rayfin jarak jauh.

Argument	Description
--verbose	Tampilkan output verbose.
--skip-build	Sebarkan tanpa menjalankan langkah build.
--json	Kembalikan output dalam format JSON.

Contoh

Membangun dan menyebarkan konten statis:

npx rayfin up staticapp deploy

Menyebarkan folder bawaan dist tanpa menjalankan ulang build:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Menampilkan status penyebaran cloud.

Argument	Description
--json	Mengembalikan status dalam format JSON.
--verbose	Tampilkan output verbose.

Contoh

Periksa status penyebaran saat ini:

npx rayfin up status

Mengembalikan status sebagai JSON untuk digunakan dalam skrip:

npx rayfin up status --json

rayfin up list

Mencantumkan semua penyebaran Fabric yang direkam untuk proyek ini.

Argument	Description
--json	Kembalikan daftar penyebaran dalam format JSON.

Contoh

Cantumkan semua penyebaran Fabric yang direkam untuk proyek:

npx rayfin up list

rayfin up switch [workspace]

Mengalihkan penyebaran Fabric aktif dan menulis ulang rayfin/.env yang sesuai.

Argument	Description
-l, --list	Cantumkan penyebaran yang tersedia tanpa beralih.
--no-emit-env	Lewati penulisan file lingkungan yang dipancarkan.

Contoh

Daftar penyebaran yang tersedia untuk beralih:

npx rayfin up switch --list

Mengalihkan penyebaran aktif ke ruang kerja tertentu:

npx rayfin up switch my-workspace

Hasilkan file lingkungan

rayfin env

Gunakan rayfin env untuk memancarkan nilai khusus .env.local kerangka kerja dari rayfin/.env.

Argument	Description
--framework <vite|nextjs|plain>	Pilih format kerangka kerja target.
--output <dir>	Tulis file yang dihasilkan ke direktori tertentu.
--show	Cetak nilai yang dipancarkan tanpa menulis file.

Contoh

Hasilkan Vite-kompatibel .env.local:

npx rayfin env --framework vite

Pratinjau nilai lingkungan yang dipancarkan tanpa menulis file:

npx rayfin env --framework nextjs --show

Masuk dan keluar

rayfin login

Gunakan rayfin login untuk masuk ke platform Rayfin.

Argument	Description
--tenant <id>	Gunakan ID penyewa tertentu.
--service-principal	Coba masuk perwakilan layanan. Opsi ini tercantum dalam bantuan, tetapi saat ini tidak didukung.
-u, --client-id <id>	Berikan ID klien untuk masuk perwakilan layanan. Opsi ini tercantum dalam bantuan, tetapi saat ini tidak didukung.
-p, --client-secret <secret>	Berikan rahasia klien untuk masuk perwakilan layanan. Opsi ini tercantum dalam bantuan, tetapi saat ini tidak didukung.
--select	Pilih dari akun atau konteks login yang tersedia.
--encryption-fallback-enabled	Aktifkan perilaku penggantian enkripsi.

Contoh

Masuk secara interaktif:

npx rayfin login

Masuk ke penyewa tertentu:

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

Beralih di antara akun yang login:

npx rayfin login --select

Subcommand	Description
npx rayfin login status	Tampilkan status autentikasi saat ini.

rayfin login status

Menampilkan status autentikasi saat ini.

Argument	Description
None	Subperintah ini tidak mencantumkan opsi apa pun dalam output bantuan CLI.

Example

Periksa apakah Anda login:

npx rayfin login status

rayfin logout

Keluar dan menghapus kredensial yang di-cache.

Argument	Description
None	Perintah ini tidak mencantumkan opsi apa pun dalam output bantuan CLI.

Example

Keluar dan hapus kredensial yang di-cache:

npx rayfin logout