Ссылка на Rayfin CLI

Найдите команды Rayfin CLI для создания проектов, управления изменениями схемы, развертывания в Fabric и настройки настроек среды. В каждом разделе перечислены синтаксис команд, опции и распространённые применения.

Installation

Используйте npm i @microsoft/rayfin-cli для установки CLI.

Начало работы

Следуйте шагам в вашем терминале, чтобы создать приложение 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

Подсказка

Для существующих или пустых проектов используйте npx rayfin init вместо npm create добавления Rayfin в проект, у которого уже есть исходный код или пустая директория. Команда init проводит вас через включение сервисов, выбор диалекта базы данных и настройку статического хостинга без создания нового шаблона.

Для полного прохождения смотрите Создайте и развернуйте ваше первое Fabric приложение с помощью CLI и Развернуть Fabric приложение на Fabric.

Строительные леса — проект с npm create

npm create (псевдоним npm init) запускает новый проект, вызывая пакет Create Initializer. Чтобы создать Fabric приложение, используйте его с инициализатором @microsoft/rayfin:

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

Справочник команд

Команды и флаги в этой статье были проверены из локально установленного справочного вывода CLI.

Команды верхнего уровня

Используйте эту таблицу, чтобы быстро найти нужную команду.

Command	Используйте его для
npx rayfin init [directory]	Создайте или настройте проект Rayfin.
npx rayfin up	Развернуть приложение в Fabric и управлять удалёными развертываниями.
npx rayfin env	Генерируйте специфические для фреймворка файлы среды из rayfin/.env.
npx rayfin login	Войдите на платформу Rayfin.
npx rayfin logout	Выйдите из системы и очистите кэшированные учетные данные.

Создайте или настройте проект

rayfin init [directory]

Используйте rayfin init для добавления Rayfin в новый или существующий проект.

Argument	Description
--project-name <name>	Задайте название проекта.
-t, --template <uri>	Укажите шаблон URI для использования.
--template-name <name>	Выберите шаблон по названию.
-l, --list-templates	Перечислите доступные шаблоны.
--dialect <dialect>	Задайте диалект базы данных.
--services <list>	Выбирайте, какие сервисы включать.
--auth-methods <list>	Выберите методы аутентификации.
--static-hosting	Включите статическую установку хостинга.
--overwrite	Перезапишите существующие сгенерированные файлы.
--workspace-id <id>	Используйте конкретный идентификатор рабочего пространства Fabric.
--workspace-uri <uri>	Используйте конкретный URI Fabric Workspace.
--base-api-url <url>	Переопределите базовый URL API.
--item-id <id>	Нацеливайтесь на конкретный идентификатор предмета Fabric.

Examples

Перечислите доступные шаблоны перед установкой строительных лесов:

npx rayfin init --list-templates

Инициализуйте Rayfin в текущем каталоге, используя именованный шаблон и конкретный диалект:

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

Создайте новый проект без интерактивности с сервисами и налаженной аутентификацией:

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

Развертывание в Fabric

rayfin up

Используйте rayfin up для развертывания приложения в Fabric как элемент Rayfin.

Argument	Description
--tenant <id>	Используйте конкретный идентификатор арендатора.
--workspace-id <id>	Развернуть на конкретный идентификатор рабочего пространства Fabric.
--workspace-uri <uri>	Развернуть его на конкретный URI рабочего пространства Fabric.
--base-api-url <url>	Переопределите базовый URL API.
--force	Шаги по развертыванию войск по мере необходимости.
--dry-run	Просмотр действий развертывания без их применения.
--env-file <path>	Загрузите значения среды из файла.
--verbose	Покажите длинный выход развертывания.
--json	Возврат вывода развертывания в формате JSON.
-y, --yes	Принимайте подсказки автоматически.
--encryption-fallback-enabled	Включите резервное поведение при шифровании.

Examples

Развернуть в выбранном сейчас рабочем пространстве Fabric:

npx rayfin up

Просмотр действий развертывания без их применения:

npx rayfin up --dry-run --verbose

Развернуть в конкретном рабочем пространстве неинтерактивно:

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

