sap-fiori-create-cli

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

How to use this CLI

如何使用此CLI

Always invoke via
```
npx -y @sap-ux/create@latest
```
— never suggest a global install.
Run with
```
--simulate
```
/
```
-s
```
first for any write command when the user has not confirmed they want files changed. It implies
```
--verbose
```
on most subcommands.
Pass passwords via
```
--password env:MY_VAR
```
— never plain-text in the shell command.
Commands that prompt interactively (
```
generate adaptation-project
```
,
```
add model
```
,
```
add component-usages
```
) require either
```
-y
```
/
```
--yes
```
or all required flags pre-filled to run non-interactively.
```
add annotations
```
,
```
change data-source
```
, and
```
change inbound
```
are not supported for Cloud Foundry projects.
```
add adp-cf-config
```
is experimental and may change or be removed without notice.

始终通过
```
npx -y @sap-ux/create@latest
```
调用——切勿建议全局安装。
当用户尚未确认要修改文件时，所有写入类命令都应先使用
```
--simulate
```
/
```
-s
```
参数运行。该参数在大多数子命令中会自动启用
```
--verbose
```
模式。
通过
```
--password env:MY_VAR
```
传递密码——绝对不要在shell命令中使用明文密码。
交互式提示的命令（
```
generate adaptation-project
```
、
```
add model
```
、
```
add component-usages
```
）需要添加
```
-y
```
/
```
--yes
```
参数，或者预先填充所有必填参数才能以非交互式模式运行。

add annotations

、

change data-source

和

change inbound

命令不支持Cloud Foundry项目。

```
add adp-cf-config
```
为实验性功能，可能会随时更改或移除，恕不另行通知。

Commands

命令

generate

generate

Command group for generating SAP Fiori applications. A subcommand is required.

Usage:

npx --yes @sap-ux/create@latest generate [subcommand] [options]

The available subcommands are:

adaptation-project

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

用法：

npx --yes @sap-ux/create@latest generate [subcommand] [options]

可用子命令：

adaptation-project

generate adaptation-project

generate adaptation-project

Generate a new SAPUI5 adaptation project with optional prompts and configuration.

Example:

npx --yes @sap-ux/create@latest generate adaptation-project

Options:

```
-n, --skip-install
```
- Skip the
```
npm install
```
step.
```
-s, --simulate
```
- Simulate only. Do not write or install.
```
-y, --yes
```
- Use default values for all prompts.
```
--id [id]
```
- The ID of the adaptation project.
```
--reference [reference]
```
- The ID of the original application.
```
--url [url]
```
- The URL that points to the target system which contains the original application.
```
--ignoreCertErrors
```
- Ignore certificate errors when connecting to the target system.
```
--ft
```
- Enable SAP Fiori tools for the generated project.
```
--ts
```
- Enable TypeScript support for the generated project.
```
--package [package]
```
- The ABAP package to be used for deployments.
```
--transport [transport]
```
- The ABAP transport to be used for deployments.

生成新的SAPUI5适配项目，支持可选提示和配置。

示例：

npx --yes @sap-ux/create@latest generate adaptation-project

选项：

```
-n, --skip-install
```
- 跳过
```
npm install
```
步骤。
```
-s, --simulate
```
- 仅模拟操作，不写入文件或执行安装。
```
-y, --yes
```
- 所有提示均使用默认值。
```
--id [id]
```
- 适配项目的ID。
```
--reference [reference]
```
- 原始应用的ID。
```
--url [url]
```
- 指向包含原始应用的目标系统的URL。
```
--ignoreCertErrors
```
- 连接目标系统时忽略证书错误。
```
--ft
```
- 为生成的项目启用SAP Fiori tools。
```
--ts
```
- 为生成的项目启用TypeScript支持。
```
--package [package]
```
- 部署时使用的ABAP包。
```
--transport [transport]
```
- 部署时使用的ABAP传输请求。

add

add

Command group for adding features to existing SAP Fiori applications. A subcommand is required.

Usage:

npx --yes @sap-ux/create@latest add [subcommand] [options]

The available subcommands are:

mockserver-config

smartlinks-config

eslint-config

cds-plugin-ui5

inbound-navigation

cards-editor

model

annotations

html

component-usages

deploy-config

variants-config

adp-cf-config

system

and

flp-embedded-config

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

用法：

npx --yes @sap-ux/create@latest add [subcommand] [options]

可用子命令：

mockserver-config

、

smartlinks-config

、

