Installing the UI5 CLI¶
- Node.js (version 10 or higher ⚠️)
npm install --global @ui5/cli # Verify installation ui5 --help
⚡️ Quick Start: OpenUI5 Sample App¶
Enable an Existing Project¶
You can easily check whether or not a project (application or library) can already be used with the UI5 Tooling by looking for a
ui5.yaml file in the project's root directory.
This file (with some exceptions) is required for all projects and their dependencies (e.g. reuse libraries) to use them in the UI5 Tooling.
If your project is not set up for use with the UI5 Tooling yet, follow these steps:
If your project does not have a
package.jsonfile, let npm generate it:
npm init --yes
Define the framework you want to use
You can choose between the OpenUI5 and the SAPUI5 Framework. Don't know which one to choose? Check out our documentation on the differences between OpenUI5 and SAPUI5.
ui5 use openui5@latest
ui5 use sapui5@latest
Add required libraries
ui5 add sap.ui.core sap.m themelib_sap_fiori_3 # [...]
If you are using Git or similar version control, commit
ui5.yamlto your repository.
Hooray! 🎉 You can now use the UI5 Tooling in your project!
ui5 serve to start a local development server or use
ui5 build --all to create an optimized version of your project, including all of its dependencies which you can deploy from the created