Riferimento alla CLI Rayfin

Trova i comandi della CLI di Rayfin per creare progetti, gestire le modifiche dello schema, distribuire su Fabric e configurare le impostazioni dell'ambiente. Ogni sezione elenca la sintassi dei comandi, le opzioni e gli usi comuni.

Installazione

Usalo npm i @microsoft/rayfin-cli per installare la CLI.

Come iniziare

Segui i passaggi nel tuo terminale per creare un'app 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

Suggerimento

Per progetti esistenti o vuoti, usa npx rayfin init invece di npm create aggiungere Rayfin a un progetto che ha già codice sorgente o una directory vuota. Il comando init ti guida nell'abilitazione dei servizi, nella scelta di un dialetto del database e nella configurazione dell'hosting statico senza un nuovo template senza impalcatura.

Per la guida completa, consulta Crea e distribuisci la tua prima app Fabric con la CLI e Distribuisci un'app Fabric su Fabric.

Impalcatura di un progetto con npm create

npm create (alias di npm init) avvia un nuovo progetto invocando un pacchetto create initializer. Per fare impalcatura di un'app Fabric, usala con l'inizializzatore @microsoft/rayfin:

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

Informazioni di riferimento sui comandi

I comandi e i flag in questo articolo sono stati verificati dall'output di aiuto della CLI installato localmente.

Comandi di primo livello

Usa questa tabella per trovare rapidamente il comando giusto.

Comando Usalo per
rayfin init [directory] Crea o configura un progetto Rayfin.
rayfin up Distribuisci l'app su Fabric e gestisci le implementazioni remote.
rayfin env Genera file di ambiente specifici per framework da rayfin/.env.
rayfin login Accedi alla piattaforma Rayfin.
rayfin logout Esci e cancella le credenziali nella cache.

Crea o configura un progetto

rayfin init [directory]

Usalo rayfin init per aggiungere Rayfin a un progetto nuovo o esistente.

Argument Description
--project-name <name> Imposta il nome del progetto.
-t, --template <uri> Specifica l'URI modello da usare.
--template-name <name> Seleziona un modello per nome.
-l, --list-templates Elenca i modelli disponibili.
--dialect <dialect> Imposta il dialetto del database.
--services <list> Scegli quali servizi abilitare.
--auth-methods <list> Scegli i metodi di autenticazione.
--static-hosting Abilita la configurazione dell'hosting statico.
--overwrite Sovrascrivi i file generati esistenti.
--workspace-id <id> Usa un ID specifico dello spazio di lavoro Fabric.
--workspace-uri <uri> Usa un URI specifico per lo spazio di lavoro Fabric.
--base-api-url <url> Sovrascrivi l'URL base dell'API.
--item-id <id> Mira a un ID specifico dell'articolo Fabric.

Examples

Elencare i modelli disponibili prima di fare il preparatore:

npx rayfin init --list-templates

Inizializza Rayfin nella directory corrente usando un template nominato e un dialetto specifico:

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

Crea un nuovo progetto non interattivamente con servizi e autenticazione configurata:

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

Eseguire la distribuzione in Fabric

rayfin up

Usa rayfin up per distribuire l'applicazione su Fabric come elemento Rayfin.

Argument Description
--tenant <id> Usa un ID tenant specifico.
--workspace-id <id> Distribuisci su uno specifico ID di spazio di lavoro Fabric.
--workspace-uri <uri> Distribuisci su un URI specifico dello spazio di lavoro Fabric.
--base-api-url <url> Sovrascrivi l'URL base dell'API.
--force Passaggi di dispiegamento forzato quando necessario.
--dry-run Anteprima le azioni di distribuzione senza applicarle.
--env-file <path> Carica i valori dell'ambiente da un file.
--verbose Mostra output di distribuzione dettagliato.
--json Restituisci l'output di distribuzione in formato JSON.
-y, --yes Accetta automaticamente i prompt.
--encryption-fallback-enabled Abilita il comportamento di riserva della crittografia.

Examples

Distribuisci sullo spazio di lavoro Fabric attualmente selezionato:

npx rayfin up

Anteprima le azioni di distribuzione senza applicarle:

npx rayfin up --dry-run --verbose

Distribuisci in modo non interattivo in uno spazio di lavoro specifico:

