Referencia de CLI de Rayfin

Encuentra los comandos de la CLI de Rayfin para crear proyectos, gestionar cambios de esquema, desplegar en Fabric y configurar la configuración del entorno. Cada sección enumera la sintaxis de los comandos, las opciones y los usos habituales.

Installation

Lo uso npm i @microsoft/rayfin-cli para instalar la CLI.

Cómo empezar

Sigue los pasos de tu terminal para crear una app de 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

Sugerencia

Para proyectos existentes o vacíos, usa npx rayfin init en lugar de npm create añadir Rayfin a un proyecto que ya tenga código fuente o un directorio vacío. El comando init te guía para habilitar servicios, elegir un dialecto de base de datos y configurar alojamiento estático sin andamiar una nueva plantilla.

Para la guía completa, consulta Crea y despliega tu primera app de Fabric con la CLI y Despliega una app Fabric en Fabric.

Andamiaje de un proyecto con npm create

npm create (alias de npm init) Arranca un nuevo proyecto invocando un paquete Create Initializer. Para andamiar una aplicación Fabric, úsala con el inicializador @microsoft/rayfin:

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

Referencia de comandos

Los comandos y flags de este artículo fueron verificados a partir de la salida de ayuda de la CLI instalada localmente.

Comandos de nivel superior

Usa esta tabla para encontrar el comando correcto rápidamente.

Comando Úsela para
rayfin init [directory] Crea o configura un proyecto Rayfin.
rayfin up Despliega la app en Fabric y gestiona despliegues remotos.
rayfin env Genera archivos de entorno específicos del framework a partir de rayfin/.envarchivos de .
rayfin login Inicia sesión en la plataforma Rayfin.
rayfin logout Cierra sesión y borra las credenciales en caché.

Crea o configura un proyecto

rayfin init [directory]

Úsalo rayfin init para añadir Rayfin a un proyecto nuevo o ya existente.

Argument Descripción
--project-name <name> Establece el nombre del proyecto.
-t, --template <uri> Especifica el URI plantilla que vas a usar.
--template-name <name> Selecciona una plantilla por nombre.
-l, --list-templates Lista de plantillas disponibles.
--dialect <dialect> Establece el dialecto de la base de datos.
--services <list> Elige qué servicios habilitar.
--auth-methods <list> Elige métodos de autenticación.
--static-hosting Activa la configuración de alojamiento estático.
--overwrite Sobrescribe los archivos generados existentes.
--workspace-id <id> Usa un ID específico de Fabric workspace.
--workspace-uri <uri> Usa un URI específico de Fabric workspace.
--base-api-url <url> Anula la URL base de la API.
--item-id <id> Apunta a un ID específico de Fabric.

Ejemplos

Enumera las plantillas disponibles antes de montar el andamiaje:

npx rayfin init --list-templates

Inicializa Rayfin en el directorio actual usando una plantilla con nombre y un dialecto específico:

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

Crear un nuevo proyecto no interactivo con servicios y autenticación configurados:

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

Implementación en Fabric

rayfin up

Usa rayfin up para desplegar la aplicación en Fabric como un elemento de Rayfin.

Argument Descripción
--tenant <id> Usa un ID de inquilino específico.
--workspace-id <id> Despliega en un ID específico de espacio de trabajo de Fabric.
--workspace-uri <uri> Despliega en un URI específico de espacio de trabajo de Fabric.
--base-api-url <url> Anula la URL base de la API.
--force Pasos de despliegue forzado cuando sea necesario.
--dry-run Previsualizar las acciones de despliegue sin aplicarlas.
--env-file <path> Carga los valores del entorno desde un archivo.
--verbose Mostrar la salida de despliegue detallada.
--json Devuelve la salida de despliegue en formato JSON.
-y, --yes Acepta las preguntas automáticamente.
--encryption-fallback-enabled Activa el comportamiento de respaldo del cifrado.

Ejemplos

Despliega en el espacio de trabajo de Fabric seleccionado actualmente:

npx rayfin up

Previsualizar las acciones de despliegue sin aplicarlas:

npx rayfin up --dry-run --verbose

Despliega en un espacio de trabajo específico de forma no interactiva:

npx rayfin up --workspace-id 00000000-0000-0000-0000-000000000000 --yes
Subcommand Descripción
rayfin up db apply Genera y aplica la configuración DAB al endpoint remoto de la carga de trabajo de ítems de Rayfin.
rayfin up staticapp deploy Compila, empaqueta y despliega contenido estático en el elemento remoto de Rayfin.
rayfin up status Muestra el estado actual del despliegue.
rayfin up list Enumera todos los despliegues de Fabric grabados para el proyecto.
rayfin up switch [workspace] Cambia el despliegue activo Fabric y reescribe rayfin/.env.

