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
npx rayfin 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
npx rayfin init [directory]	Crea o configura un progetto Rayfin.
npx rayfin connector	Trova, configura, ispeziona e invoca i connettori dati Fabric.
npx rayfin functions init	Impalcatura di un pacchetto Functions.
npx rayfin dev	Esegui l'app e le funzioni localmente.
npx rayfin init ai-files	Installa o controlla i file contestuali degli agenti Rayfin.
npx rayfin up	Distribuisci l'app su Fabric e gestisci le implementazioni remote.
npx rayfin env	Genera file di ambiente specifici per framework da rayfin/.env.
npx rayfin login	Accedi alla piattaforma Rayfin.
npx 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

Comandi di collegamento

Il connector gruppo di comando gestisce le fonti di dati Fabric esterne.

rayfin connector types

Elenca i tipi di connettori che puoi aggiungere a un progetto.

Option	Description
--json	Emetti la lista dei tipi di connettore come JSON.
-v, --verbose	Includi dettagli sulle capacità.

rayfin connector search [query]

Searches Fabric fornisce fonti che l'identità di accesso può aggiungere come connettori.

Argomento o opzione	Description
[query]	Filtro opzionale, insensibile alla maiuscolare, per il nome della sorgente.
--query <text>	Filtro con nome sorgente denominato che ha la precedenza su [query].
--type <type>	Tipi di connettori separati da virgola; richiesti con --workspace-id o --all-workspaces.
--workspace-id <id>	Cerca in uno spazio di lavoro Fabric.
--all-workspaces	Cerca in ogni spazio di lavoro a cui l'identità può accedere.
-y, --yes	Accetta automaticamente il passaggio di messaggi interattivi degli annunci.
--limit <n>	Numero massimo di risultati visualizzati.
--output <interactive\|plain\|json>	Seleziona il formato di output.
--json	Stampa i risultati in JSON e salta il selezionatore interattivo.
-v, --verbose	Abilitare l'output dettagliato.

Quando nessuna delle due opzioni di workspace viene fornita, il comando cerca gli spazi di lavoro registrati per la distribuzione attuale del progetto.

rayfin connector add --type <type>

Aggiunge una dichiarazione di connettore e scaffolda i suoi file di progetto.

Option	Description
--type <type>	Required. Tipo di connettore; uso rayfin connector types per elencare i tipi.
--name <name>	Nome del connettore; derivato dall'elemento quando omesso.
--workspace-id <id>	ID dello spazio di lavoro Fabric.
--item-id <id>	ID Fabric articolo.
--operations <ops>	Sottoinsieme delle operazioni consentite separate da virgole.
-v, --verbose	Abilitare l'output dettagliato.
-y, --yes	Accetta automaticamente le conferme.
--json	Emetti output JSON.

rayfin connector list

Elenca i connettori dichiarati in rayfin.yml.

Option	Description
-v, --verbose	Includere i metadati e le funzionalità dei connettori.
--json	Emetti output JSON.

rayfin connector inspect

Ispeziona un connettore configurato o una sorgente Fabric direttamente indirizzata senza apportare modifiche.

Option	Description
--name <name>	Nome del connettore configurato.
-w, --workspace <name>	Nome dello spazio di lavoro per l'ispezione diretta.
--workspace-id <id>	ID dello spazio di lavoro per ispezione diretta.
--item <name>	Nome dell'oggetto per l'ispezione diretta.
--item-id <id>	ID dell'oggetto per l'ispezione diretta.
--type <type>	Tipo di connettore per ispezione diretta.
--url <url>	URL del portale semantico dei modelli; deriva gli ID dello spazio di lavoro e degli elementi.
--entity <name>	Entità o tabella da campionare; omettere con --query per elencare le entità.
--query <path>	.sql oppure .dax da eseguire in modalità di sola lettura.
--rows <n>	Limite di riga; predefinito a 10 per i campioni ed è limitato a 100.
-v, --verbose	Abilitare l'output dettagliato.
--output <interactive\|plain\|json>	Seleziona il formato di output.
--json	Emetti output JSON.