npx rayfin up --workspace-id 00000000-0000-0000-0000-000000000000 --yes
Subcommand Description
rayfin up db apply Genera e applica la configurazione DAB all'endpoint remoto del carico di lavoro degli item Rayfin.
rayfin up staticapp deploy Compila, impacchettare e distribuire contenuti statici sull'oggetto Rayfin remoto.
rayfin up status Mostra lo stato attuale del dispiegamento.
rayfin up list Elenca tutte le implementazioni Fabric registrate per il progetto.
rayfin up switch [workspace] Cambia l'attivo Fabric deployment e riscrive rayfin/.env.

rayfin up db apply

Genera e applica la configurazione DAB all'endpoint remoto del carico di lavoro degli item Rayfin.

Argument Description
--verbose Visualizzare l'output dettagliato.
--force Forzare la rigenerazione e applicare la configurazione.
--json Restituisci l'output in formato JSON.

Examples

Applica modifiche alla configurazione del database all'elemento remoto di Rayfin:

npx rayfin up db apply

Rigenerazione forzata e cattura in uscita leggibile da macchina:

npx rayfin up db apply --force --json

rayfin up staticapp deploy

Compila, impacchetta e distribuisce contenuti statici sull'oggetto Rayfin remoto.

Argument Description
--verbose Visualizzare l'output dettagliato.
--skip-build Distribuisci senza eseguire il passaggio di build.
--json Restituisci l'output in formato JSON.

Examples

Costruisci e distribuisci contenuti statici:

npx rayfin up staticapp deploy

Distribuisci una cartella preimpostata dist senza rieseguire la compilazione:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Mostra lo stato della distribuzione cloud.

Argument Description
--json Stato del ritorno in formato JSON.
--verbose Visualizzare l'output dettagliato.

Examples

Controlla lo stato attuale del dispiegamento:

npx rayfin up status

Stato di ritorno come JSON per l'uso negli script:

npx rayfin up status --json

rayfin up list

Elenca tutte le implementazioni Fabric registrate per questo progetto.

Argument Description
--json Restituisci la lista di implementazione in formato JSON.

Examples

Elenca tutte le implementazioni Fabric registrate per il progetto:

npx rayfin up list

rayfin up switch [workspace]

Cambia l'attivo Fabric deployment e riscrive rayfin/.env di conseguenza.

Argument Description
-l, --list Elenca le implementazioni disponibili senza cambiare.
--no-emit-env Saltare la scrittura dei file di ambiente emessi.

Examples

Elenco delle implementazioni disponibili a cui passare:

npx rayfin up switch --list

Sposta il deployment attivo su uno spazio di lavoro specifico:

npx rayfin up switch my-workspace

Generare file di ambiente

rayfin env

Usare rayfin env per emettere valori specifici .env.local del framework da rayfin/.env.

Argument Description
--framework <vite|nextjs|plain> Scegli il formato del framework target.
--output <dir> Scrivi i file generati in una directory specifica.
--show Stampare i valori emessi senza scrivere file.

Examples

Genera un Vite-compatibile .env.local:

npx rayfin env --framework vite

Anteprima emesso i valori ambientali senza scrivere file:

npx rayfin env --framework nextjs --show

Accedere e disconnettersi

rayfin login

Usalo rayfin login per accedere alla piattaforma Rayfin.

Argument Description
--tenant <id> Usa un ID tenant specifico.
--service-principal Prova a effettuare l'accesso al committente del servizio. Questa opzione è elencata nell'aiuto ma attualmente non è supportata.
-u, --client-id <id> Fornisci l'ID client per l'accesso al principale servizio. Questa opzione è elencata nell'aiuto ma attualmente non è supportata.
-p, --client-secret <secret> Fornisci al cliente il segreto per l'accesso principale del servizio. Questa opzione è elencata nell'aiuto ma attualmente non è supportata.
--select Seleziona tra account o contesti logjati disponibili.
--encryption-fallback-enabled Abilita il comportamento di riserva della crittografia.

Examples

Accedi in modo interattivo:

npx rayfin login

Accedi a un inquilino specifico:

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

Passa tra account effettuati l'accesso:

npx rayfin login --select
Subcommand Description
rayfin login status Visualizza lo stato attuale dell'autenticazione.

rayfin login status

Visualizza lo stato attuale dell'autenticazione.

Argument Description
Nessuno Questo sottocomando non elenca alcuna opzione nell'output di aiuto della CLI.

Example

Controlla se sei connesso:

npx rayfin login status

rayfin logout

Disconnette e cancella le credenziali nella cache.

Argument Description
Nessuno Questo comando non elenca alcuna opzione nell'output di aiuto della CLI.

Example

Disconnettiti e cancella le credenziali nella cache:

npx rayfin logout
  • Last updated on