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
npm run 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
rayfin init [directory]	Buat atau konfigurasikan proyek Rayfin.
rayfin up	Sebarkan aplikasi ke Fabric dan kelola penyebaran jarak jauh.
rayfin env	Hasilkan file lingkungan khusus kerangka kerja dari rayfin/.env.
rayfin login	Masuk ke platform Rayfin.
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

Menyebarkan ke Fabric

rayfin up

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

Argument	Description
--tenant <id>	Gunakan ID penyewa tertentu.
--workspace-id <id>	Sebarkan ke ID ruang kerja Fabric tertentu.
--workspace-uri <uri>	Sebarkan ke URI ruang kerja Fabric tertentu.
--base-api-url <url>	Mengganti URL API dasar.
--force	Memaksa langkah-langkah penyebaran saat diperlukan.
--dry-run	Pratinjau tindakan penyebaran tanpa menerapkannya.
--env-file <path>	Muat nilai lingkungan dari file.
--verbose	Tampilkan output penyebaran verbose.
--json	Kembalikan output penyebaran dalam format JSON.
-y, --yes	Terima perintah secara otomatis.
--encryption-fallback-enabled	Aktifkan perilaku penggantian enkripsi.

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

Subcommand	Description
rayfin up db apply	Hasilkan dan terapkan konfigurasi DAB ke titik akhir beban kerja item Rayfin jarak jauh.
rayfin up staticapp deploy	Membangun, mengemas, dan menyebarkan konten statis ke item Rayfin jarak jauh.
rayfin up status	Tampilkan status penyebaran saat ini.
rayfin up list	Cantumkan semua penyebaran Fabric yang direkam untuk proyek.
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 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
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