sap-fiori-create-cli

如何使用此 CLI

• 始终通过 npx -y @sap-ux/create@latest 调用；切勿建议全局安装。
• 如果用户尚未确认要更改文件，执行任何写入命令前，先使用 --simulate / -s 运行。大多数子命令会因此启用 --verbose。
• 使用 --password env:MY_VAR 传递密码；切勿在 shell 命令中使用明文密码。
• 交互式提示命令（generate adaptation-project、add model、add component-usages）必须使用 -y / --yes，或预先填入所有必需的标志，才能以非交互方式运行。
• Cloud Foundry 项目不支持 add annotations、change data-source 和 change inbound。
• add adp-cf-config 为实验性功能，可能随时更改或移除，恕不另行通知。

---

命令

generate

用于生成 SAP Fiori 应用的命令组。必须指定一个子命令。

子命令	说明
adaptation-project	生成新的 SAPUI5 适配项目，可选使用提示词和配置。
opa5-tests	为现有 SAP Fiori elements（OData V4）应用生成 OPA5 集成测试。

完整选项和标志：references/generate.md

---

add

用于向现有 SAP Fiori 应用添加功能的命令组。必须指定一个子命令。

子命令	说明
mockserver-config	添加必要配置，以启用 @sap-ux/ui5-middleware-fe-mockserver 模拟服务器模块进行本地 OData 模拟。
smartlinks-config	向项目添加 smartLinks 配置，以支持跨应用导航。
eslint-config	向项目添加 ESLint 配置，其中包含 SAP Fiori 工具 lint 插件（@sap-ux/eslint-plugin-fiori-tools）。
cds-plugin-ui5	向 CAP 项目添加 cds-plugin-ui5 模块及其所有先决条件，以集成 UI5 服务端。
inbound-navigation	向项目添加 SAP Fiori 启动板入站导航配置。
cards-editor	向现有 YAML 文件添加必要配置，并向 package.json 文件添加卡片生成脚本。它使用 CLI 传入的 YAML 文件中的配置；如果未传入，则默认使用 ui5.yaml，该文件由 fiori-tools-preview 或 preview-middleware 提供。
model	向现有适配项目添加新的 OData 服务和 SAPUI5 模型。
annotations	向适配项目中基础应用的 OData 源添加注释。
html	向项目添加用于本地预览和测试的 HTML 文件。它默认使用 ui5.yaml 文件中的配置，该文件由 fiori-tools-preview 或 preview-middleware 提供。
component-usages	向适配项目添加组件用法。
deploy-config	提示输入 ABAP 部署配置详情，并相应添加和更新项目文件。
variants-config	向现有 YAML 文件添加必要配置，并向 package.json 文件添加变体创建脚本。它使用 CLI 传入的 YAML 文件中的配置；如果未传入，则默认使用 ui5.yaml，该文件由 fiori-tools-preview 或 preview-middleware 提供。
adp-cf-config	配置现有 Cloud Foundry 适配项目以进行本地预览：获取可复用库、构建项目，并配置 ui5.yaml 文件中间件。
system	向已保存系统存储（~/.fioritools）添加新的后端系统。凭据会安全地存储在操作系统钥匙串中。
flp-embedded-config	添加在 FLP Embedded Mode 中运行 Fiori 应用所需的配置。

完整选项和标志：references/add.md

---

convert

用于转换现有 SAP Fiori 应用的命令组。必须指定一个子命令。

子命令	描述
preview-config	在应用的根目录中执行，将相应应用转换为使用虚拟端点的预览。它会使用 package.json 文件中脚本的配置，相应地调整 UI5 配置 YAML 文件。系统会删除过时的 JS 和 TS 源文件，并将此前用于预览的 HTML 文件重命名为 *_old.html。
eslint-config	在应用的根目录中执行，将相应应用的 ESLint 配置转换为扁平配置格式（自 ESLint 版本 9 起使用）。它还会引入针对 SAP Fiori 应用的特定 ESLint 检查（使用 @sap-ux/eslint-plugin-fiori-tools 插件），并删除已弃用的 eslint-plugin-fiori-custom 插件。为避免依赖项解析冲突，它会在运行 npm install 前删除 package-lock.json 文件，以及 node_modules 文件夹中的 @sap-ux/eslint-plugin-fiori-tools 模块。

完整选项和标志：references/convert.md

---

remove

用于从现有 SAP Fiori 应用中移除功能的命令组。必须指定一个子命令。

子命令	描述
mockserver-config	移除 @sap-ux/ui5-middleware-fe-mockserver mockserver 模块的配置。
system	从已保存系统存储区（~/.fioritools）中移除一个已保存的后端系统。同时删除操作系统密钥链中存储的所有凭据。

完整选项和标志：references/remove.md

---

update

用于更新已保存资源的命令组。必须指定一个子命令。

子命令	描述
system	更新已保存系统存储区（~/.fioritools）中的现有后端系统。系统通过其 URL 和可选的 SAP 客户端进行标识。
service-metadata	从实时后端刷新 Fiori 应用的本地 OData 服务 metadata.xml。

完整选项和标志：references/update.md

---

change

用于更改现有 SAP Fiori 应用的命令组。必须指定一个子命令。

子命令	描述
data-source	替换适配项目中基础应用的 OData 源。
inbound	替换适配项目中基础应用的 FLP 入站配置。

完整选项和标志：references/change.md

---

list

用于列出已保存资源的命令组。必须指定一个子命令。

子命令	描述
system	列出已保存系统存储区（~/.fioritools）中的所有后端系统。输出中绝不会包含密码和令牌等敏感数据。

完整选项和标志：references/list.md

---

get

用于获取已保存资源的命令组。必须指定一个子命令。

子命令	描述
system	按 URL 获取已保存后端系统的详细信息。输出中绝不会包含密码和令牌等敏感数据。

完整选项和标志：references/get.md

---

migrate

将旧版 WebIDE Fiori 项目迁移为现代 Fiori tools 格式。在 BAS 中，需要指定 destination。在 BAS 之外，需要指定 hostname 和 client；destination 可选。

Option	Description
-d, --destination <name>	SAP System destination 名称（在 BAS 中必填）
-s, --sap-system-name <name>	SAP System 名称（destination 的别名）
-H, --hostname <host>	后端 hostname（在 BAS 之外必填，除非从已保存的系统中解析）
-c, --client <client>	SAP Client（在 BAS 之外必填，除非从 destination 或已保存的系统中解析）
-u, --ui5-version <version>	UI5 版本（默认为源项目版本）
-f, --force	即使项目已是 Fiori tools 项目，也强制迁移
-n, --skip-install	跳过迁移后的 npm install 步骤

完整选项和标志：references/migrate.md