Subcommand	Description
npx rayfin up db apply	Сгенерируйте и примените конфигурацию DAB к удалённой конечной точке рабочей нагрузки Rayfin.
npx rayfin up staticapp deploy	Создайте, упаковывайте и развертывайте статический контент в удалённый элемент Rayfin.
npx rayfin up status	Покажите текущий статус развертывания.
npx rayfin up list	Перечислите все развертывания Fabric, зафиксированные для проекта.
npx rayfin up switch [workspace]	Переключите активное Fabric развертывание и перепишите rayfin/.env.

rayfin up db apply

Генерирует и применяет конфигурацию DAB к удалённой конечной точке рабочей нагрузки Rayfin.

Argument	Description
--verbose	Отображение подробных выходных данных.
--force	Регенерируйте силой и применяйте конфигурацию.
--json	Возврат вывода в формате JSON.

Examples

Примените изменения конфигурации базы данных к удалённому элементу Rayfin:

npx rayfin up db apply

Регенерация силы и захват машиночитаемого результата:

npx rayfin up db apply --force --json

rayfin up staticapp deploy

Создаёт, упаковывает и развёртывает статический контент на удалённый предмет Rayfin.

Argument	Description
--verbose	Отображение подробных выходных данных.
--skip-build	Развернуть без запуска этапа сборки.
--json	Возврат вывода в формате JSON.

Examples

Создание и развертывание статического контента:

npx rayfin up staticapp deploy

Развернуть готовую dist папку без повторного запуска сборки:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Отображает статус облачного развертывания.

Argument	Description
--json	Статус возврата в формате JSON.
--verbose	Отображение подробных выходных данных.

Examples

Проверьте текущий статус развертывания:

npx rayfin up status

Статус возврата как JSON для использования в скриптах:

npx rayfin up status --json

rayfin up list

Перечисляет все развертывания Fabric, зафиксированные для этого проекта.

Argument	Description
--json	Вернуть список развертывания в формате JSON.

Examples

Перечислите все зафиксированные развертывания Fabric для проекта:

npx rayfin up list

rayfin up switch [workspace]

Переключает активное Fabric развертывание и переписывает rayfin/.env соответственно.

Argument	Description
-l, --list	Перечислите доступные развертывания без переключения.
--no-emit-env	Пропускайте запись файлов с излучаемой средой.

Examples

Список доступных развертываний для перехода:

npx rayfin up switch --list

Переключите активное развертывание на конкретное рабочее пространство:

npx rayfin up switch my-workspace

Генерировать файлы окружения

rayfin env

Используйте rayfin env для излучения специфических .env.local для фреймворка значений из rayfin/.env.

Argument	Description
--framework <vite|nextjs|plain>	Выберите формат целевого фреймворка.
--output <dir>	Запишите сгенерированные файлы в определённую папку.
--show	Печатьте изданные значения без записи файлов.

Examples

Сгенерировать совместимый .env.localс Vite :

npx rayfin env --framework vite

Предварительный просмотр изданных значений среды без записи файлов:

npx rayfin env --framework nextjs --show

Вход и выход

rayfin login

Используйте rayfin login для входа на платформу Rayfin.

Argument	Description
--tenant <id>	Используйте конкретный идентификатор арендатора.
--service-principal	Попытаться войти в систему по принципу сервиса. Эта опция указана в справке, но сейчас не поддерживается.
-u, --client-id <id>	Укажите идентификатор клиента для входа в систему принципала сервиса. Эта опция указана в справке, но сейчас не поддерживается.
-p, --client-secret <secret>	Предоставьте клиенту секрет для входа в сервис. Эта опция указана в справке, но сейчас не поддерживается.
--select	Выбирайте из доступных аккаунтов или контекстов с авторизацией.
--encryption-fallback-enabled	Включите резервное поведение при шифровании.

Examples

Войдите интерактивно:

npx rayfin login

Войдите в определённый арендатор:

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

Переключение между зарегистрированными аккаунтами:

npx rayfin login --select

Subcommand	Description
npx rayfin login status	Отобразите текущий статус аутентификации.

rayfin login status

Отображает текущий статус аутентификации.

Argument	Description
Нет	В этой подкоманде нет никаких опций в выходе помощи CLI.

Example

Проверьте, зарегистрированы ли вы:

npx rayfin login status

rayfin logout

Выходит из системы и очищает кэшированные учетные данные.

Argument	Description
Нет	Эта команда не содержит никаких опций в выходе помощи CLI.

Example

Выйдите из системы и очистите кэшированные учетные данные:

npx rayfin logout