查找 Rayfin CLI 命令，用于创建项目、管理模式变更、部署到 Fabric 以及配置环境设置。 每个章节列出命令语法、选项和常见用途。
安装
用于 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 命令会引导你如何启用服务、选择数据库方言，以及配置静态托管，无需搭建新模板。
完整攻略请参见 使用 CLI创建并部署你的第一个 Fabric 应用，以及 将Fabric应用部署到 Fabric。
支架项目 npm create
npm create （别 npm init名）通过调用创建初始化器包来启动新项目。 要搭建一个Fabric应用，请配合 @microsoft/rayfin 初始化器使用：
npm create @microsoft/rayfin@latest my-app --workspace <workspace name>
命令参考
本文中的命令和标志是从本地安装的CLI帮助输出中验证的。
顶级命令
使用此表快速找到合适的命令。
| 命令 | 使用它 |
|---|---|
rayfin init [directory] |
创建或配置一个Rayfin项目。 |
rayfin up |
将应用部署到 Fabric 并管理远程部署。 |
rayfin env |
从中 rayfin/.env生成框架特定的环境文件。 |
rayfin login |
登录Rayfin平台。 |
rayfin logout |
登出并清除缓存凭证。 |
创建或配置项目
rayfin init [directory]
用于 rayfin init 将Rayfin添加到新建或已有项目中。
| 论点 | 说明 |
|---|---|
--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 工作区 ID。 |
--workspace-uri <uri> |
使用特定的 Fabric 工作区 URI。 |
--base-api-url <url> |
覆盖基础 API URL。 |
--item-id <id> |
针对特定的Fabric物品ID。 |
示例
在搭建脚手架前列出可用模板：
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 项。
| 论点 | 说明 |
|---|---|
--tenant <id> |
使用特定的租户ID。 |
--workspace-id <id> |
部署到特定的 Fabric 工作区 ID。 |
--workspace-uri <uri> |
部署到特定的 Fabric 工作区 URI。 |
--base-api-url <url> |
覆盖基础 API URL。 |
--force |
必要时采取部队部署步骤。 |
--dry-run |
预览部署操作而不应用它们。 |
--env-file <path> |
从文件加载环境值。 |
--verbose |
展示冗长的部署输出。 |
--json |
返回部署输出为JSON格式。 |
-y, --yes |
自动接受提示。 |
--encryption-fallback-enabled |
启用加密备份行为。 |
示例
部署到当前选定的 Fabric 工作区：
npx rayfin up
预览部署操作而不应用：
npx rayfin up --dry-run --verbose
非交互式地部署到特定工作区：
npx rayfin up --workspace-id 00000000-0000-0000-0000-000000000000 --yes
| 子命令 | 说明 |
|---|---|
rayfin up db apply |
生成并应用DAB配置到远程Rayfin项目工作负载终端。 |
rayfin up staticapp deploy |
构建、打包并部署静态内容到远程的 Rayfin 项目。 |
rayfin up status |
显示当前部署状态。 |
rayfin up list |
列出该项目录制的所有 Fabric 部署。 |
rayfin up switch [workspace] |
切换主动Fabric部署，重写 rayfin/.env。 |
rayfin up db apply
生成并应用DAB配置到远程Rayfin项目工作负载终端。
| 论点 | 说明 |
|---|---|
--verbose |
显示详细输出。 |
--force |
强制再生并应用配置。 |
--json |
返回 JSON 格式的输出。 |
示例
对远程Rayfin项应用数据库配置更改：
npx rayfin up db apply
强制再生并捕捉机器可读输出：
npx rayfin up db apply --force --json
rayfin up staticapp deploy
构建、打包并部署静态内容到远程 Rayfin 项目。
| 论点 | 说明 |
|---|---|
--verbose |
显示详细输出。 |
--skip-build |
部署时不运行构建步骤。 |
--json |
返回 JSON 格式的输出。 |
示例
构建和部署静态内容：
npx rayfin up staticapp deploy
部署一个预构建 dist 的文件夹，无需重开构建：
npx rayfin up staticapp deploy --skip-build
rayfin up status
显示云部署状态。
| 论点 | 说明 |
|---|---|
--json |
返回状态格式为JSON。 |
--verbose |
显示详细输出。 |
示例
请查看当前部署状态：
npx rayfin up status
返回状态为脚本中使用的 JSON：
npx rayfin up status --json
rayfin up list
列出本项目中所有录制的 Fabric 部署。
| 论点 | 说明 |
|---|---|
--json |
返回部署列表，格式为JSON。 |
示例
列出该项目所有录制的 Fabric 部署：
npx rayfin up list
rayfin up switch [workspace]
切换激活Fabric部署，并相应重写rayfin/.env。
| 论点 | 说明 |
|---|---|
-l, --list |
列出无需切换即可部署的方案。 |
--no-emit-env |
跳过写出环境文件。 |
示例
列出可切换的部署：
npx rayfin up switch --list
将主动部署切换到特定工作区：
npx rayfin up switch my-workspace
生成环境文件
rayfin env
用于rayfin env输出框架特定的.env.local值。rayfin/.env
| 论点 | 说明 |
|---|---|
--framework <vite|nextjs|plain> |
选择目标框架格式。 |
--output <dir> |
把生成的文件写到特定的目录。 |
--show |
打印输出值而不写文件。 |
示例
生成与Vite兼容 .env.local的：
npx rayfin env --framework vite
无需写入文件即可预览发出的环境值：
npx rayfin env --framework nextjs --show
登录和登出
rayfin login
登录 rayfin login Rayfin平台。
| 论点 | 说明 |
|---|---|
--tenant <id> |
使用特定的租户ID。 |
--service-principal |
尝试服务负责人签到。 这个选项在帮助中列出，但目前不支持。 |
-u, --client-id <id> |
请提供客户ID，以便服务负责人登录。 这个选项在帮助中列出，但目前不支持。 |
-p, --client-secret <secret> |
提供客户密钥以便服务主体登录。 这个选项在帮助中列出，但目前不支持。 |
--select |
从可用的登录账户或上下文中选择。 |
--encryption-fallback-enabled |
启用加密备份行为。 |
示例
交互式登录：
npx rayfin login
登录特定租户：
npx rayfin login --tenant 00000000-0000-0000-0000-000000000000
切换登录账户：
npx rayfin login --select
| 子命令 | 说明 |
|---|---|
rayfin login status |
显示当前的认证状态。 |
rayfin login status
显示当前认证状态。
| 论点 | 说明 |
|---|---|
| 没有 | 这个子命令在CLI帮助输出中没有列出任何选项。 |
例子
检查您是否已登录：
npx rayfin login status
rayfin logout
登出并清除缓存的凭据。
| 论点 | 说明 |
|---|---|
| 没有 | 这个命令在CLI帮助输出中没有列出任何选项。 |
例子
登出并清除缓存凭证：
npx rayfin logout