eslint-config

、

cds-plugin-ui5

、

inbound-navigation

、

cards-editor

、

model

、

annotations

、

html

、

component-usages

、

deploy-config

、

variants-config

、

adp-cf-config

、

system

和

flp-embedded-config

add mockserver-config

add mockserver-config

Add the necessary configuration for the

@sap-ux/ui5-middleware-fe-mockserver

mockserver module to enable local OData mocking.

Example:

npx --yes @sap-ux/create@latest add mockserver-config

Options:

```
-i, --interactive
```
- Ask for config options or otherwise, use the default options.
```
-n, --skip-install
```
- Skip the
```
npm install
```
step.
```
-s, --simulate
```
- Simulate only. Do not write or install. Also, sets
```
--verbose
```
```
-v, --verbose
```
- Show verbose information.

添加

@sap-ux/ui5-middleware-fe-mockserver

模拟服务器模块的必要配置，以启用本地OData模拟。

示例：

npx --yes @sap-ux/create@latest add mockserver-config

选项：

```
-i, --interactive
```
- 询问配置选项，否则使用默认选项。
```
-n, --skip-install
```
- 跳过
```
npm install
```
步骤。
```
-s, --simulate
```
- 仅模拟操作，不写入文件或执行安装，同时启用
```
--verbose
```
模式。
```
-v, --verbose
```
- 显示详细信息。

add smartlinks-config

add smartlinks-config

Add a

smartLinks

configuration to a project for cross-app navigation.

Example:

npx --yes @sap-ux/create@latest add smartlinks-config

Options:

```
-s, --simulate
```
- Simulate only. Do not write to the config file. Also, sets
```
--verbose
```
```
-v, --verbose
```
- Show verbose information.

为项目添加

smartLinks

配置以支持跨应用导航。

示例：

npx --yes @sap-ux/create@latest add smartlinks-config

选项：

```
-s, --simulate
```
- 仅模拟操作，不写入配置文件，同时启用
```
--verbose
```
模式。
```
-v, --verbose
```
- 显示详细信息。

add eslint-config

add eslint-config

