Skip to content

UI5 logo

UI5 Tooling

An open and modular toolchain to develop state-of-the-art applications based on the UI5 framework.

๐Ÿ”ฅ โžก๏ธ Get Started


๐Ÿ’ป UI5 CLI

Also see the CLI Documentation

npm install --global @ui5/cli

โš™๏ธ Setup Project

Configure your project for use with the UI5 Tooling.
Also see the Configuration Documentation

โฏ ui5 init
Wrote ui5.yaml:

specVersion: '2.2'
  name: my-app
type: application

๐Ÿšš Add Dependencies

โฏ ui5 use SAPUI5@1.76.0
Updated configuration written to ui5.yaml
This project is now using SAPUI5 version 1.76.0

โฏ ui5 add sap.ui.core sap.m themelib_sap_fiori_3
Updated configuration written to ui5.yaml
Added framework libraries sap.ui.core sap.m themelib_sap_fiori_3 as dependencies

๐Ÿ„ Server

Start a local development server.
Also see the Server Documentation

โฏ ui5 serve
Server started
URL: http://localhost:8080

๐Ÿ›  Builder

Build a production-ready package of your project.
Also see the Builder Documentation

โฏ ui5 build
Building my-app...
๐Ÿ”จ (1/8) Running task escapeNonAsciiCharacters...
๐Ÿ”จ (2/8) Running task replaceCopyright...
๐Ÿ”จ (3/8) Running task replaceVersion...
๐Ÿ”จ (4/8) Running task generateFlexChangesBundle...
๐Ÿ”จ (5/8) Running task generateComponentPreload...
๐Ÿ”จ (6/8) Running task createDebugFiles...
๐Ÿ”จ (7/8) Running task uglify...
๐Ÿ”จ (8/8) Running task generateVersionInfo...
Build succeeded in 363 ms

๐Ÿงช Node.js API

All UI5 Tooling modules provide JavaScript APIs available for direct consumption. They are documented in the UI5 Tooling API Reference.