Run, invoke, and test the @sap-ux/create CLI — generate, add, convert, remove, update, change, list, get commands for SAP Fiori projects. Use when asked to run sap-ux, invoke create CLI, add config to a project, generate adaptation-project, or test any sap-ux/create subcommand.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
A direct command skips the review prompt. Inspect the source before running it.
Run, invoke, and test the @sap-ux/create CLI — generate, add, convert, remove, update, change, list, get commands for SAP Fiori projects. Use when asked to run sap-ux, invoke create CLI, add config to a project, generate adaptation-project, or test any sap-ux/create subcommand.
argument-hint
command and subcommand (e.g., add mockserver-config, generate adaptation-project)
metadata
{"author":"sap-fiori-tools","version":"1.1.3"}
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.
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 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
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
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 or preview-middleware.
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)
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.
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.
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.
-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.
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.
