Ссылка на 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
npx rayfin 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 connector	Найдите, настраивайте, проверяйте и вызывайте разъёмы данных Fabric.
npx rayfin functions init	Scaffold a Functions пакет.
npx rayfin dev	Запускайте приложение и функции локально.
npx rayfin init ai-files	Установите или проверьте контекстные файлы агента 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

Команды разъёма

connector Командная группа управляет внешними источниками данных Fabric.

rayfin connector types

Перечисляет типы коннекторов, которые можно добавить в проект.

Опция	Description
--json	Издайте список типов разъёмов как JSON.
-v, --verbose	Включите детали возможностей.

rayfin connector search [query]

Ищет источники Fabric, которые авторизованная идентичность может добавить в качестве соединителей.

Аргумент или вариант	Description
[query]	Необязательный, не чувствительный к регистру фильтр имени источника.
--query <text>	Назначенный фильтр по имени источника, который имеет приоритет над [query].
--type <type>	Типы разъёмов с разделёнными запятыми; требуются с --workspace-id или --all-workspaces.
--workspace-id <id>	Ищите одно рабочее пространство Fabric.
--all-workspaces	Ищите каждое рабочее пространство, к которому доступна личность.
-y, --yes	Автоматически принимайте интерактивную передачу добавления.
--limit <n>	Максимальное количество отображаемых результатов.
--output <interactive\|plain\|json>	Выберите формат вывода.
--json	Печатайте результаты в формате JSON и пропускайте интерактивный picker.
-v, --verbose	Включите подробный вывод.

Когда ни одна из опций рабочего пространства не предоставляется, команда ищет рабочие пространства, записанные для текущего развертывания проекта.

rayfin connector add --type <type>

Добавляет декларацию коннектора и подсказывает свои проектные файлы.

Опция	Description
--type <type>	Обязательно. Тип разъёма; используйте rayfin connector types для перечисления типов.
--name <name>	Имя разъёма; получено от элемента при опускении.
--workspace-id <id>	Fabric workspace ID.
--item-id <id>	Fabric item ID.
--operations <ops>	Подмножество разрешённых операций с разделёнными по запятой.
-v, --verbose	Включите подробный вывод.
-y, --yes	Автоматически принимайте подтверждения.
--json	Излучайте выход JSON.

rayfin connector list

Перечисляет разъёмы, объявленные в rayfin.yml.

Опция	Description
-v, --verbose	Включите метаданные и возможности разъёма.
--json	Излучайте выход JSON.

rayfin connector inspect

Проверяет настроенный разъём или напрямую адресованный источник Fabric без изменений.

Опция	Description
--name <name>	Настроенное имя разъёма.
-w, --workspace <name>	Название рабочего пространства для прямого осмотра.
--workspace-id <id>	Идентификатор рабочего пространства для прямого осмотра.
--item <name>	Название товара для прямого осмотра.
--item-id <id>	Идентификатор предмета для прямого осмотра.
--type <type>	Тип разъёма для прямого осмотра.
--url <url>	URL портала семантической модели; выводит идентификаторы рабочего пространства и элементов.
--entity <name>	Сущность или таблица для выборки; опустить с --query перечислять сущности.
--query <path>	.sql или .dax файл для выполнения в режиме только чтения.
--rows <n>	Лимит строк; по умолчанию для сэмплав 10 и ограничен 100.
-v, --verbose	Включите подробный вывод.
--output <interactive\|plain\|json>	Выберите формат вывода.
--json	Излучайте выход JSON.

Используйте --name для настроенного разъёма, полного прямого селектора или --url для семантической модели.

rayfin connector invoke [connector-name] [operation]

Вызывает операцию на настроенном разъёме.

Аргумент или вариант	Description
[connector-name]	Настроенное имя разъёма.
[operation]	Работа разъёма, например executeQuery.
--name <name>	Назван альтернативой [connector-name].
--operation <operation>	Назван альтернативой [operation].
--input <json>	Ввод операции JSON.
--file <path>	JSON-файл, содержащий ввод операции.
--transport <auto\|deployed>	путь вызова; по умолчанию — auto.
-v, --verbose	Включите подробный вывод.
--output <interactive\|plain\|json>	Выберите формат вывода.
--output-file <path>	Запишите полный результат в файл.
--max-inline-bytes <bytes>	Порог размера результата для записи файла; по умолчанию 1 МиБ.
--json	Излучайте выход JSON.

rayfin connector remove <name>

Удаляет объявление разъёма и сгенерированные им файлы разъёмов.

Аргумент или вариант	Description
<name>	Обязательно. Имя разъёма нужно удалить.
-v, --verbose	Включите подробный вывод.
-y, --yes	Автоматически принимайте подтверждение удаления.
--json	Излучайте выход JSON.

Команды функций

rayfin functions init [directory]

Создаёт и настраивает пакет функций.

Аргумент или вариант	Description
[directory]	Project root; по умолчанию — текущий каталог.
--force	Перезапишите существующий каркас Functions.
--path <relative-path>	Расположение пакета функций относительно корня проекта.

Местоположение пакета по умолчанию определяется как обнаруженное рабочее пространство или rayfin/functions.

Команды разработки

rayfin dev [project-path]

Начинает локальную сессию разработки против бэкенда Rayfin.

