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
npx rayfin 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
npx rayfin init [directory]	Créer ou configurer un projet Rayfin.
npx rayfin connector	Trouver, configurer, inspecter et invoquer les connecteurs de données Fabric.
npx rayfin functions init	Échafallez un paquet de fonctions.
npx rayfin dev	Exécutez l’application et les fonctions localement.
npx rayfin init ai-files	Installez ou vérifiez les fichiers contextuels de l’agent Rayfin.
npx rayfin up	Déployez l’application sur Fabric et gérez les déploiements à distance.
npx rayfin env	Générez des fichiers d’environnement spécifiques au framework à partir de rayfin/.envfichiers .
npx rayfin login	Connectez-vous à la plateforme Rayfin.
npx 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

Commandes de connecteur

Le connector groupe de commandement gère les sources de données Fabric externes.

rayfin connector types

Liste les types de connecteurs que vous pouvez ajouter à un projet.

Option	Description
--json	Émettez la liste de types de connecteurs sous forme de JSON.
-v, --verbose	Incluez les détails des capacités.

rayfin connector search [query]

Searches Fabric fournit que l’identité connectée peut être ajoutée comme connecteurs.

Argument ou option	Description
[query]	Filtre optionnel, insensible à la majuscule, pour le nom de source.
--query <text>	Filtre nom source nommé qui a la priorité sur [query].
--type <type>	types de connecteurs séparés par virgules ; requis avec --workspace-id ou --all-workspaces.
--workspace-id <id>	Cherchez un espace de travail Fabric.
--all-workspaces	Recherchez dans tous les espaces de travail auxquels l’identité peut accéder.
-y, --yes	Acceptez automatiquement la remise interactive des annonces.
--limit <n>	Nombre maximal de résultats affichés.
--output <interactive\|plain\|json>	Sélectionnez le format de sortie.
--json	Imprimez les résultats en JSON et évitez le selecteur interactif.
-v, --verbose	Activez la sortie détaillée.

Lorsque aucune des options d’espace de travail n’est fournie, la commande recherche les espaces de travail enregistrés pour le déploiement du projet en cours.

rayfin connector add --type <type>

Ajoute une déclaration de connecteur et échafaudage ses fichiers projet.

Option	Description
--type <type>	Obligatoire. Type de connecteur ; utiliser rayfin connector types pour lister les types.
--name <name>	Nom du connecteur ; dérivé de l’élément lorsqu’il est omis.
--workspace-id <id>	ID de l’espace de travail Fabric.
--item-id <id>	ID Fabric article.
--operations <ops>	Sous-ensemble des opérations autorisées séparées par virgule.
-v, --verbose	Activez la sortie détaillée.
-y, --yes	Acceptez automatiquement les confirmations.
--json	Émettez une sortie JSON.

rayfin connector list

Liste les connecteurs déclarés dans rayfin.yml.

Option	Description
-v, --verbose	Incluez les métadonnées et capacités des connecteurs.
--json	Émettez une sortie JSON.

rayfin connector inspect

Inspecte un connecteur configuré ou une source Fabric directement adressée sans effectuer de modifications.

Option	Description
--name <name>	Nom du connecteur configuré.
-w, --workspace <name>	Nom de l’espace de travail pour inspection directe.
--workspace-id <id>	ID de l’espace de travail pour inspection directe.
--item <name>	Nom de l’article pour inspection directe.
--item-id <id>	Identifiant de l’article pour inspection directe.
--type <type>	Type de connecteur pour inspection directe.
--url <url>	URL du portail de modèles sémantique ; dérive les identifiants de l’espace de travail et des éléments.
--entity <name>	Entité ou tableau à échantillonner ; omettre avec --query pour lister les entités.
--query <path>	.sql ou .dax à exécuter en mode lecture seule.
--rows <n>	Limite de ligne ; par défaut est de 10 pour les échantillons et plafonne à 100.
-v, --verbose	Activez la sortie détaillée.
--output <interactive\|plain\|json>	Sélectionnez le format de sortie.
--json	Émettez une sortie JSON.