Utilizzare --name per un connettore configurato, un selettore completo a sorgente diretta o --url per un modello semantico.

rayfin connector invoke [connector-name] [operation]

Invoca un'operazione su un connettore configurato.

Argomento o opzione	Description
[connector-name]	Nome del connettore configurato.
[operation]	Funzionamento del connettore, come executeQuery.
--name <name>	Chiamato alternativa a [connector-name].
--operation <operation>	Chiamato alternativa a [operation].
--input <json>	Input operazione JSON.
--file <path>	File JSON contenente l'input dell'operazione.
--transport <auto\|deployed>	Percorso di invocazione; predefinito su auto.
-v, --verbose	Abilitare l'output dettagliato.
--output <interactive\|plain\|json>	Seleziona il formato di output.
--output-file <path>	Scrivi il risultato completo in un file.
--max-inline-bytes <bytes>	Soglia di dimensione risultata per la scrittura di un file; predefinita è 1 MiB.
--json	Emetti output JSON.

rayfin connector remove <name>

Rimuove una dichiarazione di connettore e i file di connettore generati.

Argomento o opzione	Description
<name>	Required. Nome del connettore da rimuovere.
-v, --verbose	Abilitare l'output dettagliato.
-y, --yes	Accetta automaticamente la conferma della rimozione.
--json	Emetti output JSON.

Comandi di funzione

rayfin functions init [directory]

Crea e configura un pacchetto Functions.

Argomento o opzione	Description
[directory]	Project root; di default alla directory corrente.
--force	Sovrascrivi un impalceggio Functions esistente.
--path <relative-path>	Posizione del pacchetto funzioni rispetto alla radice del progetto.

La posizione del pacchetto si trova di default su una posizione di workspace rilevata o rayfin/functions.

Comandi di sviluppo

rayfin dev [project-path]

Avvia una sessione di sviluppo locale contro un backend Rayfin.

Argomento o opzione	Description
[project-path]	Project root; di default alla directory corrente.
--skip-db-apply	Salta la configurazione automatica del database.
--env-file <path>	.env Utilizzato per rayfin.yml l'interpolazione.
--provider <fabric>	Provider backend; predefinito su fabric.
-w, --workspace <name>	Nome di spazio di lavoro Fabric per un backend di prima esecuzione.
--workspace-id <id>	Fabric workspace ID per un backend di prima esecuzione.
--capacity-id <id>	Fabric capacity ID per uno spazio di lavoro senza capacità utilizzabile.
-t, --tenant <id>	ID tenant di Microsoft Entra
--encryption-fallback-enabled	Consentire la memorizzazione dei token in testo semplice quando non è disponibile la portachiavi del sistema operativo.
--no-emit-env	Non rigenerare il file framework .env.local .
-v, --verbose	Consente la registrazione dettagliata.

rayfin dev functions apply

Avvia l'host locale delle Funzioni contro il deployment attivo.

Option	Description
--port <port>	Porta host di Local Functions; predefinita su 7071.
--inspect-port <port>	Node.js ispettore port; predefinito su 9229.
--no-debug	Disabilita l'ispettore Node.js.
--no-emit-env	Non rigenerare il file framework .env.local .
--verbose	Mostra l'output diagnostico.
--json	Emetti output JSON.
-y, --yes	Corri senza spunti interattivi.

Gestire file di agente

Il rayfin init ai-files comando gestisce i file di contesto dell'agente Rayfin nel tuo progetto: AGENTS.md, .mcp.json, e .agents/skills/rayfin/SKILL.md. La CLI installa questi file automaticamente quando si fa un scaffold su un progetto. Esegui i comandi qui sotto per installarli o aggiornarli in un progetto esistente, oppure controllarne lo stato.

rayfin init ai-files install

Installa o aggiorna i file dell'agente Rayfin. Il comando è idempotente e preserva la configurazione utente esistente.