Аргумент или вариант	Description
[project-path]	Project root; по умолчанию — текущий каталог.
--skip-db-apply	Пропустить применение автоматической настройки базы данных.
--env-file <path>	.env Файл, используемый для rayfin.yml интерполяции.
--provider <fabric>	Бэкенд-провайдер; по умолчанию — fabric.
-w, --workspace <name>	Название Fabric workspace для бэкенда для первого запуска.
--workspace-id <id>	Fabric workspace ID для бэкенда для первого запуска.
--capacity-id <id>	Fabric capacity ID для рабочего пространства без используемой ёмкости.
-t, --tenant <id>	Идентификатор клиента Microsoft Entra.
--encryption-fallback-enabled	Разрешить хранение токенов в открытом тексте, когда связка ключей ОС недоступна.
--no-emit-env	Не перегенерируйте фреймворк-файл .env.local .
-v, --verbose	Включите подробное логирование.

rayfin dev functions apply

Запускает локальный хост функций против активного развертывания.

Опция	Description
--port <port>	порт локальных функций; по умолчанию — 7071.
--inspect-port <port>	Node.js инспекторский порт; по умолчанию установлен .9229
--no-debug	Отключите Node.js инспектора.
--no-emit-env	Не перегенерируйте фреймворк-файл .env.local .
--verbose	Покажите диагностический выход.
--json	Излучайте выход JSON.
-y, --yes	Запустите без интерактивных подсказок.

Управление файлами агентов

Команда rayfin init ai-files управляет контекстными файлами агента Rayfin в вашем проекте: AGENTS.md, .mcp.json, и .agents/skills/rayfin/SKILL.md. CLI автоматически устанавливает эти файлы при создании проекта. Выполните команды ниже, чтобы установить или обновить их в существующем проекте, либо проверить их статус.

rayfin init ai-files install

Устанавливает или обновляет файлы агента Rayfin. Команда является идемпотентной и сохраняет существующую пользовательскую конфигурацию.

Опция	Description
--enable <id>	Установите или оставьте конкретный элемент по его ID в пространстве, например skill:rayfin. Повторяемые.
--disable <id>	Перестаньте управлять конкретным элементом без удаления его файла. Повторяемые.
--remove-files	Удалите файл с диска при отключении элемента. Требует использования --disable.
--force [ids...]	Перезаписывайте модифицированные элементы, восстанавливайте пропавшие или восстанавливайте деформированные .mcp.json. Принимает опциональные идентификаторы с пространственными именами для масштаба операции. Никогда не перезаписывает AGENTS.md.
-n, --dry-run	Сообщайте об изменениях, не записывая файлы.
--json	Излучать структурированный выход в формате JSON; подразумевает неинтерактивный режим.
-y, --yes, --non-interactive	Пропустите интерактивный запрос и примите настройки по умолчанию.

Например, установите настройки по умолчанию без подсказки:

npx rayfin init ai-files install --yes

rayfin init ai-files status

Печатает состояние каждого управляемого файла агента. Использование --json для структурированного вывода.

Возможные состояния включают up-to-date, update-available, user-modified, missing, disablednot-installedorphanedи unreadable. Запускайте rayfin init ai-files install для обновления файлов или rayfin init ai-files install --force <id> перезаписи конкретного управляемого элемента.

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

rayfin up

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

Argument	Description
-t, --tenant <id>	Используйте конкретный идентификатор арендатора.
-w, --workspace <name>	Развернуть в рабочее пространство Fabric по названию; по умолчанию .My Workspace
--workspace-id <id>	Развернуть на конкретный идентификатор рабочего пространства Fabric.
--workspace-uri <uri>	Развернуть его на конкретный URI рабочего пространства Fabric.
--item-name <name>	Отображаемое имя элемента Fabric; по умолчанию используется идентификатор проекта.
--capacity-id <id>	Fabric capacity ID, когда целевому рабочему пространству нужна емкость.
--force	Разрешить разрушительные изменения схемы данных.
-n, --dry-run	Проверяйте входные данные и разрешайте рабочее пространство без развертывания.
--env-file <path>	.env для свойств развертывания; по умолчанию — rayfin/.env.
-v, --verbose	Включите подробный вывод.
--json	Возврат вывода развертывания в формате JSON.
-y, --yes	Автоматически принимайте подтверждения.
--encryption-fallback-enabled	Разрешить хранение токенов в открытом тексте, когда связка ключей ОС недоступна.
--exclude-services <names>	Сервисы, разделённые по запятой, пропускать при сборке и развертывании: staticHosting или functions.
--provider <fabric>	Провайдер развертывания; по умолчанию — fabric.

Examples

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

npx rayfin up

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

npx rayfin up --dry-run --verbose

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

npx rayfin up --workspace-id <workspace-id> --yes

Развертывание без создания или развертывания функций:

npx rayfin up --exclude-services functions

--capacity-id не комбинируется с --workspaceпомощью , --workspace-id, или --workspace-uri.

Subcommand	Description
npx rayfin up db apply	Сгенерируйте и примените конфигурацию DAB к удалённой конечной точке рабочей нагрузки Rayfin.
npx rayfin up functions deploy	Создайте, упаковывайте и развертывайте функции в активном удалённом элементе.
npx rayfin up staticapp deploy	Создайте, упаковывайте и развертывайте статический контент в удалённый элемент Rayfin.
npx rayfin up connector apply	Применить конфигурацию базы данных для объявленных разъёмов GraphQL.
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 functions deploy

Создаёт, упаковывает и развёртывает функции в активном удалённом элементе.

Опция	Description
--verbose	Отображение подробных выходных данных.
--skip-build	Развернуть существующий выход Functions без строительства.
--json	Излучайте выход JSON.

rayfin up connector apply

Применяет конфигурацию базы данных для заявленных разъёмов GraphQL.

Опция	Description
--name <name>	Применяйте только именованный разъём.
--verbose	Включите подробный вывод.
--json	Излучайте выход 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