Utilisez --name pour un connecteur configuré, un sélecteur direct complet ou --url un modèle sémantique.

rayfin connector invoke [connector-name] [operation]

Invoque une opération sur un connecteur configuré.

Argument ou option	Description
[connector-name]	Nom du connecteur configuré.
[operation]	Fonctionnement des connecteurs, tels que executeQuery.
--name <name>	Alternative nommée à [connector-name].
--operation <operation>	Alternative nommée à [operation].
--input <json>	Entrée d’opération JSON.
--file <path>	JSON contenant l’entrée des opérations.
--transport <auto\|deployed>	Chemin d’invocation ; par défaut .auto
-v, --verbose	Activez la sortie détaillée.
--output <interactive\|plain\|json>	Sélectionnez le format de sortie.
--output-file <path>	Écrivez le résultat complet dans un fichier.
--max-inline-bytes <bytes>	Seuil de taille de résultat pour l’écriture d’un fichier ; par défaut à 1 Mio.
--json	Émettez une sortie JSON.

rayfin connector remove <name>

Supprime une déclaration de connecteur et ses fichiers de connecteurs générés.

Argument ou option	Description
<name>	Obligatoire. Nom du connecteur à retirer.
-v, --verbose	Activez la sortie détaillée.
-y, --yes	Acceptez automatiquement la confirmation de suppression.
--json	Émettez une sortie JSON.

Commandes de fonctions

rayfin functions init [directory]

Échafaudage et configuration d’un paquet Functions.

Argument ou option	Description
[directory]	Project root ; par défaut dans le répertoire actuel.
--force	Écraser un échafaudage de Fonctions existant.
--path <relative-path>	L’emplacement du package Functions par rapport à la racine du projet.

L’emplacement du paquet est par défaut un emplacement d’espace de travail détecté ou rayfin/functions.

Commandes de développement

rayfin dev [project-path]

Commence une session de développement local avec un backend Rayfin.

Argument ou option	Description
[project-path]	Project root ; par défaut dans le répertoire actuel.
--skip-db-apply	Ne pas appliquer la configuration automatique de la base de données.
--env-file <path>	.env fichier utilisé pour rayfin.yml l’interpolation.
--provider <fabric>	Fournisseur backend ; par défaut sur fabric.
-w, --workspace <name>	Un nom d’espace de travail Fabric pour un backend en première exécution.
--workspace-id <id>	Fabric Workspace ID pour un backend en première exécution.
--capacity-id <id>	ID de capacité Fabric pour un espace de travail sans capacité utilisable.
-t, --tenant <id>	ID de locataire Microsoft Entra.
--encryption-fallback-enabled	Autoriser le stockage de jetons en clair lorsque le porte-clés du système d’exploitation n’est pas disponible.
--no-emit-env	Ne régénère pas le fichier du framework .env.local .
-v, --verbose	Active la journalisation détaillée.

rayfin dev functions apply

Démarre l’hôte local des fonctions en fonction du déploiement actif.

Option	Description
--port <port>	port hôte Local Functions ; par défaut sur 7071.
--inspect-port <port>	Node.js port d’inspecteur ; par défaut sur 9229.
--no-debug	Désactivez l’inspecteur Node.js.
--no-emit-env	Ne régénère pas le fichier du framework .env.local .
--verbose	Affichez la sortie de diagnostic.
--json	Émettez une sortie JSON.
-y, --yes	Faites sans invites interactifs.

Gérer les fichiers de l’agent

La rayfin init ai-files commande gère les fichiers contextuels de l’agent Rayfin dans votre projet : AGENTS.md, .mcp.json, et .agents/skills/rayfin/SKILL.md. La CLI installe ces fichiers automatiquement lorsque vous échaffaudez un projet. Exécutez les commandes ci-dessous pour les installer ou les rafraîchir dans un projet existant, ou vérifier leur statut.

rayfin init ai-files install

Installe ou rafraîchit les fichiers agents Rayfin. La commande est idempotente et préserve la configuration utilisateur existante.

Option	Description
--enable <id>	Installez ou gardez un élément spécifique par son identifiant namespace, comme skill:rayfin. Répétable.
--disable <id>	Arrêtez de gérer un élément spécifique sans supprimer son fichier. Répétable.
--remove-files	Supprimez le fichier sur disque lors de la désactivation d’un élément. Exige --disable.
--force [ids...]	Écraser les éléments modifiés, restaurer les éléments manquants ou reconstruire les déformés .mcp.json. Accepte les identifiants namespaced optionnels pour définir l’opération. Ne réécrit AGENTS.mdjamais.
-n, --dry-run	Signalez les modifications sans écrire de fichiers.
--json	Émettre une sortie structurée sous forme de JSON ; implique un mode non interactif.
-y, --yes, --non-interactive	Évitez l’invite interactive et acceptez les paramètres par défaut.

Par exemple, installer les paramètres par défaut sans qu’on le demande :

npx rayfin init ai-files install --yes

rayfin init ai-files status

Imprime l’état de chaque fichier d’agent géré. Utilisez --json pour une sortie structurée.

Les états possibles incluent up-to-date, update-available, user-modified, missing, not-installeddisabled, , orphaned, et unreadable. Exécutez rayfin init ai-files install pour rafraîchir les fichiers ou rayfin init ai-files install --force <id> écraser un élément géré spécifique.

Déployer sur Fabric

rayfin up

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

Argument	Description
-t, --tenant <id>	Utilisez un identifiant locataire spécifique.
-w, --workspace <name>	Déploie dans un espace de travail Fabric par nom ; par défaut .My Workspace
--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.
--item-name <name>	Nom d’affichage de l’élément Fabric ; par défaut l’identifiant du projet.
--capacity-id <id>	Fabric capacity ID lorsque l’espace de travail cible a besoin de capacité.
--force	Autoriser des modifications destructives du schéma de données.
-n, --dry-run	Validez les entrées et résolvez l’espace de travail sans déployer.
--env-file <path>	.env file pour les propriétés de déploiement ; par défaut sur rayfin/.env.
-v, --verbose	Activez la sortie détaillée.
--json	Retournez la sortie de déploiement au format JSON.
-y, --yes	Acceptez automatiquement les confirmations.
--encryption-fallback-enabled	Autoriser le stockage de jetons en clair lorsque le porte-clés du système d’exploitation n’est pas disponible.
--exclude-services <names>	Des services séparés par virgules à ignorer lors de la compilation et du déploiement : staticHosting ou functions.
--provider <fabric>	Fournisseur de déploiement ; par défaut sur fabric.

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

Déployer sans construire ni déployer Fonctions :

npx rayfin up --exclude-services functions

--capacity-id ne peut pas être combiné avec --workspace, --workspace-idou --workspace-uri.

Sous-commande	Description
npx rayfin up db apply	Générer et appliquer la configuration DAB au point de terminaison distant de la charge de travail Rayfin.
npx rayfin up functions deploy	Construisez, emballez et déployez des fonctions sur l’élément actif à distance.
npx rayfin up staticapp deploy	Construisez, empaquetez et déployez du contenu statique sur l’élément Rayfin distant.
npx rayfin up connector apply	Appliquer la configuration de la base de données pour les connecteurs GraphQL déclarés.
npx rayfin up status	Affichez l’état actuel du déploiement.
npx rayfin up list	Listez tous les déploiements Fabric enregistrés pour le projet.
npx 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 functions deploy

Construit, empaquete et déploie des fonctions sur l’élément actif à distance.

Option	Description
--verbose	Afficher la sortie détaillée.
--skip-build	Déploie la sortie des fonctions existantes sans construire de service.
--json	Émettez une sortie JSON.

rayfin up connector apply

Applique la configuration de la base de données pour les connecteurs GraphQL déclarés.

Option	Description
--name <name>	Applique uniquement le connecteur nommé.
--verbose	Activez la sortie détaillée.
--json	Émettez une sortie 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
npx 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