Option	Description
--enable <id>	Installa o mantieni un elemento specifico con il suo ID con spazio nominale, come skill:rayfin. Ripetibile.
--disable <id>	Smetti di gestire un elemento specifico senza cancellare il suo file. Ripetibile.
--remove-files	Rimuovi il file sul disco quando disabiliti un elemento. Richiede --disable.
--force [ids...]	Sovrascrivi gli elementi modificati, ripristina gli elementi mancanti o ricostruisce i difetti .mcp.json. Accetta ID opzionali con spazio nominale per l'ambito dell'operazione. Non sovrascrive AGENTS.mdmai.
-n, --dry-run	Segnala le modifiche senza scrivere i file.
--json	Emette output strutturato come JSON; implica modalità non interattiva.
-y, --yes, --non-interactive	Salta il prompt interattivo e accetta i valori predefiniti.

Ad esempio, installare i valori predefiniti senza che sia stato richiesto:

npx rayfin init ai-files install --yes

rayfin init ai-files status

Stampa lo stato di ogni file di agente gestito. Usa --json per un output strutturato.

Gli stati possibili includono up-to-date, update-available, user-modified, missing, not-installed, disabled, orphaned, e unreadable. Esegui rayfin init ai-files install per aggiornare i file o rayfin init ai-files install --force <id> per sovrascrivere un elemento gestito specifico.

Eseguire la distribuzione in Fabric

rayfin up

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

Argument	Description
-t, --tenant <id>	Usa un ID tenant specifico.
-w, --workspace <name>	Distribuire in un workspace Fabric per nome; predefinito su My Workspace.
--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.
--item-name <name>	Nome visualizzato dell'elemento Fabric; predefinito sull'ID progetto.
--capacity-id <id>	Fabric capacity ID quando lo spazio di lavoro target ha bisogno di capacità.
--force	Consentire cambiamenti distruttivi nello schema dei dati.
-n, --dry-run	Valida gli input e risolve lo spazio di lavoro senza effettuare il deployment.
--env-file <path>	.env file per le proprietà di deployment; predefinito su rayfin/.env.
-v, --verbose	Abilitare l'output dettagliato.
--json	Restituisci l'output di distribuzione in formato JSON.
-y, --yes	Accetta automaticamente le conferme.
--encryption-fallback-enabled	Consentire la memorizzazione dei token in testo semplice quando non è disponibile la portachiavi del sistema operativo.
--exclude-services <names>	Servizi separati da virgole da saltare durante la costruzione e il deployment: staticHosting oppure functions.
--provider <fabric>	Provider di deployment; predefinito su fabric.

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

Distribuire senza costruire o distribuire funzioni:

npx rayfin up --exclude-services functions

--capacity-id non può essere combinato con --workspace, --workspace-id, o --workspace-uri.

Subcommand	Description
npx rayfin up db apply	Genera e applica la configurazione DAB all'endpoint remoto del carico di lavoro degli item Rayfin.
npx rayfin up functions deploy	Compila, impacchettare e distribuire le Funzioni sull'elemento remoto attivo.
npx rayfin up staticapp deploy	Compila, impacchettare e distribuire contenuti statici sull'oggetto Rayfin remoto.
npx rayfin up connector apply	Applicare la configurazione del database per i connettori GraphQL dichiarati.
npx rayfin up status	Mostra lo stato attuale del dispiegamento.
npx rayfin up list	Elenca tutte le implementazioni Fabric registrate per il progetto.
npx 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 functions deploy

Compila, impacchetta e distribuisce Funzioni sull'elemento remoto attivo.

Option	Description
--verbose	Visualizzare l'output dettagliato.
--skip-build	Distribuire l'output delle funzioni esistenti senza compilare.
--json	Emetti output JSON.

rayfin up connector apply

Applica la configurazione del database per i connettori GraphQL dichiarati.

Option	Description
--name <name>	Applica solo il connettore nominato.
--verbose	Abilitare l'output dettagliato.
--json	Emetti output 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
npx 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