Sap Fiori Create CLI

How to use this 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.

Commands

`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 and opa5-tests

`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.

`generate opa5-tests`

Generate OPA5 integration tests for an existing SAP Fiori elements (OData V4) application.

Example:

npx --yes @sap-ux/create@latest generate opa5-tests

Options:

• -t, --typescript - Force generation of TypeScript test files. Otherwise, TypeScript is auto-detected from the presence of a tsconfig.json.
• -s, --simulate - Simulate only. Do not write. Also, sets --verbose
• -v, --verbose - Show verbose information.

`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

`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.

`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.

`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.

`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.

`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)_

`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 or 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.

`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.

`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)_

`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 or 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.

`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.

`add deploy-config`

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

Example: