Référence CLI Rayfin

Trouvez les commandes CLI Rayfin pour créer des projets, gérer les modifications de schéma, déployer sur Fabric et configurer les paramètres de l’environnement. Chaque section liste la syntaxe des commandes, les options et les usages courants.

Installation

Je l’utilise npm i @microsoft/rayfin-cli pour installer la ligne de commande.

Premiers pas

Suivez les étapes de votre terminal pour créer une application 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

Conseil / Astuce

Pour les projets existants ou vides, utilisez npx rayfin init plutôt que npm create pour ajouter Rayfin à un projet qui a déjà du code source ou un répertoire vide. La commande init vous guide dans l’activation des services, le choix d’un dialecte de base de données et la configuration de l’hébergement statique sans échaffrager un nouveau modèle.

Pour la solution complète, consultez Créer et déployer votre première application Fabric avec la CLI et Déployer une application Fabric sur Fabric.

Échafaudez un projet avec npm create

npm create (alias de npm init) démarre un nouveau projet en invoquant un package d’initialisation create. Pour enchauffer une application Fabric, utilisez-la avec l’initialiseur @microsoft/rayfin :

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

Référence de commande

Les commandes et drapeaux de cet article ont été vérifiés à partir de la sortie d’aide CLI installée localement.

Commandes de niveau supérieur

Utilisez cette table pour trouver rapidement la bonne commande.

Command	Utilisez-le pour
rayfin init [directory]	Créer ou configurer un projet Rayfin.
rayfin up	Déployez l’application sur Fabric et gérez les déploiements à distance.
rayfin env	Générez des fichiers d’environnement spécifiques au framework à partir de rayfin/.envfichiers .
rayfin login	Connectez-vous à la plateforme Rayfin.
rayfin logout	Déconnectez-vous et effacez les identifiants mis en cache.

Créer ou configurer un projet

rayfin init [directory]

À utiliser rayfin init pour ajouter Rayfin à un projet nouveau ou existant.

Argument	Description
--project-name <name>	Définissez le nom du projet.
-t, --template <uri>	Spécifiez l’URI du modèle à utiliser.
--template-name <name>	Sélectionnez un modèle par nom.
-l, --list-templates	Listez les modèles disponibles.
--dialect <dialect>	Définissez le dialecte de la base de données.
--services <list>	Choisissez quels services vous pouvez activer.
--auth-methods <list>	Choisissez les méthodes d’authentification.
--static-hosting	Activez la configuration statique de l’hébergement.
--overwrite	Écraser les fichiers générés existants.
--workspace-id <id>	Utilisez un identifiant spécifique d’espace de travail Fabric.
--workspace-uri <uri>	Utilisez un URI spécifique pour un espace de travail Fabric.
--base-api-url <url>	Écraser l’URL de base de l’API.
--item-id <id>	Ciblez un identifiant spécifique d’article Fabric.

Exemples

Listez les modèles disponibles avant l’échafaudage :

npx rayfin init --list-templates

Initialisez Rayfin dans le répertoire actuel en utilisant un modèle nommé et un dialecte spécifique :

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

Créer un nouveau projet de manière non interactive avec les services et l’authentification configurés :

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

Déployer sur Fabric

rayfin up

Utilisez rayfin up pour déployer l’application en Fabric en tant qu’élément Rayfin.

Argument	Description
--tenant <id>	Utilisez un identifiant locataire spécifique.
--workspace-id <id>	Déploie sur un identifiant spécifique d’espace de travail Fabric.
--workspace-uri <uri>	Déploie sur une URI spécifique de l’espace de travail Fabric.
--base-api-url <url>	Écraser l’URL de base de l’API.
--force	Étapes de déploiement de force lorsque nécessaire.
--dry-run	Prévisualisez les actions de déploiement sans les appliquer.
--env-file <path>	Chargez les valeurs de l’environnement à partir d’un fichier.
--verbose	Affichez une sortie de déploiement détaillée.
--json	Retournez la sortie de déploiement au format JSON.
-y, --yes	Accepte automatiquement les invites.
--encryption-fallback-enabled	Activez le comportement de secours du chiffrement.

Exemples

Déploiement dans l’espace de travail Fabric actuellement sélectionné :

npx rayfin up

Prévisualisez les actions de déploiement sans les appliquer :

npx rayfin up --dry-run --verbose

Déployez dans un espace de travail spécifique de manière non interactive :

npx rayfin up --workspace-id 00000000-0000-0000-0000-000000000000 --yes