Add an ESLint configuration to a project including the SAP Fiori tools lint plugin (

@sap-ux/eslint-plugin-fiori-tools

Example:

npx --yes @sap-ux/create@latest add eslint-config

Options:

```
-s, --simulate
```
- Simulate only. Do not write to the config file. Also, sets
```
--verbose
```
```
-v, --verbose
```
- Show verbose information.
```
-c, --config <string>
```
- The name of the SAP Fiori tools eslint plugin configuration to be used. (default:
recommended
)
```
-n, --skip-install
```
- Skip the
```
npm install
```
step.

为项目添加ESLint配置，包括SAP Fiori tools lint插件（

@sap-ux/eslint-plugin-fiori-tools

）。

示例：

npx --yes @sap-ux/create@latest add eslint-config

选项：

```
-s, --simulate
```
- 仅模拟操作，不写入配置文件，同时启用
```
--verbose
```
模式。
```
-v, --verbose
```
- 显示详细信息。
```
-c, --config <string>
```
- 使用的SAP Fiori tools eslint插件配置名称。（默认值：
recommended
）
```
-n, --skip-install
```
- 跳过
```
npm install
```
步骤。

add cds-plugin-ui5

add cds-plugin-ui5

Add the

cds-plugin-ui5

module and all prerequisites to a CAP project for UI5 server integration.

Example:

npx --yes @sap-ux/create@latest add cds-plugin-ui5

Options:

```
-n, --skip-install
```
- Skip the
```
npm install
```
step.
```
-s, --simulate
```
- Simulate only. Do not write or install. Also, sets
```
--verbose
```
```
-v, --verbose
```
- Show verbose information.

为CAP项目添加

cds-plugin-ui5

模块及所有前置依赖，以实现UI5服务器集成。

示例：

npx --yes @sap-ux/create@latest add cds-plugin-ui5

选项：

```
-n, --skip-install
```
- 跳过
```
npm install
```
步骤。
```
-s, --simulate
```
- 仅模拟操作，不写入文件或执行安装，同时启用
```
--verbose
```
模式。
```
-v, --verbose
```
- 显示详细信息。

add inbound-navigation

add inbound-navigation

Add SAP Fiori launchpad inbound navigation configuration to a project.

Example:

npx --yes @sap-ux/create@latest add inbound-navigation

Options:

```
-s, --simulate
```
- Simulate only. Do not write to the config file. Also, sets
```
--verbose
```
```
-v, --verbose
```
- Show verbose information.
```
-c, --config <string>
```
- Path to the project configuration file in YAML format. (default:
ui5.yaml
)

为项目添加SAP Fiori launchpad入站导航配置。

示例：

npx --yes @sap-ux/create@latest add inbound-navigation

选项：

```
-s, --simulate
```
- 仅模拟操作，不写入配置文件，同时启用
```
--verbose
```
模式。
```
-v, --verbose
```
- 显示详细信息。
```
-c, --config <string>
```
- YAML格式的项目配置文件路径。（默认值：
ui5.yaml
）

add cards-editor

add cards-editor

Add the necessary configuration to an existing YAML file and the script to the

package.json

file for cards generation. It uses the configuration from the YAML file passed by the CLI or default to

ui5.yaml

, as provided by the

fiori-tools-preview

preview-middleware

Example:

npx --yes @sap-ux/create@latest add cards-editor

Options:

```
-c, --config <string>
```
- Path to the project configuration file in YAML format. (default:
ui5.yaml
)
```
-s, --simulate
```
- Simulate only. Do not write to the config file. Also, sets
```
--verbose
```
```
-v, --verbose
```
- Show verbose information.

为现有YAML文件添加必要配置，并在

package.json

中添加卡片生成脚本。它使用CLI传入的YAML文件配置，默认使用

ui5.yaml

（由

fiori-tools-preview

或

preview-middleware

提供）。

示例：

npx --yes @sap-ux/create@latest add cards-editor

选项：

```
-c, --config <string>
```
- YAML格式的项目配置文件路径。（默认值：
ui5.yaml
）
```
-s, --simulate
```
- 仅模拟操作，不写入配置文件，同时启用
```
--verbose
```
模式。
```
-v, --verbose
```
- 显示详细信息。

add model

add model

Add a new OData service and SAPUI5 model to an existing adaptation project.

Example:

npx --yes @sap-ux/create@latest add model

Options:

```
-s, --simulate
```
- Simulate only. Do not write or install.

为现有适配项目添加新的OData服务和SAPUI5模型。

示例：

npx --yes @sap-ux/create@latest add model

选项：

```
-s, --simulate
```
- 仅模拟操作，不写入文件或执行安装。

add annotations

add annotations

Adds an annotation to the OData Source of the base application in an adaptation project.

This command is not supported for Cloud Foundry projects.

Example:

npx --yes @sap-ux/create@latest add annotations

Options:

```
-s, --simulate
```
- Simulate only. Do not write or install.
```
-c, --config <string>
```
- Path to the project configuration file in YAML format. (default:
ui5.yaml
)

在适配项目中为基础应用的OData源添加注解。

此命令不支持Cloud Foundry项目。

示例：

npx --yes @sap-ux/create@latest add annotations

选项：

```
-s, --simulate
```
- 仅模拟操作，不写入文件或执行安装。
```
-c, --config <string>
```
- YAML格式的项目配置文件路径。（默认值：
ui5.yaml
）

add html

add html

Add HTML files for local preview and testing to the project. It uses the configuration from the

ui5.yaml

file as default, as provided by the

fiori-tools-preview

preview-middleware

Example:

npx --yes @sap-ux/create@latest add html

Options:

```
-c, --config <string>
```
- Path to the project configuration file in YAML format. (default:
ui5.yaml
)
```
-s, --simulate
```
- Simulate only. Do not write to the config file. Also, sets
```
--verbose
```
```
-v, --verbose
```
- Show verbose information.

为项目添加用于本地预览和测试的HTML文件。默认使用

ui5.yaml

文件中的配置（由

fiori-tools-preview

或

preview-middleware

提供）。

示例：

npx --yes @sap-ux/create@latest add html

选项：

```
-c, --config <string>
```
- YAML格式的项目配置文件路径。（默认值：
ui5.yaml
）
```
-s, --simulate
```
- 仅模拟操作，不写入配置文件，同时启用
```
--verbose
```
模式。
```
-v, --verbose
```
- 显示详细信息。

add component-usages

add component-usages

Add the component usages to an adaptation project.

Example:

npx --yes @sap-ux/create@latest add component-usages

Options:

```
-s, --simulate
```
- Simulate only. Do not write or install.

为适配项目添加组件引用配置。

示例：

npx --yes @sap-ux/create@latest add component-usages

选项：

```
-s, --simulate
```
- 仅模拟操作，不写入文件或执行安装。 n

add deploy-config

add deploy-config

Prompt for ABAP deployment configuration details and adds and updates the project files accordingly.

Example:

npx --yes @sap-ux/create@latest add deploy-config

Options:

```
-t, --target <string>
```
- Target for deployment: ABAP or Cloud Foundry (not yet implemented)
```
-s, --simulate
```
- Simulate only. Do not write. Also, sets
```
--verbose
```
```
-v, --verbose
```
- Show verbose information.
```
-b, --base-file <string>
```
- The base config file of the project. (default: "ui5.yaml")
```
-d, --deploy-file <string>
```
- The name of the deploy config file to be written. (default: "ui5-deploy.yaml")

提示输入ABAP部署配置详情，并相应地添加和更新项目文件。

示例：

npx --yes @sap-ux/create@latest add deploy-config

选项：

```
-t, --target <string>
```
- 部署目标：ABAP或Cloud Foundry（尚未实现）
```
-s, --simulate
```
- 仅模拟操作，不写入文件，同时启用
```
--verbose
```
模式。
```
-v, --verbose
```
- 显示详细信息。
```
-b, --base-file <string>
```
- 项目的基础配置文件。（默认值："ui5.yaml"）
```
-d, --deploy-file <string>
```
- 要写入的部署配置文件名称。（默认值："ui5-deploy.yaml"）

add variants-config

add variants-config

Add the necessary configuration to an existing YAML file and the script to the

package.json

file for variants creation. It uses the configuration from the YAML file passed by the CLI or default to

ui5.yaml

, as provided by the

fiori-tools-preview

preview-middleware

Example:

npx --yes @sap-ux/create@latest add variants-config

Options:

```
-c, --config <string>
```
- Path to the project configuration file in YAML format. (default:
ui5.yaml
)
```
-s, --simulate
```
- Simulate only. Do not write to the config file. Also, sets
```
--verbose
```
```
-v, --verbose
```
- Show verbose information.

为现有YAML文件添加必要配置，并在

package.json

中添加变体创建脚本。它使用CLI传入的YAML文件配置，默认使用

ui5.yaml

（由

fiori-tools-preview

或

preview-middleware

提供）。

示例：

npx --yes @sap-ux/create@latest add variants-config

选项：

```
-c, --config <string>
```
- YAML格式的项目配置文件路径。（默认值：
ui5.yaml
）
```
-s, --simulate
```
- 仅模拟操作，不写入配置文件，同时启用
```
--verbose
```
模式。
```
-v, --verbose
```
- 显示详细信息。

add adp-cf-config

add adp-cf-config

Configure an existing Cloud Foundry adaptation project for local preview by fetching reusable libraries, building the project, and configuring ui5.yaml file middlewares.

⚠️ Experimental: This command is experimental and may be subject to breaking changes or even removal in future versions. Use with caution and be prepared to update your configuration or migrate to alternative solutions, if needed.

Example:

npx --yes @sap-ux/create@latest add adp-cf-config

Options:

```
-v, --verbose
```
- Show verbose information.
```
-c, --config <string>
```
- Path to the project configuration file in YAML format. (default:
ui5.yaml
)

通过获取可重用库、构建项目和配置ui5.yaml中间件，为现有Cloud Foundry适配项目配置本地预览功能。

⚠️ 实验性功能：此命令为实验性内容，未来版本可能会发生重大变更甚至被移除。请谨慎使用，并做好更新配置或迁移到替代方案的准备。

示例：

npx --yes @sap-ux/create@latest add adp-cf-config

选项：

```
-v, --verbose
```
- 显示详细信息。
```
-c, --config <string>
```
- YAML格式的项目配置文件路径。（默认值：
ui5.yaml
）

add system

add system

Add a new back-end system to the saved systems store (

~/.fioritools

). Credentials are stored securely in the OS keychain.

System types:

AbapCloud

OnPrem

Generic

Auth types:

basic

reentranceTicket

oauth2

oauth2ClientCredential

Connection types:

abap_catalog

generic_host

odata_service

Example:

npx --yes @sap-ux/create@latest add system --name "My System" --url https://my-sap.example.com

npx --yes @sap-ux/create@latest add system --name "My System" --url https://my-sap.example.com --client 100 --username myuser

npx --yes @sap-ux/create@latest add system

(interactive mode)

Options:

```
--name <string>
```
- Display name for the system
```
--url <string>
```
- URL of the backend system
```
--client <string>
```
- SAP client number (optional)
```
--type <string>
```
- System type (AbapCloud | OnPrem | Generic) (default:
OnPrem
)
```
--auth <string>
```
- Authentication type (basic | reentranceTicket | oauth2 | oauth2ClientCredential) (default:
basic
)
```
--connection-type <string>
```
- Connection type (abap_catalog | generic_host | odata_service) (default:
abap_catalog
)
```
--username <string>
```
- Username for basic authentication
```
--password <string>
```
- To avoid plain-text credentials in the shell's history, pass an env reference: --password env:MY_VAR
```
--skip-check
```
- Skip connection verification before saving

将新的后端系统添加到已保存系统存储（

~/.fioritools

）中。凭证将安全存储在操作系统密钥链中。

系统类型：

AbapCloud

、

OnPrem

、

Generic

认证类型：

basic

、

reentranceTicket

、

oauth2

、

oauth2ClientCredential

连接类型：

abap_catalog

、

generic_host

、

odata_service

示例：

npx --yes @sap-ux/create@latest add system --name "My System" --url https://my-sap.example.com

npx --yes @sap-ux/create@latest add system --name "My System" --url https://my-sap.example.com --client 100 --username myuser

npx --yes @sap-ux/create@latest add system

（交互式模式）

选项：

```
--name <string>
```
- 系统显示名称
```
--url <string>
```
- 后端系统的URL
```
--client <string>
```
- SAP客户端编号（可选）
```
--type <string>
```
- 系统类型（AbapCloud | OnPrem | Generic）（默认值：
OnPrem
）
```
--auth <string>
```
- 认证类型（basic | reentranceTicket | oauth2 | oauth2ClientCredential）（默认值：
basic
）
```
--connection-type <string>
```
- 连接类型（abap_catalog | generic_host | odata_service）（默认值：
abap_catalog
）
```
--username <string>
```
- 基础认证的用户名
```
--password <string>
```
- 为避免明文凭证出现在shell历史中，请传递环境变量引用：--password env:MY_VAR
```
--skip-check
```
- 保存前跳过连接验证

add flp-embedded-config

add flp-embedded-config

Add the necessary configuration for running a Fiori app in FLP Embedded Mode. Adds a

start-embedded

script to

package.json

and creates an

flp.yaml

file based on the existing

ui5.yaml

. Pre-existing files will be overridden.

Example:

npx --yes @sap-ux/create@latest add flp-embedded-config --bspApplication my-bsp-app

Options:

```
-b, --bspApplication <string>
```
(required) - BSP application name of the deployed app
```
-c, --config <string>
```
- Path (relative to project root) to the ui5.yaml to use as base for flp.yaml (default:
ui5.yaml
)

--flp <string>

- FLP URL path used in the start-embedded script (default:
sap/bc/ui5_ui5/ui2/ushell/shells/abap/Fiorilaunchpad.html
)

```
-s, --simulate
```
- Simulate only. Do not write files. Also sets
```
--verbose
```
.
```
-v, --verbose
```
- Show verbose information.

添加在FLP嵌入式模式下运行Fiori应用的必要配置。在

package.json

中添加

start-embedded

脚本，并基于现有

ui5.yaml

创建

flp.yaml

文件。已存在的文件将被覆盖。

示例：

npx --yes @sap-ux/create@latest add flp-embedded-config --bspApplication my-bsp-app

选项：

```
-b, --bspApplication <string>
```
（必填） - 已部署应用的BSP应用名称
```
-c, --config <string>
```
- 用作flp.yaml基础的ui5.yaml路径（相对于项目根目录）（默认值：
ui5.yaml
）

--flp <string>

- start-embedded脚本中使用的FLP URL路径（默认值：
sap/bc/ui5_ui5/ui2/ushell/shells/abap/Fiorilaunchpad.html
）

```
-s, --simulate
```
- 仅模拟操作，不写入文件，同时启用
```
--verbose
```
模式。
```
-v, --verbose
```
- 显示详细信息。

convert

convert

Command group for converting existing SAP Fiori applications. A subcommand is required.

Usage:

npx --yes @sap-ux/create@latest convert [subcommand] [options]

The available subcommands are:

preview-config

and

eslint-config

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

用法：

npx --yes @sap-ux/create@latest convert [subcommand] [options]

可用子命令：

preview-config

和

eslint-config

convert preview-config

convert preview-config

For the full workflow guide including prerequisites and manual steps, read
references/convert-preview-config.md
.

Executed in the root folder of an app, it converts the respective app to the preview with virtual endpoints. It uses the configuration from the scripts in the

package.json

file to adjust the UI5 configuration YAML files accordingly. The obsolete JS and TS sources are deleted and the HTML files previously used for the preview are renamed to

*_old.html

Examples:

npx --yes @sap-ux/create@latest convert preview-config --simulate=false --tests=false

npx --yes @sap-ux/create@latest convert preview-config

Options:

```
-s, --simulate <boolean>
```
- Simulate only. Do not write.
```
-v, --verbose
```
- Show verbose information.
```
-t, --tests <boolean>
```
- Also, convert test suite and test runners.

如需包含前置条件和手动步骤的完整工作流指南，请阅读
references/convert-preview-config.md
。

在应用根目录执行此命令，将应用转换为使用虚拟端点的预览模式。它会使用

package.json

中的脚本配置来相应调整UI5配置YAML文件。过时的JS和TS源文件将被删除，之前用于预览的HTML文件将重命名为

*_old.html

。

示例：

npx --yes @sap-ux/create@latest convert preview-config --simulate=false --tests=false

npx --yes @sap-ux/create@latest convert preview-config

选项：

```
-s, --simulate <boolean>
```
- 仅模拟操作，不写入文件。
```
-v, --verbose
```
- 显示详细信息。
```
-t, --tests <boolean>
```
- 同时转换测试套件和测试运行器。

convert eslint-config

convert eslint-config

Executed in the root folder of an app, it converts the ESLint configuration of the respective app to flat config format (used since ESLint version 9). It also introduces specific ESLint checks for SAP Fiori applications (using the

@sap-ux/eslint-plugin-fiori-tools

plugin), and deletes the deprecated

eslint-plugin-fiori-custom

plugin. To avoid dependency resolution conflicts, it deletes the

package-lock.json

file as well as the

@sap-ux/eslint-plugin-fiori-tools

module from the

node_modules

folder before running

npm install

Examples:

npx --yes @sap-ux/create@latest convert eslint-config

Options:

```
-s, --simulate
```
- Simulate only. Do not write to the config file. Also, sets
```
--verbose
```
```
-v, --verbose
```
- Show verbose information.
```
-c, --config <string>
```
- The name of the SAP Fiori tools ESLint plugin configuration to be used. (default:
recommended
)

-n, --skip-install

- Skip the

npm install

step. Also skips deleting the

package-lock.json

file and the

@sap-ux/eslint-plugin-fiori-tools

module from the

node_modules

folder.

在应用根目录执行此命令，将应用的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

模块。

示例：

npx --yes @sap-ux/create@latest convert eslint-config

选项：

```
-s, --simulate
```
- 仅模拟操作，不写入配置文件，同时启用
```
--verbose
```
模式。
```
-v, --verbose
```
- 显示详细信息。
```
-c, --config <string>
```
- 使用的SAP Fiori tools ESLint插件配置名称。（默认值：
recommended
）

-n, --skip-install

- 跳过

npm install

步骤，同时跳过删除

package-lock.json

文件和

node_modules

文件夹中的

@sap-ux/eslint-plugin-fiori-tools

模块。

remove

remove

Command group for removing features from existing SAP Fiori applications. A subcommand is required.

Usage:

npx --yes @sap-ux/create@latest remove [subcommand] [options]

The available subcommands are:

mockserver-config

and

system

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

用法：

npx --yes @sap-ux/create@latest remove [subcommand] [options]

可用子命令：

mockserver-config

和

system

remove mockserver-config

remove mockserver-config

Removes the configuration for the

@sap-ux/ui5-middleware-fe-mockserver

mockserver module.

Example:

npx --yes @sap-ux/create@latest remove mockserver-config

Options:

```
-v, --verbose
```
- Show verbose information.
```
-f, --force
```
- Do not ask for confirmation when deleting files.

移除

@sap-ux/ui5-middleware-fe-mockserver

模拟服务器模块的配置。

示例：

npx --yes @sap-ux/create@latest remove mockserver-config

选项：

```
-v, --verbose
```
- 显示详细信息。
```
-f, --force
```
- 删除文件时不询问确认。

remove system

remove system

Remove a saved back-end system from the saved system store (

~/.fioritools

). Also deletes any stored credentials in the OS keychain.

Example:

npx --yes @sap-ux/create@latest remove system --url https://my-sap.example.com

npx --yes @sap-ux/create@latest remove system --url https://my-sap.example.com --client 100

npx --yes @sap-ux/create@latest remove system

(interactive mode)

Options:

```
--url <string>
```
- URL of the backend system to remove
```
--client <string>
```
- SAP client number (optional)
```
--force
```
- Skip confirmation prompt

从已保存系统存储（

~/.fioritools

）中移除已保存的后端系统。同时删除操作系统密钥链中存储的所有凭证。

示例：

npx --yes @sap-ux/create@latest remove system --url https://my-sap.example.com

npx --yes @sap-ux/create@latest remove system --url https://my-sap.example.com --client 100

npx --yes @sap-ux/create@latest remove system

（交互式模式）

选项：

```
--url <string>
```
- 要移除的后端系统的URL
```
--client <string>
```
- SAP客户端编号（可选）
```
--force
```
- 跳过确认提示

update

update

Command group for updating saved resources. A subcommand is required.

Usage:

npx --yes @sap-ux/create@latest update [subcommand] [options]

The available subcommands are:

system

and

service-metadata

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

用法：

npx --yes @sap-ux/create@latest update [subcommand] [options]

可用子命令：

system

和

service-metadata

update system

update system

Update an existing backend system in the saved systems store (

~/.fioritools

). The system is identified by its URL and optional SAP client.

Example:

npx --yes @sap-ux/create@latest update system --url https://my-sap.example.com --name "New Name"

npx --yes @sap-ux/create@latest update system --url https://my-sap.example.com --client 100 --username newuser

npx --yes @sap-ux/create@latest update system

(interactive mode)

Options:

```
--url <string>
```
- URL of the backend system to update
```
--client <string>
```
- SAP client number to identify the system (optional)
```
--name <string>
```
- New display name for the system
```
--username <string>
```
- New username
```
--password <string>
```
- To avoid plain-text credentials in the shell's history, pass an env reference: --password env:MY_VAR
```
--clear-credentials
```
- Remove stored credentials from the system
```
--skip-check
```
- Skip connection verification before saving

更新已保存系统存储（

~/.fioritools

）中的现有后端系统。系统通过其URL和可选的SAP客户端编号进行识别。

示例：

npx --yes @sap-ux/create@latest update system --url https://my-sap.example.com --name "New Name"

npx --yes @sap-ux/create@latest update system --url https://my-sap.example.com --client 100 --username newuser

npx --yes @sap-ux/create@latest update system

（交互式模式）

选项：

```
--url <string>
```
- 要更新的后端系统的URL
```
--client <string>
```
- 用于识别系统的SAP客户端编号（可选）
```
--name <string>
```
- 系统的新显示名称
```
--username <string>
```
- 新用户名
```
--password <string>
```
- 为避免明文凭证出现在shell历史中，请传递环境变量引用：--password env:MY_VAR
```
--clear-credentials
```
- 移除系统中存储的凭证
```
--skip-check
```
- 保存前跳过连接验证

update service-metadata

update service-metadata

For the full workflow guide including prerequisites and manual steps, read
references/update-service-metadata.md
.

Refresh the local OData service metadata.xml from the live backend for a Fiori application. Also fetches value-help (external) service metadata when available.

Only supported for Fiori applications connected to an EDMX backend. CAP applications are not supported, as their service metadata is generated locally from the CDS model rather than fetched from a backend.

Example:

npx --yes @sap-ux/create@latest update service-metadata /path/to/my-fiori-app

npx --yes @sap-ux/create@latest update service-metadata /path/to/my-fiori-app --simulate

Options:

```
--service <name>
```
- Name of the data source in manifest.json (defaults to mainService or first service)
```
--no-value-help
```
- Skip fetching value-help (external) service metadata
```
-s, --simulate
```
- Simulate only. Do not write. Also sets
```
--verbose
```
.
```
-v, --verbose
```
- Show verbose information.

如需包含前置条件和手动步骤的完整工作流指南，请阅读
references/update-service-metadata.md
。

从实时后端刷新Fiori应用的本地OData服务metadata.xml。当可用时，还会获取值帮助（外部）服务元数据。

仅支持连接到EDMX后端的Fiori应用。不支持CAP应用，因为其服务元数据是从CDS模型本地生成的，而非从后端获取。

示例：

npx --yes @sap-ux/create@latest update service-metadata /path/to/my-fiori-app

npx --yes @sap-ux/create@latest update service-metadata /path/to/my-fiori-app --simulate

选项：

```
--service <name>
```
- manifest.json中的数据源名称（默认为mainService或第一个服务）
```
--no-value-help
```
- 跳过获取值帮助（外部）服务元数据
```
-s, --simulate
```
- 仅模拟操作，不写入文件，同时启用
```
--verbose
```
模式。
```
-v, --verbose
```
- 显示详细信息。

change

change

Command group for changing existing SAP Fiori applications. A subcommand is required.

Usage:

npx --yes @sap-ux/create@latest change [subcommand] [options]

The available subcommands are:

data-source

and

inbound

用于修改现有SAP Fiori应用的命令组，必须指定子命令。

用法：

npx --yes @sap-ux/create@latest change [subcommand] [options]

可用子命令：

data-source

和

inbound

change data-source

change data-source

Replace the OData Source of the base application in an adaptation project.

This command is not supported for Cloud Foundry projects.

Example:

npx --yes @sap-ux/create@latest change data-source

Options:

```
-s, --simulate
```
- Simulate only. Do not write or install.
```
-c, --config <string>
```
- Path to the project configuration file in YAML format. (default:
ui5.yaml
)

替换适配项目中基础应用的OData源。

此命令不支持Cloud Foundry项目。

示例：

npx --yes @sap-ux/create@latest change data-source

选项：

```
-s, --simulate
```
- 仅模拟操作，不写入文件或执行安装。
```
-c, --config <string>
```
- YAML格式的项目配置文件路径。（默认值：
ui5.yaml
）

change inbound

change inbound

Replace the inbound FLP configurations of the base application in an adaptation project.

This command is not supported for Cloud Foundry projects.

Example:

npx --yes @sap-ux/create@latest change inbound

Options:

```
-s, --simulate
```
- Simulate only. Do not write or install.

替换适配项目中基础应用的FLP入站配置。

此命令不支持Cloud Foundry项目。

示例：

npx --yes @sap-ux/create@latest change inbound

选项：

```
-s, --simulate
```
- 仅模拟操作，不写入文件或执行安装。

list

list

Command group for listing saved resources. A subcommand is required.

Usage:

npx --yes @sap-ux/create@latest list [subcommand] [options]

The available subcommands are:

system

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

用法：

npx --yes @sap-ux/create@latest list [subcommand] [options]

可用子命令：

system

list system

list system

List all back-end systems in the saved system store (

~/.fioritools

). Sensitive data, such as passwords and tokens, is never included in the output.

Example:

npx --yes @sap-ux/create@latest list system

npx --yes @sap-ux/create@latest list system --json

Options:

```
--json
```
- Output as JSON, which is useful for automation and MCP integrations.

列出已保存系统存储（

~/.fioritools

）中的所有后端系统。输出中绝不会包含敏感数据，如密码和令牌。

示例：

npx --yes @sap-ux/create@latest list system

npx --yes @sap-ux/create@latest list system --json

选项：

```
--json
```
- 以JSON格式输出，适用于自动化和MCP集成。

get

get

Command group for retrieving saved resources. A subcommand is required.

Usage:

npx --yes @sap-ux/create@latest get [subcommand] [options]

The available subcommands are:

system

用于检索已保存资源的命令组，必须指定子命令。

用法：

npx --yes @sap-ux/create@latest get [subcommand] [options]

可用子命令：

system

get system

get system

Retrieve details of a saved back-end system by URL. Sensitive data (passwords, tokens) is never included in the output.

Example:

npx --yes @sap-ux/create@latest get system --url https://my-sap.example.com

npx --yes @sap-ux/create@latest get system --url https://my-sap.example.com --client 100

npx --yes @sap-ux/create@latest get system --url https://my-sap.example.com --json

Options:

```
--url <string>
```
(required) - URL of the backend system.
```
--client <string>
```
- SAP client number (optional).
```
--json
```
- Output as JSON, which is useful for automation and MCP integrations.

通过URL检索已保存后端系统的详细信息。输出中绝不会包含敏感数据（密码、令牌）。

示例：

npx --yes @sap-ux/create@latest get system --url https://my-sap.example.com

npx --yes @sap-ux/create@latest get system --url https://my-sap.example.com --client 100

npx --yes @sap-ux/create@latest get system --url https://my-sap.example.com --json

选项：

```
--url <string>
```
（必填） - 后端系统的URL。
```
--client <string>
```
- SAP客户端编号（可选）。
```
--json
```
- 以JSON格式输出，适用于自动化和MCP集成。