Conversation
d3xter666
marked this pull request as draft
September 17, 2026 12:53
Member
Author
|
This is the diff of the diff --git a/CLI.md b/CLI.md
index 01772959..43c8ef89 100644
--- a/CLI.md
+++ b/CLI.md
@@ -150,6 +150,123 @@ Build project by applying all default tasks including the minify task and exclud
```
ui5 build --include-task=minify --exclude-task=generateComponentPreload
```
+### ui5 build jsdoc
+
+**Description**
+
+Build JSDoc resources
+
+**Usage**
+
+`
+ui5 build jsdoc
+`
+
+
+**Options**
+
+| Option | Description | Details |
+| --- | --- | --- |
+| -c, --config | Path to project configuration file in YAML format | [string] |
+| --dependency-definition | Path to a YAML file containing the project's dependency tree. This option will disable resolution of node package dependencies. | [string] |
+| --workspace-config | Path to workspace configuration file in YAML format | [string] |
+| -w, --workspace | Name of the workspace configuration to use | [string] [default: "default"] |
+| --include-task | A list of tasks to be added to the default execution set. This option takes precedence over any excludes. | [array] |
+| --exclude-task | A list of tasks to be excluded from the default task execution set | [array] |
+| -a, --include-all-dependencies, --all | Include all dependencies in the build result. This is equivalent to '--include-dependency "*"' | [boolean] [default: false] |
+| --include-dependency | A list of dependencies to be included in the build result. You can use the asterisk '*' as an alias for including all dependencies in the build result. The listed dependencies cannot be overruled by dependencies defined in 'exclude-dependency'. The provided name must match with the dependency name shown in 'ui5 ls --flat' | [array] |
+| --include-dependency-regexp | A list of regular expressions defining dependencies to be included in the build result. This list is prioritized like 'include-dependency'. | [array] |
+| --include-dependency-tree | A list of dependencies to be included in the build result. Transitive dependencies are implicitly included and do not need to be part of this list. These dependencies overrule the selection of 'exclude-dependency-tree' but can be overruled by 'exclude-dependency'. | [array] |
+| --exclude-dependency | A list of dependencies to be excluded from the build result. The listed dependencies can be overruled by dependencies defined in 'include-dependency'. The provided name must match with the dependency name shown in 'ui5 ls --flat' | [array] |
+| --exclude-dependency-regexp | A list of regular expressions defining dependencies to be excluded from the build result. This list is prioritized like 'exclude-dependency'. | [array] |
+| --exclude-dependency-tree | A list of dependencies to be excluded from the build result. Transitive dependencies are implicitly included and do not need to be part of this list. | [array] |
+| --dest | Path of build destination | [string] [default: "./dist"] |
+| --clean-dest | If present, clean the destination directory before building | [boolean] [default: false] |
+| --cache | Cache mode to use for building UI5 projects. The 'Default' behavior is to always use the cache if available. 'Force' uses the cache only. If the cache is unavailable or invalid, the build fails. 'ReadOnly' does not create or update any cache but makes use of a cache if available. 'Off' does not use any cache and always triggers a rebuild of the project | [string] [choices: "Default", "Force", "ReadOnly", "Off"] [default: "Default"] |
+| --create-build-manifest | Store build metadata in a '.ui5' directory in the build destination, allowing reuse of the build result in other builds | [boolean] [default: false] |
+| --framework-version | Overrides the framework version defined by the project. Takes the same value as the version part of "ui5 use" | [string] |
+| --snapshot-cache | Cache mode to use when consuming SNAPSHOT versions of framework dependencies. The 'Default' behavior is to invalidate the cache after 9 hours. 'Force' uses the cache only and does not create any requests. 'Off' invalidates any existing cache and updates from the repository | [string] [choices: "Default", "Force", "Off"] [default: Default] |
+| --output-style | Processes build results into a specific directory structure.<br>- Flat: Omits the project namespace and the "resources" directory.<br>- Namespace: Respects the project namespace and the "resources" directory, maintaining the original structure.<br>- Default: The default directory structure for every project type. For applications, this is identical to "Flat", and for libraries, it is "Namespace". Other types have a more distinct default output style. | [string] [choices: "Default", "Flat", "Namespace"] [default: "Default"] |
+
+
+### ui5 build preload
+
+**Description**
+
+(default) Build project and create preload bundles
+
+**Usage**
+
+`
+ui5 build preload
+`
+
+
+**Options**
+
+| Option | Description | Details |
+| --- | --- | --- |
+| -c, --config | Path to project configuration file in YAML format | [string] |
+| --dependency-definition | Path to a YAML file containing the project's dependency tree. This option will disable resolution of node package dependencies. | [string] |
+| --workspace-config | Path to workspace configuration file in YAML format | [string] |
+| -w, --workspace | Name of the workspace configuration to use | [string] [default: "default"] |
+| --include-task | A list of tasks to be added to the default execution set. This option takes precedence over any excludes. | [array] |
+| --exclude-task | A list of tasks to be excluded from the default task execution set | [array] |
+| -a, --include-all-dependencies, --all | Include all dependencies in the build result. This is equivalent to '--include-dependency "*"' | [boolean] [default: false] |
+| --include-dependency | A list of dependencies to be included in the build result. You can use the asterisk '*' as an alias for including all dependencies in the build result. The listed dependencies cannot be overruled by dependencies defined in 'exclude-dependency'. The provided name must match with the dependency name shown in 'ui5 ls --flat' | [array] |
+| --include-dependency-regexp | A list of regular expressions defining dependencies to be included in the build result. This list is prioritized like 'include-dependency'. | [array] |
+| --include-dependency-tree | A list of dependencies to be included in the build result. Transitive dependencies are implicitly included and do not need to be part of this list. These dependencies overrule the selection of 'exclude-dependency-tree' but can be overruled by 'exclude-dependency'. | [array] |
+| --exclude-dependency | A list of dependencies to be excluded from the build result. The listed dependencies can be overruled by dependencies defined in 'include-dependency'. The provided name must match with the dependency name shown in 'ui5 ls --flat' | [array] |
+| --exclude-dependency-regexp | A list of regular expressions defining dependencies to be excluded from the build result. This list is prioritized like 'exclude-dependency'. | [array] |
+| --exclude-dependency-tree | A list of dependencies to be excluded from the build result. Transitive dependencies are implicitly included and do not need to be part of this list. | [array] |
+| --dest | Path of build destination | [string] [default: "./dist"] |
+| --clean-dest | If present, clean the destination directory before building | [boolean] [default: false] |
+| --cache | Cache mode to use for building UI5 projects. The 'Default' behavior is to always use the cache if available. 'Force' uses the cache only. If the cache is unavailable or invalid, the build fails. 'ReadOnly' does not create or update any cache but makes use of a cache if available. 'Off' does not use any cache and always triggers a rebuild of the project | [string] [choices: "Default", "Force", "ReadOnly", "Off"] [default: "Default"] |
+| --create-build-manifest | Store build metadata in a '.ui5' directory in the build destination, allowing reuse of the build result in other builds | [boolean] [default: false] |
+| --framework-version | Overrides the framework version defined by the project. Takes the same value as the version part of "ui5 use" | [string] |
+| --snapshot-cache | Cache mode to use when consuming SNAPSHOT versions of framework dependencies. The 'Default' behavior is to invalidate the cache after 9 hours. 'Force' uses the cache only and does not create any requests. 'Off' invalidates any existing cache and updates from the repository | [string] [choices: "Default", "Force", "Off"] [default: Default] |
+| --output-style | Processes build results into a specific directory structure.<br>- Flat: Omits the project namespace and the "resources" directory.<br>- Namespace: Respects the project namespace and the "resources" directory, maintaining the original structure.<br>- Default: The default directory structure for every project type. For applications, this is identical to "Flat", and for libraries, it is "Namespace". Other types have a more distinct default output style. | [string] [choices: "Default", "Flat", "Namespace"] [default: "Default"] |
+
+
+### ui5 build self-contained
+
+**Description**
+
+Build project and create self-contained bundle. Recommended to be used in conjunction with --include-all-dependencies
+
+**Usage**
+
+`
+ui5 build self-contained
+`
+
+
+**Options**
+
+| Option | Description | Details |
+| --- | --- | --- |
+| -c, --config | Path to project configuration file in YAML format | [string] |
+| --dependency-definition | Path to a YAML file containing the project's dependency tree. This option will disable resolution of node package dependencies. | [string] |
+| --workspace-config | Path to workspace configuration file in YAML format | [string] |
+| -w, --workspace | Name of the workspace configuration to use | [string] [default: "default"] |
+| --include-task | A list of tasks to be added to the default execution set. This option takes precedence over any excludes. | [array] |
+| --exclude-task | A list of tasks to be excluded from the default task execution set | [array] |
+| -a, --include-all-dependencies, --all | Include all dependencies in the build result. This is equivalent to '--include-dependency "*"' | [boolean] [default: false] |
+| --include-dependency | A list of dependencies to be included in the build result. You can use the asterisk '*' as an alias for including all dependencies in the build result. The listed dependencies cannot be overruled by dependencies defined in 'exclude-dependency'. The provided name must match with the dependency name shown in 'ui5 ls --flat' | [array] |
+| --include-dependency-regexp | A list of regular expressions defining dependencies to be included in the build result. This list is prioritized like 'include-dependency'. | [array] |
+| --include-dependency-tree | A list of dependencies to be included in the build result. Transitive dependencies are implicitly included and do not need to be part of this list. These dependencies overrule the selection of 'exclude-dependency-tree' but can be overruled by 'exclude-dependency'. | [array] |
+| --exclude-dependency | A list of dependencies to be excluded from the build result. The listed dependencies can be overruled by dependencies defined in 'include-dependency'. The provided name must match with the dependency name shown in 'ui5 ls --flat' | [array] |
+| --exclude-dependency-regexp | A list of regular expressions defining dependencies to be excluded from the build result. This list is prioritized like 'exclude-dependency'. | [array] |
+| --exclude-dependency-tree | A list of dependencies to be excluded from the build result. Transitive dependencies are implicitly included and do not need to be part of this list. | [array] |
+| --dest | Path of build destination | [string] [default: "./dist"] |
+| --clean-dest | If present, clean the destination directory before building | [boolean] [default: false] |
+| --cache | Cache mode to use for building UI5 projects. The 'Default' behavior is to always use the cache if available. 'Force' uses the cache only. If the cache is unavailable or invalid, the build fails. 'ReadOnly' does not create or update any cache but makes use of a cache if available. 'Off' does not use any cache and always triggers a rebuild of the project | [string] [choices: "Default", "Force", "ReadOnly", "Off"] [default: "Default"] |
+| --create-build-manifest | Store build metadata in a '.ui5' directory in the build destination, allowing reuse of the build result in other builds | [boolean] [default: false] |
+| --framework-version | Overrides the framework version defined by the project. Takes the same value as the version part of "ui5 use" | [string] |
+| --snapshot-cache | Cache mode to use when consuming SNAPSHOT versions of framework dependencies. The 'Default' behavior is to invalidate the cache after 9 hours. 'Force' uses the cache only and does not create any requests. 'Off' invalidates any existing cache and updates from the repository | [string] [choices: "Default", "Force", "Off"] [default: Default] |
+| --output-style | Processes build results into a specific directory structure.<br>- Flat: Omits the project namespace and the "resources" directory.<br>- Namespace: Respects the project namespace and the "resources" directory, maintaining the original structure.<br>- Default: The default directory structure for every project type. For applications, this is identical to "Flat", and for libraries, it is "Namespace". Other types have a more distinct default output style. | [string] [choices: "Default", "Flat", "Namespace"] [default: "Default"] |
+
+
### ui5 cache
**Description**
@@ -162,9 +279,44 @@ Manage the UI5 CLI cache (downloaded framework packages and build data)
ui5 cache
`
+**Child Commands**
+
+| Command | Description |
+| --- | --- |
+| ui5 cache clean | Remove all cached UI5 data |
+
+
+
+### ui5 cache clean
+
+**Description**
+
+Usage: ui5 cache clean [options]
+
+**Usage**
+
+`
+WARNING: Only run ui5 cache clean when no UI5 CLI process and no @ui5/* API consumer is actively running.
+Running ui5 cache clean while ui5 build or ui5 serve is in progress can break the running process and lead to failed or inconsistent results.
+`
+
+**Examples**
+
+Remove all cached UI5 data after confirmation
+```
+ui5 cache clean
+```
+Remove all cached UI5 data without confirmation (e.g. in CI scenarios)
+```
+ui5 cache clean --force
+```
+Remove cached data from a non-default UI5 data directory
+```
+UI5_DATA_DIR=/custom/path ui5 cache clean
+```
### ui5 certificate
**Description**
@@ -177,9 +329,50 @@ Manage the UI5 CLI server certificate
ui5 certificate
`
+**Child Commands**
+
+| Command | Description |
+| --- | --- |
+| ui5 certificate generate | Generate a self-signed server certificate and install it into the trust store |
+
+
+
+### ui5 certificate generate
+
+**Description**
+
+Generate a self-signed server certificate and install it into the trust store
+
+**Usage**
+
+`
+ui5 certificate generate
+`
+
+
+**Options**
+| Option | Description | Details |
+| --- | --- | --- |
+| --key | Path the private key is written to | [string] [default: ~/.ui5/server/server.key] |
+| --cert | Path the certificate is written to | [string] [default: ~/.ui5/server/server.crt] |
+| -f, --force | Generate a new certificate even if one already exists at the target path | [boolean] [default: false] |
+**Examples**
+
+Generate a server certificate in the default UI5 data directory
+```
+ui5 certificate generate
+```
+Regenerate the server certificate, overwriting an existing one
+```
+ui5 certificate generate --force
+```
+Generate a server certificate in a non-default UI5 data directory
+```
+UI5_DATA_DIR=/custom/path ui5 certificate generate
+```
### ui5 config
**Description**
@@ -212,6 +405,21 @@ Unset the current value of the ui5DataDir configuration
```
ui5 config set ui5DataDir
```
+### ui5 config list
+
+**Description**
+
+Display the current configuration
+
+**Usage**
+
+`
+ui5 config list
+`
+
+
+
+
### ui5 init
**Description**
@@ -325,6 +533,8 @@ ui5 serve --port 1337 --open tests/QUnit.html
Outputs the dependency tree of the current project to stdout. It takes all relevant parameters of ui5 build into account.
+**Aliases**: `ui5 ls`, `ui5 list`
+
**Usage**
`
@@ -344,7 +554,6 @@ ui5 tree
| --level | Limit the number of levels shown in the tree hierarchy | [number] |
| --framework-version | Overrides the framework version defined by the project. Takes the same value as the version part of "ui5 use" | [string] |
| --snapshot-cache | Cache mode to use when consuming SNAPSHOT versions of framework dependencies. The 'Default' behavior is to invalidate the cache after 9 hours. 'Force' uses the cache only and does not create any requests. 'Off' invalidates any existing cache and updates from the repository | [string] [choices: "Default", "Force", "Off"] [default: Default] |
-| | | |
### ui5 use |
Member
Author
Rendered new
|
| Option | Description | Details |
|---|---|---|
| -h, --help | Show help | [boolean] |
| -v, --version | Show version number | [boolean] |
| --loglevel, --log-level | Set the logging level | [string] [choices: "silent", "error", "warn", "info", "perf", "verbose", "silly"] [default: "info"] |
| --verbose | Enable verbose logging. | [boolean] [default: false] |
| --perf | Enable performance measurements and related logging. | [boolean] [default: false] |
| --silent | Disable all log output. | [boolean] [default: false] |
Examples
Execute command with the maximum log output
ui5 <command> --log-level silly
Commands
ui5 add
Description
Add SAPUI5/OpenUI5 framework libraries to the project configuration.
Usage
ui5 add [--development] [--optional] <framework-libraries..>
Options
| Option | Description | Details |
|---|---|---|
| -c, --config | Path to project configuration file in YAML format | [string] |
| --dependency-definition | Path to a YAML file containing the project's dependency tree. This option will disable resolution of node package dependencies. | [string] |
| -D, --development, --dev | Add as development dependency | [boolean] [default: false] |
| -O, --optional | Add as optional dependency | [boolean] [default: false] |
Positionals
| Positional | Description | Details |
|---|---|---|
| framework-libraries | Framework library names | [array] [required] [default: []] |
Examples
Add the framework libraries sap.ui.core and sap.m as dependencies
ui5 add sap.ui.core sap.m
Add the framework library sap.ui.support as development dependency
ui5 add -D sap.ui.support
Add the framework library themelib_sap_fiori_3 as optional dependency
ui5 add --optional themelib_sap_fiori_3
ui5 build
Description
Build project in current directory
Usage
ui5 build
Child Commands
| Command | Description |
|---|---|
| ui5 build jsdoc | Build JSDoc resources |
| ui5 build preload | (default) Build project and create preload bundles |
| ui5 build self-contained | Build project and create self-contained bundle. Recommended to be used in conjunction with --include-all-dependencies |
Options
| Option | Description | Details |
|---|---|---|
| -c, --config | Path to project configuration file in YAML format | [string] |
| --dependency-definition | Path to a YAML file containing the project's dependency tree. This option will disable resolution of node package dependencies. | [string] |
| --workspace-config | Path to workspace configuration file in YAML format | [string] |
| -w, --workspace | Name of the workspace configuration to use | [string] [default: "default"] |
| --include-task | A list of tasks to be added to the default execution set. This option takes precedence over any excludes. | [array] |
| --exclude-task | A list of tasks to be excluded from the default task execution set | [array] |
| -a, --include-all-dependencies, --all | Include all dependencies in the build result. This is equivalent to '--include-dependency "*"' | [boolean] [default: false] |
| --include-dependency | A list of dependencies to be included in the build result. You can use the asterisk '*' as an alias for including all dependencies in the build result. The listed dependencies cannot be overruled by dependencies defined in 'exclude-dependency'. The provided name must match with the dependency name shown in 'ui5 ls --flat' | [array] |
| --include-dependency-regexp | A list of regular expressions defining dependencies to be included in the build result. This list is prioritized like 'include-dependency'. | [array] |
| --include-dependency-tree | A list of dependencies to be included in the build result. Transitive dependencies are implicitly included and do not need to be part of this list. These dependencies overrule the selection of 'exclude-dependency-tree' but can be overruled by 'exclude-dependency'. | [array] |
| --exclude-dependency | A list of dependencies to be excluded from the build result. The listed dependencies can be overruled by dependencies defined in 'include-dependency'. The provided name must match with the dependency name shown in 'ui5 ls --flat' | [array] |
| --exclude-dependency-regexp | A list of regular expressions defining dependencies to be excluded from the build result. This list is prioritized like 'exclude-dependency'. | [array] |
| --exclude-dependency-tree | A list of dependencies to be excluded from the build result. Transitive dependencies are implicitly included and do not need to be part of this list. | [array] |
| --dest | Path of build destination | [string] [default: "./dist"] |
| --clean-dest | If present, clean the destination directory before building | [boolean] [default: false] |
| --cache | Cache mode to use for building UI5 projects. The 'Default' behavior is to always use the cache if available. 'Force' uses the cache only. If the cache is unavailable or invalid, the build fails. 'ReadOnly' does not create or update any cache but makes use of a cache if available. 'Off' does not use any cache and always triggers a rebuild of the project | [string] [choices: "Default", "Force", "ReadOnly", "Off"] [default: "Default"] |
| --create-build-manifest | Store build metadata in a '.ui5' directory in the build destination, allowing reuse of the build result in other builds | [boolean] [default: false] |
| --framework-version | Overrides the framework version defined by the project. Takes the same value as the version part of "ui5 use" | [string] |
| --snapshot-cache | Cache mode to use when consuming SNAPSHOT versions of framework dependencies. The 'Default' behavior is to invalidate the cache after 9 hours. 'Force' uses the cache only and does not create any requests. 'Off' invalidates any existing cache and updates from the repository | [string] [choices: "Default", "Force", "Off"] [default: Default] |
| --output-style | Processes build results into a specific directory structure. - Flat: Omits the project namespace and the "resources" directory. - Namespace: Respects the project namespace and the "resources" directory, maintaining the original structure. - Default: The default directory structure for every project type. For applications, this is identical to "Flat", and for libraries, it is "Namespace". Other types have a more distinct default output style. |
[string] [choices: "Default", "Flat", "Namespace"] [default: "Default"] |
Examples
Preload build for project without dependencies
ui5 build
Self-contained build for project
ui5 build self-contained
Build project but only apply the minify- and generateComponentPreload tasks
ui5 build --exclude-task=* --include-task=minify generateComponentPreload
Build project by applying all default tasks including the minify task and excluding the generateComponentPreload task
ui5 build --include-task=minify --exclude-task=generateComponentPreload
ui5 build jsdoc
Description
Build JSDoc resources
Usage
ui5 build jsdoc
Options
| Option | Description | Details |
|---|---|---|
| -c, --config | Path to project configuration file in YAML format | [string] |
| --dependency-definition | Path to a YAML file containing the project's dependency tree. This option will disable resolution of node package dependencies. | [string] |
| --workspace-config | Path to workspace configuration file in YAML format | [string] |
| -w, --workspace | Name of the workspace configuration to use | [string] [default: "default"] |
| --include-task | A list of tasks to be added to the default execution set. This option takes precedence over any excludes. | [array] |
| --exclude-task | A list of tasks to be excluded from the default task execution set | [array] |
| -a, --include-all-dependencies, --all | Include all dependencies in the build result. This is equivalent to '--include-dependency "*"' | [boolean] [default: false] |
| --include-dependency | A list of dependencies to be included in the build result. You can use the asterisk '*' as an alias for including all dependencies in the build result. The listed dependencies cannot be overruled by dependencies defined in 'exclude-dependency'. The provided name must match with the dependency name shown in 'ui5 ls --flat' | [array] |
| --include-dependency-regexp | A list of regular expressions defining dependencies to be included in the build result. This list is prioritized like 'include-dependency'. | [array] |
| --include-dependency-tree | A list of dependencies to be included in the build result. Transitive dependencies are implicitly included and do not need to be part of this list. These dependencies overrule the selection of 'exclude-dependency-tree' but can be overruled by 'exclude-dependency'. | [array] |
| --exclude-dependency | A list of dependencies to be excluded from the build result. The listed dependencies can be overruled by dependencies defined in 'include-dependency'. The provided name must match with the dependency name shown in 'ui5 ls --flat' | [array] |
| --exclude-dependency-regexp | A list of regular expressions defining dependencies to be excluded from the build result. This list is prioritized like 'exclude-dependency'. | [array] |
| --exclude-dependency-tree | A list of dependencies to be excluded from the build result. Transitive dependencies are implicitly included and do not need to be part of this list. | [array] |
| --dest | Path of build destination | [string] [default: "./dist"] |
| --clean-dest | If present, clean the destination directory before building | [boolean] [default: false] |
| --cache | Cache mode to use for building UI5 projects. The 'Default' behavior is to always use the cache if available. 'Force' uses the cache only. If the cache is unavailable or invalid, the build fails. 'ReadOnly' does not create or update any cache but makes use of a cache if available. 'Off' does not use any cache and always triggers a rebuild of the project | [string] [choices: "Default", "Force", "ReadOnly", "Off"] [default: "Default"] |
| --create-build-manifest | Store build metadata in a '.ui5' directory in the build destination, allowing reuse of the build result in other builds | [boolean] [default: false] |
| --framework-version | Overrides the framework version defined by the project. Takes the same value as the version part of "ui5 use" | [string] |
| --snapshot-cache | Cache mode to use when consuming SNAPSHOT versions of framework dependencies. The 'Default' behavior is to invalidate the cache after 9 hours. 'Force' uses the cache only and does not create any requests. 'Off' invalidates any existing cache and updates from the repository | [string] [choices: "Default", "Force", "Off"] [default: Default] |
| --output-style | Processes build results into a specific directory structure. - Flat: Omits the project namespace and the "resources" directory. - Namespace: Respects the project namespace and the "resources" directory, maintaining the original structure. - Default: The default directory structure for every project type. For applications, this is identical to "Flat", and for libraries, it is "Namespace". Other types have a more distinct default output style. |
[string] [choices: "Default", "Flat", "Namespace"] [default: "Default"] |
ui5 build preload
Description
(default) Build project and create preload bundles
Usage
ui5 build preload
Options
| Option | Description | Details |
|---|---|---|
| -c, --config | Path to project configuration file in YAML format | [string] |
| --dependency-definition | Path to a YAML file containing the project's dependency tree. This option will disable resolution of node package dependencies. | [string] |
| --workspace-config | Path to workspace configuration file in YAML format | [string] |
| -w, --workspace | Name of the workspace configuration to use | [string] [default: "default"] |
| --include-task | A list of tasks to be added to the default execution set. This option takes precedence over any excludes. | [array] |
| --exclude-task | A list of tasks to be excluded from the default task execution set | [array] |
| -a, --include-all-dependencies, --all | Include all dependencies in the build result. This is equivalent to '--include-dependency "*"' | [boolean] [default: false] |
| --include-dependency | A list of dependencies to be included in the build result. You can use the asterisk '*' as an alias for including all dependencies in the build result. The listed dependencies cannot be overruled by dependencies defined in 'exclude-dependency'. The provided name must match with the dependency name shown in 'ui5 ls --flat' | [array] |
| --include-dependency-regexp | A list of regular expressions defining dependencies to be included in the build result. This list is prioritized like 'include-dependency'. | [array] |
| --include-dependency-tree | A list of dependencies to be included in the build result. Transitive dependencies are implicitly included and do not need to be part of this list. These dependencies overrule the selection of 'exclude-dependency-tree' but can be overruled by 'exclude-dependency'. | [array] |
| --exclude-dependency | A list of dependencies to be excluded from the build result. The listed dependencies can be overruled by dependencies defined in 'include-dependency'. The provided name must match with the dependency name shown in 'ui5 ls --flat' | [array] |
| --exclude-dependency-regexp | A list of regular expressions defining dependencies to be excluded from the build result. This list is prioritized like 'exclude-dependency'. | [array] |
| --exclude-dependency-tree | A list of dependencies to be excluded from the build result. Transitive dependencies are implicitly included and do not need to be part of this list. | [array] |
| --dest | Path of build destination | [string] [default: "./dist"] |
| --clean-dest | If present, clean the destination directory before building | [boolean] [default: false] |
| --cache | Cache mode to use for building UI5 projects. The 'Default' behavior is to always use the cache if available. 'Force' uses the cache only. If the cache is unavailable or invalid, the build fails. 'ReadOnly' does not create or update any cache but makes use of a cache if available. 'Off' does not use any cache and always triggers a rebuild of the project | [string] [choices: "Default", "Force", "ReadOnly", "Off"] [default: "Default"] |
| --create-build-manifest | Store build metadata in a '.ui5' directory in the build destination, allowing reuse of the build result in other builds | [boolean] [default: false] |
| --framework-version | Overrides the framework version defined by the project. Takes the same value as the version part of "ui5 use" | [string] |
| --snapshot-cache | Cache mode to use when consuming SNAPSHOT versions of framework dependencies. The 'Default' behavior is to invalidate the cache after 9 hours. 'Force' uses the cache only and does not create any requests. 'Off' invalidates any existing cache and updates from the repository | [string] [choices: "Default", "Force", "Off"] [default: Default] |
| --output-style | Processes build results into a specific directory structure. - Flat: Omits the project namespace and the "resources" directory. - Namespace: Respects the project namespace and the "resources" directory, maintaining the original structure. - Default: The default directory structure for every project type. For applications, this is identical to "Flat", and for libraries, it is "Namespace". Other types have a more distinct default output style. |
[string] [choices: "Default", "Flat", "Namespace"] [default: "Default"] |
ui5 build self-contained
Description
Build project and create self-contained bundle. Recommended to be used in conjunction with --include-all-dependencies
Usage
ui5 build self-contained
Options
| Option | Description | Details |
|---|---|---|
| -c, --config | Path to project configuration file in YAML format | [string] |
| --dependency-definition | Path to a YAML file containing the project's dependency tree. This option will disable resolution of node package dependencies. | [string] |
| --workspace-config | Path to workspace configuration file in YAML format | [string] |
| -w, --workspace | Name of the workspace configuration to use | [string] [default: "default"] |
| --include-task | A list of tasks to be added to the default execution set. This option takes precedence over any excludes. | [array] |
| --exclude-task | A list of tasks to be excluded from the default task execution set | [array] |
| -a, --include-all-dependencies, --all | Include all dependencies in the build result. This is equivalent to '--include-dependency "*"' | [boolean] [default: false] |
| --include-dependency | A list of dependencies to be included in the build result. You can use the asterisk '*' as an alias for including all dependencies in the build result. The listed dependencies cannot be overruled by dependencies defined in 'exclude-dependency'. The provided name must match with the dependency name shown in 'ui5 ls --flat' | [array] |
| --include-dependency-regexp | A list of regular expressions defining dependencies to be included in the build result. This list is prioritized like 'include-dependency'. | [array] |
| --include-dependency-tree | A list of dependencies to be included in the build result. Transitive dependencies are implicitly included and do not need to be part of this list. These dependencies overrule the selection of 'exclude-dependency-tree' but can be overruled by 'exclude-dependency'. | [array] |
| --exclude-dependency | A list of dependencies to be excluded from the build result. The listed dependencies can be overruled by dependencies defined in 'include-dependency'. The provided name must match with the dependency name shown in 'ui5 ls --flat' | [array] |
| --exclude-dependency-regexp | A list of regular expressions defining dependencies to be excluded from the build result. This list is prioritized like 'exclude-dependency'. | [array] |
| --exclude-dependency-tree | A list of dependencies to be excluded from the build result. Transitive dependencies are implicitly included and do not need to be part of this list. | [array] |
| --dest | Path of build destination | [string] [default: "./dist"] |
| --clean-dest | If present, clean the destination directory before building | [boolean] [default: false] |
| --cache | Cache mode to use for building UI5 projects. The 'Default' behavior is to always use the cache if available. 'Force' uses the cache only. If the cache is unavailable or invalid, the build fails. 'ReadOnly' does not create or update any cache but makes use of a cache if available. 'Off' does not use any cache and always triggers a rebuild of the project | [string] [choices: "Default", "Force", "ReadOnly", "Off"] [default: "Default"] |
| --create-build-manifest | Store build metadata in a '.ui5' directory in the build destination, allowing reuse of the build result in other builds | [boolean] [default: false] |
| --framework-version | Overrides the framework version defined by the project. Takes the same value as the version part of "ui5 use" | [string] |
| --snapshot-cache | Cache mode to use when consuming SNAPSHOT versions of framework dependencies. The 'Default' behavior is to invalidate the cache after 9 hours. 'Force' uses the cache only and does not create any requests. 'Off' invalidates any existing cache and updates from the repository | [string] [choices: "Default", "Force", "Off"] [default: Default] |
| --output-style | Processes build results into a specific directory structure. - Flat: Omits the project namespace and the "resources" directory. - Namespace: Respects the project namespace and the "resources" directory, maintaining the original structure. - Default: The default directory structure for every project type. For applications, this is identical to "Flat", and for libraries, it is "Namespace". Other types have a more distinct default output style. |
[string] [choices: "Default", "Flat", "Namespace"] [default: "Default"] |
ui5 cache
Description
Manage the UI5 CLI cache (downloaded framework packages and build data)
Usage
ui5 cache
Child Commands
| Command | Description |
|---|---|
| ui5 cache clean | Remove all cached UI5 data |
ui5 cache clean
Description
Usage: ui5 cache clean [options]
Usage
WARNING: Only run ui5 cache clean when no UI5 CLI process and no @ui5/* API consumer is actively running. Running ui5 cache clean while ui5 build or ui5 serve is in progress can break the running process and lead to failed or inconsistent results.
Examples
Remove all cached UI5 data after confirmation
ui5 cache clean
Remove all cached UI5 data without confirmation (e.g. in CI scenarios)
ui5 cache clean --force
Remove cached data from a non-default UI5 data directory
UI5_DATA_DIR=/custom/path ui5 cache clean
ui5 certificate
Description
Manage the UI5 CLI server certificate
Usage
ui5 certificate
Child Commands
| Command | Description |
|---|---|
| ui5 certificate generate | Generate a self-signed server certificate and install it into the trust store |
ui5 certificate generate
Description
Generate a self-signed server certificate and install it into the trust store
Usage
ui5 certificate generate
Options
| Option | Description | Details |
|---|---|---|
| --key | Path the private key is written to | [string] [default: ~/.ui5/server/server.key] |
| --cert | Path the certificate is written to | [string] [default: ~/.ui5/server/server.crt] |
| -f, --force | Generate a new certificate even if one already exists at the target path | [boolean] [default: false] |
Examples
Generate a server certificate in the default UI5 data directory
ui5 certificate generate
Regenerate the server certificate, overwriting an existing one
ui5 certificate generate --force
Generate a server certificate in a non-default UI5 data directory
UI5_DATA_DIR=/custom/path ui5 certificate generate
ui5 config
Description
Get and set UI5 CLI configuration options
Usage
ui5 config
Child Commands
| Command | Description |
|---|---|
| ui5 config set <option> [value] | Set the value for a given configuration option. Clear an existing configuration by omitting the value |
| ui5 config get <option> | Get the value for a given configuration option |
| ui5 config list | Display the current configuration |
Examples
Set a value for the ui5DataDir configuration
ui5 config set ui5DataDir /path/to/.ui5
Unset the current value of the ui5DataDir configuration
ui5 config set ui5DataDir
ui5 config list
Description
Display the current configuration
Usage
ui5 config list
ui5 init
Description
Initialize the UI5 CLI configuration for an application or library project.
Usage
ui5 init
ui5 remove
Description
Remove SAPUI5/OpenUI5 framework libraries from the project configuration.
Usage
ui5 remove <framework-libraries..>
Options
| Option | Description | Details |
|---|---|---|
| -c, --config | Path to project configuration file in YAML format | [string] |
| --dependency-definition | Path to a YAML file containing the project's dependency tree. This option will disable resolution of node package dependencies. | [string] |
Positionals
| Positional | Description | Details |
|---|---|---|
| framework-libraries | Framework library names | [array] [required] [default: []] |
Examples
Remove the framework libraries sap.ui.core and sap.m as dependencies
ui5 remove sap.ui.core sap.m
ui5 serve
Description
Start a web server for the current project
Usage
ui5 serve
Options
| Option | Description | Details |
|---|---|---|
| -c, --config | Path to project configuration file in YAML format | [string] |
| --dependency-definition | Path to a YAML file containing the project's dependency tree. This option will disable resolution of node package dependencies. | [string] |
| --workspace-config | Path to workspace configuration file in YAML format | [string] |
| -w, --workspace | Name of the workspace configuration to use | [string] [default: "default"] |
| --include-task | A list of tasks to be added to the default execution set. This option takes precedence over any excludes. | [array] |
| --exclude-task | A list of tasks to be excluded from the default task execution set | [array] |
| -p, --port | Port to bind on (default for HTTP: 8080, HTTPS: 8443) | [number] |
| -o, --open | Open web server root directory in default browser. Optionally, supplied relative path will be appended to the root URL | [string] |
| --https | Enable the HTTPS protocol for the web server | [boolean] [default: false] |
| --simple-index | Use a simplified view for the server directory listing | [boolean] [default: false] |
| --live-reload | Automatically reload the browser when project sources change. Overrides the 'liveReload' setting in the project's server configuration | [boolean] [default: true] |
| --accept-remote-connections | Accept remote connections. By default the server only accepts connections from localhost | [boolean] [default: false] |
| --key | Path to the private key | [string] [default: ~/.ui5/server/server.key] |
| --cert | Path to the certificate | [string] [default: ~/.ui5/server/server.crt] |
| --sap-csp-policies | Always send content security policies 'sap-target-level-1' and 'sap-target-level-3' in report-only mode | [boolean] [default: false] |
| --serve-csp-reports | Collects and serves CSP reports upon request to '/.ui5/csp/csp-reports.json' | [boolean] [default: false] |
| --cache | Cache mode to use for building UI5 projects. The 'Default' behavior is to always use the build-cache if available. 'Force' uses the cache only. If the build-cache is unavailable or invalid, the server will fail to build the project. 'ReadOnly' does not create or update any cache but makes use of a cache if available. 'Off' does not use any build-cache and always triggers a rebuild of the project | [string] [choices: "Default", "Force", "ReadOnly", "Off"] [default: "Default"] |
| --framework-version | Overrides the framework version defined by the project. Takes the same value as the version part of "ui5 use" | [string] |
| --snapshot-cache | Cache mode to use when consuming SNAPSHOT versions of framework dependencies. The 'Default' behavior is to invalidate the cache after 9 hours. 'Force' uses the cache only and does not create any requests. 'Off' invalidates any existing cache and updates from the repository | [string] [choices: "Default", "Force", "Off"] [default: Default] |
Examples
Start a web server for the current project
ui5 serve
Enable the HTTPS protocol for the web server (requires SSL certificate)
ui5 serve --https
Use the project configuration from a custom path
ui5 serve --config /path/to/ui5.yaml
Use a static dependency definition file
ui5 serve --dependency-definition /path/to/projectDependencies.yaml
Listen to port 1337 and launch default browser with http://localhost:1337/test/QUnit.html
ui5 serve --port 1337 --open tests/QUnit.html
ui5 tree
Description
Outputs the dependency tree of the current project to stdout. It takes all relevant parameters of ui5 build into account.
Aliases: ui5 ls, ui5 list
Usage
ui5 tree
Options
| Option | Description | Details |
|---|---|---|
| -c, --config | Path to project configuration file in YAML format | [string] |
| --dependency-definition | Path to a YAML file containing the project's dependency tree. This option will disable resolution of node package dependencies. | [string] |
| --workspace-config | Path to workspace configuration file in YAML format | [string] |
| -w, --workspace | Name of the workspace configuration to use | [string] [default: "default"] |
| --flat | Output a flat list of all dependencies instead of a tree hierarchy | [boolean] [default: false] |
| --level | Limit the number of levels shown in the tree hierarchy | [number] |
| --framework-version | Overrides the framework version defined by the project. Takes the same value as the version part of "ui5 use" | [string] |
| --snapshot-cache | Cache mode to use when consuming SNAPSHOT versions of framework dependencies. The 'Default' behavior is to invalidate the cache after 9 hours. 'Force' uses the cache only and does not create any requests. 'Off' invalidates any existing cache and updates from the repository | [string] [choices: "Default", "Force", "Off"] [default: Default] |
ui5 use
Description
Initialize or update the project's framework configuration.
Usage
ui5 use <framework-info>
Options
| Option | Description | Details |
|---|---|---|
| -c, --config | Path to project configuration file in YAML format | [string] |
| --dependency-definition | Path to a YAML file containing the project's dependency tree. This option will disable resolution of node package dependencies. | [string] |
Positionals
| Positional | Description | Details |
|---|---|---|
| framework-info | Framework name, version or both (name@version). Name can be "SAPUI5" or "OpenUI5" (case-insensitive). Version can be "latest" (default), a version or range according to the Semantic Versioning specification (https://semver.org/), or a tag available in the npm registry. For SAP-internal usage the version can also be "latest-snapshot", a version or range ending with -SNAPSHOT, or a simplified range such as "1-SNAPSHOT", "1.x-SNAPSHOT" or "1.108-SNAPSHOT". |
[string] [required] |
Examples
Use SAPUI5 in the latest available version
ui5 use sapui5@latest
Use OpenUI5 in the latest available 1.76 patch version
ui5 use openui5@1.76
Use the latest available version of the configured framework
ui5 use latest
Use OpenUI5 in the latest available version
ui5 use openui5
ui5 versions
Description
Shows the versions of all UI5 CLI modules
Usage
ui5 versions
Local vs. Global Installation
In general, we recommend a global installation of the UI5 CLI (npm install --global @ui5/cli).
However, it makes sense to add the UI5 CLI as a devDependency (npm install --save-dev @ui5/cli) to a project's package.json. This ensures that every developer working on the project uses the same version of the UI5 CLI and your continuous integration environments also uses this version.
In case you have both, a local installation in one of your projects as well as a global installation, the UI5 CLI will always try to invoke the local installation. This is in part because npm scripts defined in your package.json will also always invoke the local installation.
This behavior can be disabled by setting the environment variable UI5_CLI_NO_LOCAL.
Example
You have a project located in the directory /my-application.
You have installed the UI5 CLI globally. In addition, the project's package.json defines a devDependency to @ui5/cli and a start script "ui5 serve". This means there are at least two installations of @ui5/cli on your system. Their versions might not match.
This table illustrates which of the two installations is used in different scenarios. Note how the UI5 CLI always tries to prefer the version installed in the project.
| Current Working Directory | Command | Global UI5 CLI | Local UI5 CLI |
|---|---|---|---|
/ |
ui5 --version |
enabled | |
/my-application |
ui5 --version |
enabled | |
/my-application |
ui5 serve |
enabled | |
/my-application |
UI5_CLI_NO_LOCAL=X ui5 serve |
enabled | |
/my-application |
npm start |
enabled | |
/my-application |
UI5_CLI_NO_LOCAL=X npm start |
enabled |
d3xter666
marked this pull request as ready for review
September 18, 2026 10:43
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
JIRA: CPOUI5FOUNDATION-1352