rayfin up db apply

Genera y aplica la configuración DAB al extremo remoto de la carga de trabajo de ítems de Rayfin.

Argument Descripción
--verbose Mostrar resultado detallado.
--force Forzar la regeneración y aplicar configuración.
--json Devuelve la salida en formato JSON.

Ejemplos

Aplicar cambios en la configuración de la base de datos al elemento remoto de Rayfin:

npx rayfin up db apply

Regeneración forzada y captura de salida legible por máquina:

npx rayfin up db apply --force --json

rayfin up staticapp deploy

Construye, empaqueta y despliega contenido estático en el objeto remoto de Rayfin.

Argument Descripción
--verbose Mostrar resultado detallado.
--skip-build Desplega sin ejecutar el paso de compilación.
--json Devuelve la salida en formato JSON.

Ejemplos

Crear y desplegar contenido estático:

npx rayfin up staticapp deploy

Despliega una carpeta preconstruida dist sin volver a ejecutar la compilación:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Muestra el estado del despliegue en la nube.

Argument Descripción
--json Estado de retorno en formato JSON.
--verbose Mostrar resultado detallado.

Ejemplos

Consulta el estado actual del despliegue:

npx rayfin up status

Estado de retorno como JSON para uso en scripts:

npx rayfin up status --json

rayfin up list

Lista todos los despliegues de Fabric registrados para este proyecto.

Argument Descripción
--json Devuelva la lista de despliegue en formato JSON.

Ejemplos

Lista todos los despliegues Fabric registrados para el proyecto:

npx rayfin up list

rayfin up switch [workspace]

Cambia el despliegue activo Fabric y reescribe rayfin/.env en consecuencia.

Argument Descripción
-l, --list Lista los despliegues disponibles sin cambiar.
--no-emit-env Salta escribir archivos de entorno emitidos.

Ejemplos

Lista de despliegues disponibles a los que cambiar:

npx rayfin up switch --list

Cambia el despliegue activo a un espacio de trabajo específico:

npx rayfin up switch my-workspace

Generar archivos de entorno

rayfin env

Usar rayfin env para emitir valores específicos .env.local del marco de rayfin/.env.

Argument Descripción
--framework <vite|nextjs|plain> Elige el formato del framework objetivo.
--output <dir> Escribe archivos generados en un directorio específico.
--show Imprime los valores emitidos sin escribir archivos.

Ejemplos

Genera un Vite-compatible .env.local:

npx rayfin env --framework vite

Vista previa emitió valores de entorno sin escribir archivos:

npx rayfin env --framework nextjs --show

Inicio y cierre de sesión

rayfin login

Úsalo rayfin login para iniciar sesión en la plataforma Rayfin.

Argument Descripción
--tenant <id> Usa un ID de inquilino específico.
--service-principal Intenta iniciar sesión con el principal del servicio. Esta opción aparece en la sección de ayuda pero actualmente no está soportada.
-u, --client-id <id> Proporciona el ID del cliente para iniciar sesión con el principal de servicio. Esta opción aparece en la sección de ayuda pero actualmente no está soportada.
-p, --client-secret <secret> Proporciona al cliente el secreto de inicio de sesión del principal de servicio. Esta opción aparece en la sección de ayuda pero actualmente no está soportada.
--select Selecciona entre cuentas o contextos disponibles con inicio de sesión.
--encryption-fallback-enabled Activa el comportamiento de respaldo del cifrado.

Ejemplos

Inicia sesión de forma interactiva:

npx rayfin login

Inicia sesión con un inquilino específico:

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

Cambiar entre cuentas iniciadas en sesión:

npx rayfin login --select
Subcommand Descripción
rayfin login status Mostrar el estado actual de autenticación.

rayfin login status

Muestra el estado actual de autenticación.

Argument Descripción
Ninguno Este subcomando no muestra ninguna opción en la salida de ayuda de la CLI.

Ejemplo

Comprueba si has iniciado sesión:

npx rayfin login status

rayfin logout

Cierra sesión y borra las credenciales en caché.

Argument Descripción
Ninguno Este comando no muestra ninguna opción en la salida de ayuda de la CLI.

Ejemplo

Cerrar sesión y borrar las credenciales en caché:

npx rayfin logout
  • Last updated on