Sous-commande	Description
rayfin up db apply	Générer et appliquer la configuration DAB au point de terminaison distant de la charge de travail Rayfin.
rayfin up staticapp deploy	Construisez, empaquetez et déployez du contenu statique sur l’élément Rayfin distant.
rayfin up status	Affichez l’état actuel du déploiement.
rayfin up list	Listez tous les déploiements Fabric enregistrés pour le projet.
rayfin up switch [workspace]	Changez le déploiement de Fabric actif et réécrivez rayfin/.env.

rayfin up db apply

Génère et applique la configuration DAB au point de terminaison distant de la charge de travail Rayfin.

Argument	Description
--verbose	Afficher la sortie détaillée.
--force	Force régénération et application de configuration.
--json	Retour de sortie au format JSON.

Exemples

Appliquez des modifications de configuration de base de données à l’élément Rayfin distant :

npx rayfin up db apply

Régénération de force et capture de sortie lisible par machine :

npx rayfin up db apply --force --json

rayfin up staticapp deploy

Construit, empaquete et déploie du contenu statique sur l’objet Rayfin distant.

Argument	Description
--verbose	Afficher la sortie détaillée.
--skip-build	Déploie sans lancer l’étape de build.
--json	Retour de sortie au format JSON.

Exemples

Créez et déployez du contenu statique :

npx rayfin up staticapp deploy

Déploie un dossier préconstruit dist sans relancer la compilation :

npx rayfin up staticapp deploy --skip-build

rayfin up status

Affiche l’état du déploiement cloud.

Argument	Description
--json	Statut de retour au format JSON.
--verbose	Afficher la sortie détaillée.

Exemples

Vérifiez le statut actuel du déploiement :

npx rayfin up status

Retour du statut en JSON pour utilisation dans les scripts :

npx rayfin up status --json

rayfin up list

Liste tous les déploiements Fabric enregistrés pour ce projet.

Argument	Description
--json	Retournez la liste de déploiement au format JSON.

Exemples

Listez tous les déploiements Fabric enregistrés pour le projet :

npx rayfin up list

rayfin up switch [workspace]

Commute le Fabric actif de déploiement et réécrit rayfin/.env en conséquence.

Argument	Description
-l, --list	Listez les déploiements disponibles sans changer.
--no-emit-env	Ignorez l’écriture des fichiers d’environnement émis.

Exemples

Liste des déploiements disponibles à adopter :

npx rayfin up switch --list

Transférez le déploiement actif vers un espace de travail spécifique :

npx rayfin up switch my-workspace

Générer des fichiers d’environnement

rayfin env

Utiliser rayfin env pour émettre des valeurs spécifiques .env.local au cadre à partir de rayfin/.env.

Argument	Description
--framework <vite|nextjs|plain>	Choisissez le format du framework cible.
--output <dir>	Écrivez les fichiers générés dans un répertoire spécifique.
--show	Imprimez les valeurs émises sans écrire de fichiers.

Exemples

Générer un Vite-compatible .env.local:

npx rayfin env --framework vite

Aperçu a émis les valeurs d’environnement sans écrire de fichiers :

npx rayfin env --framework nextjs --show

Se connecter et se déconnecter

rayfin login

Utilisez-les rayfin login pour me connecter à la plateforme Rayfin.

Argument	Description
--tenant <id>	Utilisez un identifiant locataire spécifique.
--service-principal	Essayez de vous connecter au principal du service. Cette option est listée dans l’aide mais n’est pas actuellement prise en charge.
-u, --client-id <id>	Fournissez l’identifiant client pour la connexion du principal de service. Cette option est listée dans l’aide mais n’est pas actuellement prise en charge.
-p, --client-secret <secret>	Fournir au client la signature du principal secret pour service. Cette option est listée dans l’aide mais n’est pas actuellement prise en charge.
--select	Sélectionnez parmi les comptes ou contextes connectés disponibles.
--encryption-fallback-enabled	Activez le comportement de secours du chiffrement.

Exemples

Connectez-vous de façon interactive :

npx rayfin login

Connectez-vous à un locataire spécifique :

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

Passez d’un compte connecté à l’autre :

npx rayfin login --select

Sous-commande	Description
rayfin login status	Affichez le statut actuel de l’authentification.

rayfin login status

Affiche le statut actuel de l’authentification.

Argument	Description
None	Cette sous-commande n’indique aucune option dans la sortie d’aide de la CLI.

Example

Vérifiez si vous êtes connecté :

npx rayfin login status

rayfin logout

Se déconnecte et efface les identifiants mis en cache.

Argument	Description
None	Cette commande ne liste aucune option dans la sortie d’aide de la CLI.

Example

Déconnectez-vous et effacez les identifiants mis en cache :

npx rayfin logout