@sap-ux/create 0.13.160 → 0.13.162

package/README.md

@@ -1,194 +1,325 @@
-[![Changelog](https://img.shields.io/badge/changelog-8A2BE2)](https://github.com/SAP/open-ux-tools/blob/main/packages/create/CHANGELOG.md) [![Github repo](https://img.shields.io/badge/github-repo-blue)](https://github.com/SAP/open-ux-tools/tree/main/packages/create)
+[![Changelog](https://img.shields.io/badge/changelog-8A2BE2)](https://github.com/SAP/open-ux-tools/blob/main/packages/create/CHANGELOG.md) [![Github repo](https://img.shields.io/badge/github-repo-blue)](https://github.com/SAP/open-ux-tools/tree/main/packages/create)
+# [`@sap-ux/create`](https://github.com/SAP/open-ux-tools/tree/main/packages/create) CLI Reference
 
-# [`@sap-ux/create`](https://github.com/SAP/open-ux-tools/tree/main/packages/create)
-Module which provides command line interface to configure features for SAP UX projects or applications.
+Configure features for SAP Fiori applications and projects (@sap-ux/create version 0.13.161).
 
-## [Installation](#installation)
+# [Usage](#usage)
 
-```sh
-npm init @sap-ux@latest
-# or
-npx @sap-ux/create@latest
-```
-To avoid downloading and installing the module every time it is used, you might consider installing it globally or add it as `devDependency` to a project. Once installed, you can run it using
+It is recommended to use the cli using `npx` to always get the latest version without the need to install or update it manually. You can run it using:
 
 ```sh
-# globally installed
-sap-ux
-# locally
-npx sap-ux
+npx -y @sap-ux/create@latest [command] [sub-command] /path/to/project
 ```
-## [Basic usage](#basic-usage)
+
+If you prefer to download the module, you can install it globally or add it as `devDependency` to a project. Once installed, you can run it using
 
 ```sh
-npx sap-ux [command] [sub-command] /path/to/project
+# install globally
+npm i -g @sap-ux/create@latest
+# or install as devDependency
+npm i -D @sap-ux/create@latest
+# then run
+sap-ux [command] [sub-command] /path/to/project
 ```
-`Note:` If the project path is not provided, the current working directory will be used.
+
+`Note:` If the project path is not provided, the current working directory is used.
+
+---
+
+# [Commands](#commands)
+
+## [`generate`](#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`
+
+
+--------------------------------
+
+## [`generate adaptation-project`](#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:
-  - `-v | --version` output the module version number
-  - `-h | --help` display help and options for module
+- `-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.
 
-### [Command Options](#command-options)
+--------------------------------
 
-To use an option for a specific command run:
-```sh 
-npx sap-ux [command] [sub-command] [options]
-```
-To see options for a specific command run: `npx sap-ux [command] [sub-command] -h`
+## [`add`](#add)
 
-Common Options:
-- `-h | --help` display help and options for command
-- `-v | --verbose` show verbose information
-- `-s | --simulate` simulate only do not write config; sets also --verbose
+Command group for adding features to existing SAP Fiori applications. A subcommand is required.
 
-## [Command Overview](#command-overview)
-The `@sap-ux/create` modules provides commands for the following cases:
-- `sap-ux add` - allows adding a feature
-- `sap-ux change` allows changing a feature
-- `sap-ux convert` allows converting an app to a new feature
-- `sap-ux remove` allows removing a feature
-- `sap-ux generate` allows generating a new project
+Usage: `npx --yes @sap-ux/create@latest add [subcommand] [options]`
 
+The available subcommands are: `mockserver-config`, `smartlinks-config`, `cds-plugin-ui5`, `inbound-navigation`, `cards-editor`, `model`, `annotations`, `html`, `component-usages`, `deploy-config` and `variants-config`
 
-## [sap-ux add](#sap-ux-add)
-Calling `sap-ux add` allows adding a feature to a project.
 
+--------------------------------
 
-### [annotations](#add-annotations)<a id="add-annotations"></a>
-Calling `sap-ux add annotations` allows adding an annotation to the OData Source of the base application in an adaptation project.
-```sh
-sap-ux add annotations [path]
-```
-- `-c | --config` path to project configuration file in YAML format, e.g.: `-c ui5Custom.yaml`
+## [`add mockserver-config`](#add-mockserver-config)
 
+Add the necessary configuration for the `@sap-ux/ui5-middleware-fe-mockserver` mockserver module to enable local OData mocking.
 
-### [cards-editor](#add-cards-editor)<a id="add-cards-editor"></a>
-Calling `sap-ux add cards-editor` will add the necessary configuration to an existing yaml file and the script to package.json for cards generation.
-It will use the configuration from the yaml file passed by cli or default to ui5.yaml, as provided by the fiori-tools-preview or preview-middleware.
-```sh
-sap-ux add cards-editor [path]
-```
-- `-c | --config` path to project configuration file in YAML format, e.g.: -c ui5Custom.yaml
-`Note:` Adding the card generator configuration is not supported for CAP projects.
-- 
-### [component-usages](#add-component-usages)<a id="add-component-usages"></a>
-Calling `sap-ux add component-usages` adds the component usages to an adaptation project.
-```sh
-sap-ux add component-usages [path]
-```
+Example:
 
+`npx --yes @sap-ux/create@latest add mockserver-config`
 
-### [cds-plugin-ui5](#add-cds-plugin-ui5)<a id="add-cds-plugin-ui5"></a>
-Calling `sap-ux add cds-plugin-ui5` adds the cds-plugin-ui5 and all prerequisites to a CAP project.
-```sh
-sap-ux add cds-plugin-ui5 [path]
-```
-- `-n | --skip-install` skip npm install step
+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.
 
+--------------------------------
 
-### [deploy-config](#add-deploy-config)<a id="add-deploy-config"></a>
-Calling `sap-ux add deploy-config` will prompt for ABAP deployment configuration details and add/update the project files accordingly.
-```sh
-sap-ux add deploy-config [path]
-```
-- `-t | --target` target for deployment; ABAP or Cloud Foundry (not yet implemented)
-- `-b | --base-file` the base file config file of the project; default: ui5.yaml
-- `-d | --deploy-file` the name of the deploy config file to be written; default: ui5-deploy.yaml
+## [`add smartlinks-config`](#add-smartlinks-config)
 
+Add a `smartLinks` configuration to a project for cross-app navigation.
 
-### [html](#add-html)<a id="add-html"></a>
-Calling `sap-ux add html` will add html files for local preview and testing to the project. It will use the configuration from the `ui5.yaml` as default, as provided by the `fiori-tools-preview` or `preview-middleware`.
-```sh
-sap-ux add html [path]
-```
-- `-c | --config` path to project configuration file in YAML format, e.g.: `-c ui5Custom.yaml`
+Example:
 
-### [model](#add-model)<a id="add-model"></a>
-Calling `sap-ux add model` allows to add new OData Service and SAPUI5 Model to an existing adaptation project.
-```sh
-sap-ux add model [path]
-```
+`npx --yes @sap-ux/create@latest add smartlinks-config`
 
-### [mockserver-config](#add-mockserver-config)<a id="add-mockserver-config"></a>
-Calling `sap-ux add mockserver-config` adds the necessary configuration for mockserver module @sap-ux/ui5-middleware-fe-mockserver. 
-```sh
-sap-ux add mockserver-config [path]
-```
-- `-i | --interactive` ask for config options, otherwise use defaults'
-- `-n | --skip-install` skip npm install step
+Options:
+- `-s, --simulate` - Simulate only. Do not write to the config file. Also, sets `--verbose`
+- `-v, --verbose` - Show verbose information.
 
-### [smartlinks-config](#add-smartlinks-config)<a id="add-smartlinks-config"></a>
-Calling `sap-ux add smartlinks-config` adds a smartLinks configuration to a project 
-```sh
-sap-ux add smartlinks-config [path]
-```
+--------------------------------
 
-### [add inbound-navigation](#add-inbound-navigation)<a id="add-inbound-navigation"></a>
-Calling `sap-ux add inbound-navigation` adds a Fiori Launchpad configuration to a project.
-```sh
-sap-ux add inbound-navigation [path]
-```
+## [`add cds-plugin-ui5`](#add-cds-plugin-ui5)
 
-### [variants-config](#add-variants-config)<a id="add-variants-config"></a>
-Calling `sap-ux add variants-config` will add the necessary configuration to an existing yaml file and the script to package.json for variants creation. It will use the configuration from the yaml file passed by cli or default to `ui5.yaml`, as provided by the `fiori-tools-preview` or `preview-middleware`.
-```sh
-sap-ux add variants-config [path]
-```
-- `-c | --config` path to project configuration file in YAML format, e.g.: `-c ui5Custom.yaml`
+Add the `cds-plugin-ui5` module and all prerequisites to a CAP project for UI5 server integration.
 
-## [sap-ux change](#sap-ux-change)
-Calling `sap-ux change` allows changing a feature of a project.
+Example:
 
-### [data-source](#change-data-source)<a id="change-data-source"></a>
-Calling `sap-ux change data-source` allows replacing the OData Source of the base application in an adaptation project.  
-```sh
-sap-ux change data-source [path]
-```
-- `-c | --config` path to project configuration file in YAML format, e.g.: `-c ui5Custom.yaml`
+`npx --yes @sap-ux/create@latest add cds-plugin-ui5`
 
-### [inbound](#change-inbound)<a id="change-inbound"></a>
-Calling `sap-ux change inbound` allows replacing the Inbound FLP configurations of the base application in an adaptation project.  
-```sh
-sap-ux change inbound [path]
-```
+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.
 
-## [sap-ux convert](#sap-ux-convert)
-Executing `sap-ux convert` converts an app to a new feature.
+--------------------------------
 
-### [preview-config](#convert-preview-config)<a id="convert-preview-config"></a>
-Executing `sap-ux convert preview-config` in the root folder of an app will convert the respective app to the preview with virtual endpoints. It will use the configuration from the scripts in the `package.json` file to adjust the UI5 configuration YAML files accordingly. The obsolete JS and TS sources will be deleted and the HTML files previously used for the preview will be renamed to `*_old.html`.
-```sh
-sap-ux convert preview-config [path]
-```
-- `-s true | --simulate true | -s false | --simulate false` enable or disable simulate option without prompt
-- `-t true | --tests true | -t false | --tests false` enable or disable option to include test suite and test runners in the conversion to virtual files without prompt
+## [`add inbound-navigation`](#add-inbound-navigation)
 
-## [sap-ux remove](#sap-ux-remove)
-Calling `sap-ux remove` allows removing a feature from a project.
+Add SAP Fiori launchpad inbound navigation configuration to a project.
 
-### [mockserver-config](#remove-mockserver-config)<a id="remove-mockserver-config"></a>
-Calling `sap-ux remove mockserver-config` removes the configuration for mockserver module @sap-ux/ui5-middleware-fe-mockserver. 
-```sh
-sap-ux remove mockserver-config [path]
-```
-- `-f | --force` do not ask for confirmation when deleting files
+Example:
 
+`npx --yes @sap-ux/create@latest add inbound-navigation`
 
-## [sap-ux generate](#sap-ux-generate)
-Calling `sap-ux generate` allows generating a new project.
+Options:
+- `-s, --simulate` - Simulate only. Do not write to the config file. Also, sets `--verbose`
+- `-v, --verbose` - Show verbose information.
+- `-c, --config <string>` _(required)_ - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
+
+--------------------------------
+
+## [`add cards-editor`](#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>` _(required)_ - 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-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`](#add-annotations)
+
+Adds an annotation to the OData Source of the base application in an adaptation project.
+
+Example:
+
+`npx --yes @sap-ux/create@latest add annotations`
+
+Options:
+- `-s, --simulate` - Simulate only. Do not write or install.
+- `-c, --config <string>` _(required)_ - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
+
+--------------------------------
+
+## [`add html`](#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>` _(required)_ - 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-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`](#add-deploy-config)
+
+Prompt for ABAP deployment configuration details and adds and updates the project files accordingly.
+
+Example:
+
+`npx --yes @sap-ux/create@latest add deploy-config`
+
+Options:
+- `-t, --target <string>` _(required)_ - Target for deployment: ABAP or Cloud Foundry (not yet implemented)
+- `-s, --simulate` - Simulate only. Do not write. Also, sets `--verbose`
+- `-v, --verbose` - Show verbose information.
+- `-b, --base-file <string>` _(required)_ - The base config file of the project. _(default: "ui5.yaml")_
+- `-d, --deploy-file <string>` _(required)_ - The name of the deploy config file to be written. _(default: "ui5-deploy.yaml")_
+
+--------------------------------
+
+## [`add variants-config`](#add-variants-config)
+
+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`.
+
+Example:
+
+`npx --yes @sap-ux/create@latest add variants-config`
+
+Options:
+- `-c, --config <string>` _(required)_ - 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.
+
+--------------------------------
+
+## [`convert`](#convert)
+
+Command group for converting existing SAP Fiori applications. A subcommand is required.
+
+Usage: `npx --yes @sap-ux/create@latest convert [subcommand] [options]`
+
+The available subcommands are: `preview-config`
+
+
+--------------------------------
+
+## [`convert preview-config`](#convert-preview-config)
+
+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`.
+
+Examples:
+
+`npx --yes @sap-ux/create@latest convert preview-config --simulate=false --tests=false`
+
+`npx --yes @sap-ux/create@latest convert preview-config`
+
+Options:
+- `-s, --simulate <boolean>` _(required)_ - Simulate only. Do not write.
+- `-v, --verbose` - Show verbose information.
+- `-t, --tests <boolean>` _(required)_ - Also, convert test suite and test runners.
+
+--------------------------------
+
+## [`remove`](#remove)
+
+Command group for removing features from existing SAP Fiori applications. A subcommand is required.
+
+Usage: `npx --yes @sap-ux/create@latest remove [subcommand] [options]`
+
+The available subcommands are: `mockserver-config`
+
+
+--------------------------------
+
+## [`remove mockserver-config`](#remove-mockserver-config)
+
+Removes the configuration for the `@sap-ux/ui5-middleware-fe-mockserver` mockserver module.
+
+Example:
+
+`npx --yes @sap-ux/create@latest remove mockserver-config`
+
+Options:
+- `-v, --verbose` - Show verbose information.
+- `-f, --force` - Do not ask for confirmation when deleting files.
+
+--------------------------------
+
+## [`change`](#change)
+
+Command group for changing existing SAP Fiori applications. A subcommand is required.
+
+Usage: `npx --yes @sap-ux/create@latest change [subcommand] [options]`
+
+The available subcommands are: `data-source` and `inbound`
+
+--------------------------------
+
+## [`change data-source`](#change-data-source)
+
+Replace the OData Source of the base application in an adaptation project.
+
+Example:
+
+`npx --yes @sap-ux/create@latest change data-source`
+
+Options:
+- `-s, --simulate` - Simulate only. Do not write or install.
+- `-c, --config <string>` _(required)_ - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
+
+--------------------------------
+
+## [`change inbound`](#change-inbound)
+
+Replace the inbound FLP configurations of the base application in an adaptation project.
+
+Example:
+
+`npx --yes @sap-ux/create@latest change inbound`
+
+Options:
+- `-s, --simulate` - Simulate only. Do not write or install.
 
-### [adaptation-project](#adaptation-project)
-Calling `sap-ux generate adaptation-project` allows generating a new adaptation project. Without further parameters the CLI will prompt the required parameters `id`, `reference` and `url`. To run the prompt non-interactively, it is also possible to execute
-```sh
-sap-ux generate adaptation-project --id my.adp --reference the.original.app --url http://my.sapsystem.example
-```
-- `-n | --skip-install` skip npm install step
-- `-y | --yes` use default values for all prompts
-- `--id [id]` id of the adaptation project
-- `--reference [reference]` id of the original application
-- `--url [url]` url pointing to the target system containing the original app
-- `--ignoreCertErrors` ignore certificate errors when connecting to the target system
-- `--ft` enable the Fiori tools for the generated project
-- `--package [package]` ABAP package to be used for deployments
-- `--transport [transport]` ABAP transport to be used for deployments

package/dist/cli/add/annotations-to-odata.js

@@ -7,6 +7,7 @@ const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
 const common_1 = require("../../common");
 const tracing_1 = require("../../tracing");
 const validation_1 = require("../../validation/validation");
+const project_access_1 = require("@sap-ux/project-access");
 let loginAttempts = 3;
 /**
  * Add a new sub-command to add annotations to odata service of an adaptation project to the given command.
@@ -15,9 +16,11 @@ let loginAttempts = 3;
  */
 function addAnnotationsToOdataCommand(cmd) {
     cmd.command('annotations [path]')
-        .description('Add annotations to the OData service of an adaptation project.')
-        .option('-s, --simulate', 'simulate only do not write or install')
-        .option('-c, --config <string>', 'Path to project configuration file in YAML format', 'ui5.yaml')
+        .description(`Adds an annotation to the OData Source of the base application in an adaptation project.\n
+Example:
+    \`npx --yes @sap-ux/create@latest add annotations\``)
+        .option('-s, --simulate', 'Simulate only. Do not write or install.')
+        .option('-c, --config <string>', 'Path to the project configuration file in YAML format.', project_access_1.FileName.Ui5Yaml)
         .action(async (path, options) => {
         await addAnnotationsToOdata(path, !!options.simulate, options.config);
     });

package/dist/cli/add/cards-generator.js

@@ -12,10 +12,12 @@ const project_access_1 = require("@sap-ux/project-access");
  */
 function addCardsEditorConfigCommand(cmd) {
     cmd.command('cards-editor [path]')
-        .description('Add a cards editor configuration to a project, enabling card generation.')
-        .option('-c, --config <string>', 'Path to project configuration file in YAML format', 'ui5.yaml')
-        .option('-s, --simulate', 'simulate only do not write config; sets also --verbose')
-        .option('-v, --verbose', 'show verbose information')
+        .description(`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\`.\n
+Example:
+    \`npx --yes @sap-ux/create@latest add cards-editor\``)
+        .option('-c, --config <string>', 'Path to the project configuration file in YAML format.', project_access_1.FileName.Ui5Yaml)
+        .option('-s, --simulate', 'Simulate only. Do not write to the config file. Also, sets `--verbose`')
+        .option('-v, --verbose', 'Show verbose information.')
         .action(async (path, options) => {
         if (options.verbose === true || options.simulate) {
             (0, tracing_1.setLogLevelVerbose)();

package/dist/cli/add/cds-plugin-ui.js

@@ -12,10 +12,12 @@ const common_1 = require("../../common");
  */
 function addAddCdsPluginUi5Command(cmd) {
     cmd.command('cds-plugin-ui5 [path]')
-        .description('Add the cds-plugin-ui5 and all prerequisites to a CAP project for UI5 integration.')
-        .option('-n, --skip-install', 'skip npm install step')
-        .option('-s, --simulate', 'simulate only, do not write or install; sets also --verbose')
-        .option('-v, --verbose', 'show verbose information')
+        .description(`Add the \`cds-plugin-ui5\` module and all prerequisites to a CAP project for UI5 server integration.\n
+Example:
+    \`npx --yes @sap-ux/create@latest add cds-plugin-ui5\``)
+        .option('-n, --skip-install', 'Skip the `npm install` step.')
+        .option('-s, --simulate', 'Simulate only. Do not write or install. Also, sets `--verbose`')
+        .option('-v, --verbose', 'Show verbose information.')
         .action(async (path, options) => {
         if (options.verbose === true || options.simulate) {
             (0, tracing_1.setLogLevelVerbose)();

package/dist/cli/add/component-usages.js

@@ -13,8 +13,10 @@ const common_1 = require("../../common");
  */
 function addComponentUsagesCommand(cmd) {
     cmd.command('component-usages [path]')
-        .description('Add component usages to an adaptation project, updating the manifest accordingly.')
-        .option('-s, --simulate', 'simulate only do not write or install')
+        .description(`Add the component usages to an adaptation project.\n
+Example:
+    \`npx --yes @sap-ux/create@latest add component-usages\``)
+        .option('-s, --simulate', 'Simulate only. Do not write or install.')
         .action(async (path, options) => {
         await addComponentUsages(path, !!options.simulate);
     });

package/dist/cli/add/deploy-config.js

@@ -15,12 +15,14 @@ const common_1 = require("../../common");
  */
 function addDeployConfigCommand(cmd) {
     cmd.command('deploy-config [path]')
-        .description('Add or update ABAP deployment configuration files for the project.')
-        .option('-t, --target <string>', 'target for deployment; ABAP or Cloud Foundry (not yet implemented)')
-        .option('-s, --simulate', 'simulate only do not write; sets also --verbose')
-        .option('-v, --verbose', 'show verbose information')
-        .option('-b, --base-file <string>', 'the base file config file of the project; default : ui5.yaml')
-        .option('-d, --deploy-file <string>', 'the name of the deploy config file to be written; default : ui5-deploy.yaml')
+        .description(`Prompt for ABAP deployment configuration details and adds and updates the project files accordingly.\n
+Example:
+    \`npx --yes @sap-ux/create@latest add deploy-config\``)
+        .option('-t, --target <string>', 'Target for deployment: ABAP or Cloud Foundry (not yet implemented)')
+        .option('-s, --simulate', 'Simulate only. Do not write. Also, sets `--verbose`')
+        .option('-v, --verbose', 'Show verbose information.')
+        .option('-b, --base-file <string>', 'The base config file of the project. _(default: "ui5.yaml")_')
+        .option('-d, --deploy-file <string>', 'The name of the deploy config file to be written. _(default: "ui5-deploy.yaml")_')
         .action(async (path, options) => {
         if (options.verbose === true || options.simulate) {
             (0, tracing_1.setLogLevelVerbose)();

package/dist/cli/add/html.js

@@ -8,6 +8,7 @@ const node_path_1 = require("node:path");
 const ui5_config_1 = require("@sap-ux/ui5-config");
 const mem_fs_editor_1 = require("mem-fs-editor");
 const mem_fs_1 = require("mem-fs");
+const project_access_1 = require("@sap-ux/project-access");
 /**
  * Adds a command to add the virtual html files hosted by the preview middleware to the file system.
  *
@@ -15,10 +16,12 @@ const mem_fs_1 = require("mem-fs");
  */
 function addAddHtmlFilesCmd(cmd) {
     cmd.command('html [path]')
-        .description('Add HTML files for local preview and testing, using the preview middleware configuration.')
-        .option('-c, --config <string>', 'Path to project configuration file in YAML format', 'ui5.yaml')
-        .option('-s, --simulate', 'simulate only do not write config; sets also --verbose')
-        .option('-v, --verbose', 'show verbose information')
+        .description(`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\`.\n
+Example:
+    \`npx --yes @sap-ux/create@latest add html\``)
+        .option('-c, --config <string>', 'Path to the project configuration file in YAML format.', project_access_1.FileName.Ui5Yaml)
+        .option('-s, --simulate', 'Simulate only. Do not write to the config file. Also, sets `--verbose`')
+        .option('-v, --verbose', 'Show verbose information.')
         .action(async (path, options) => {
         if (options.verbose === true || options.simulate) {
             (0, tracing_1.setLogLevelVerbose)();

package/dist/cli/add/mockserver-config.js

@@ -15,11 +15,13 @@ const common_1 = require("../../common");
  */
 function addAddMockserverConfigCommand(cmd) {
     cmd.command('mockserver-config [path]')
-        .description('Add configuration for the mockserver module to enable local OData mocking.')
-        .option('-i, --interactive', 'ask for config options, otherwise use defaults')
-        .option('-n, --skip-install', 'skip npm install step')
-        .option('-s, --simulate', 'simulate only do not write or install; sets also --verbose')
-        .option('-v, --verbose', 'show verbose information')
+        .description(`Add the necessary configuration for the \`@sap-ux/ui5-middleware-fe-mockserver\` mockserver module to enable local OData mocking.\n
+Example:
+    \`npx --yes @sap-ux/create@latest add mockserver-config\``)
+        .option('-i, --interactive', 'Ask for config options or otherwise, use the default options.')
+        .option('-n, --skip-install', 'Skip the `npm install` step.')
+        .option('-s, --simulate', 'Simulate only. Do not write or install. Also, sets `--verbose`')
+        .option('-v, --verbose', 'Show verbose information.')
         .action(async (path, options) => {
         if (options.verbose === true || options.simulate) {
             (0, tracing_1.setLogLevelVerbose)();

package/dist/cli/add/navigation-config.js

@@ -20,10 +20,12 @@ const tracing_1 = require("../../tracing");
  */
 function addInboundNavigationConfigCommand(cmd) {
     cmd.command('inbound-navigation [path]')
-        .description('Add Fiori Launchpad inbound navigation configuration to a project.')
-        .option('-s, --simulate', 'simulate only do not write config; sets also --verbose')
-        .option('-v, --verbose', 'show verbose information')
-        .option('-c, --config <string>', 'Path to project configuration file in YAML format', project_access_1.FileName.Ui5Yaml)
+        .description(`Add SAP Fiori launchpad inbound navigation configuration to a project.\n
+Example:
+    \`npx --yes @sap-ux/create@latest add inbound-navigation\``)
+        .option('-s, --simulate', 'Simulate only. Do not write to the config file. Also, sets `--verbose`')
+        .option('-v, --verbose', 'Show verbose information.')
+        .option('-c, --config <string>', 'Path to the project configuration file in YAML format.', project_access_1.FileName.Ui5Yaml)
         .action(async (path, options) => {
         if (options.verbose === true || options.simulate) {
             (0, tracing_1.setLogLevelVerbose)();

package/dist/cli/add/new-model.js

@@ -12,8 +12,10 @@ const validation_1 = require("../../validation/validation");
  */
 function addNewModelCommand(cmd) {
     cmd.command('model [path]')
-        .description('Add a new OData service and UI5 model to an existing adaptation project.')
-        .option('-s, --simulate', 'simulate only do not write or install')
+        .description(`Add a new OData service and SAPUI5 model to an existing adaptation project.\n
+Example:
+    \`npx --yes @sap-ux/create@latest add model\``)
+        .option('-s, --simulate', 'Simulate only. Do not write or install.')
         .action(async (path, options) => {
         await addNewModel(path, !!options.simulate);
     });

package/dist/cli/add/smartlinks-config.js

@@ -11,9 +11,11 @@ const validation_1 = require("../../validation");
  */
 function addAddSmartLinksConfigCommand(cmd) {
     cmd.command('smartlinks-config [path]')
-        .description('Add a smartLinks configuration to a project for cross-app navigation.')
-        .option('-s, --simulate', 'simulate only do not write config; sets also --verbose')
-        .option('-v, --verbose', 'show verbose information')
+        .description(`Add a \`smartLinks\` configuration to a project for cross-app navigation.\n
+Example:
+    \`npx --yes @sap-ux/create@latest add smartlinks-config\``)
+        .option('-s, --simulate', 'Simulate only. Do not write to the config file. Also, sets `--verbose`')
+        .option('-v, --verbose', 'Show verbose information.')
         .action(async (path, options) => {
         if (options.verbose === true || options.simulate) {
             (0, tracing_1.setLogLevelVerbose)();

package/dist/cli/add/variants-config.js

@@ -5,6 +5,7 @@ const tracing_1 = require("../../tracing");
 const validation_1 = require("../../validation");
 const app_config_writer_1 = require("@sap-ux/app-config-writer");
 const node_path_1 = require("node:path");
+const project_access_1 = require("@sap-ux/project-access");
 /**
  * Add the "add variants config" command to a passed command.
  *
@@ -12,10 +13,12 @@ const node_path_1 = require("node:path");
  */
 function addAddVariantsConfigCommand(cmd) {
     cmd.command('variants-config [path]')
-        .description('Add configuration and scripts for variant management.')
-        .option('-c, --config <string>', 'Path to project configuration file in YAML format', 'ui5.yaml')
-        .option('-s, --simulate', 'simulate only do not write config; sets also --verbose')
-        .option('-v, --verbose', 'show verbose information')
+        .description(`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\`.\n
+Example:
+    \`npx --yes @sap-ux/create@latest add variants-config\``)
+        .option('-c, --config <string>', 'Path to the project configuration file in YAML format.', project_access_1.FileName.Ui5Yaml)
+        .option('-s, --simulate', 'Simulate only. Do not write to the config file. Also, sets `--verbose`')
+        .option('-v, --verbose', 'Show verbose information.')
         .action(async (path, options) => {
         if (options.verbose === true || options.simulate) {
             (0, tracing_1.setLogLevelVerbose)();

package/dist/cli/change/change-data-source.js

@@ -4,8 +4,9 @@ exports.addChangeDataSourceCommand = addChangeDataSourceCommand;
 const adp_tooling_1 = require("@sap-ux/adp-tooling");
 const tracing_1 = require("../../tracing");
 const common_1 = require("../../common");
-const validation_1 = require("../../validation/validation");
+const validation_1 = require("../../validation");
 const system_access_1 = require("@sap-ux/system-access");
+const project_access_1 = require("@sap-ux/project-access");
 let loginAttempts = 3;
 /**
  * Add a new sub-command to change the data source of an adaptation project to the given command.
@@ -14,9 +15,11 @@ let loginAttempts = 3;
  */
 function addChangeDataSourceCommand(cmd) {
     cmd.command('data-source [path]')
-        .description('Change the OData source of the base application in an adaptation project.')
-        .option('-s, --simulate', 'simulate only do not write or install')
-        .option('-c, --config <string>', 'Path to project configuration file in YAML format', 'ui5.yaml')
+        .description(`Replace the OData Source of the base application in an adaptation project.\n
+Example:
+    \`npx --yes @sap-ux/create@latest change data-source\``)
+        .option('-s, --simulate', 'Simulate only. Do not write or install.')
+        .option('-c, --config <string>', 'Path to the project configuration file in YAML format.', project_access_1.FileName.Ui5Yaml)
         .action(async (path, options) => {
         await changeDataSource(path, !!options.simulate, options.config);
     });

package/dist/cli/change/change-inbound.js

@@ -12,8 +12,10 @@ const validation_1 = require("../../validation");
  */
 function addChangeInboundCommand(cmd) {
     cmd.command('inbound [path]')
-        .description('Replace the Inbound FLP configurations of the base application in an adaptation project.')
-        .option('-s, --simulate', 'simulate only do not write or install')
+        .description(`Replace the inbound FLP configurations of the base application in an adaptation project.\n
+Example:
+    \`npx --yes @sap-ux/create@latest change inbound\``)
+        .option('-s, --simulate', 'Simulate only. Do not write or install.')
         .action(async (path, options) => {
         await changeInbound(path, !!options.simulate);
     });

package/dist/cli/convert/preview.js

@@ -10,10 +10,13 @@ const app_config_writer_1 = require("@sap-ux/app-config-writer");
  */
 function addConvertPreviewCommand(cmd) {
     cmd.command('preview-config [path]')
-        .description('Convert an app to use virtual preview endpoints and update configuration files.')
-        .option('-s, --simulate <boolean>', 'simulate only do not write')
-        .option('-v, --verbose', 'show verbose information')
-        .option('-t, --tests <boolean>', 'also convert test suite and test runners')
+        .description(`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\`.\n
+Examples:
+    \`npx --yes @sap-ux/create@latest convert preview-config --simulate=false --tests=false\`
+    \`npx --yes @sap-ux/create@latest convert preview-config\``)
+        .option('-s, --simulate <boolean>', 'Simulate only. Do not write.')
+        .option('-v, --verbose', 'Show verbose information.')
+        .option('-t, --tests <boolean>', 'Also, convert test suite and test runners.')
         .action(async (path, options) => {
         const simulateString = /(?:=)?(true|false)/i.exec(options.simulate)?.[1];
         const testsString = /(?:=)?(true|false)/i.exec(options.tests)?.[1];

package/dist/cli/generate/adaptation-project.js

@@ -16,18 +16,20 @@ const node_path_1 = require("node:path");
  */
 function addGenerateAdaptationProjectCommand(cmd) {
     cmd.command('adaptation-project [path]')
-        .description('Generate a new UI5 adaptation project with optional prompts and configuration.')
-        .option('-n, --skip-install', 'skip npm install step')
-        .option('-s, --simulate', 'simulate only do not write or install')
-        .option('-y, --yes', 'use default values for all prompts')
-        .option('--id [id]', 'id of the adaptation project')
-        .option('--reference [reference]', 'id of the original application')
-        .option('--url [url]', 'url pointing to the target system containing the original app')
-        .option('--ignoreCertErrors', 'ignore certificate errors when connecting to the target system')
-        .option('--ft', 'enable the Fiori tools for the generated project')
-        .option('--ts', 'enable the TypeScript support for the generated project')
-        .option('--package [package]', 'ABAP package to be used for deployments')
-        .option('--transport [transport]', 'ABAP transport to be used for deployments')
+        .description(`Generate a new SAPUI5 adaptation project with optional prompts and configuration.\n
+Example:
+    \`npx --yes @sap-ux/create@latest generate adaptation-project\``)
+        .option('-n, --skip-install', 'Skip the `npm install` step.')
+        .option('-s, --simulate', 'Simulate only. Do not write or install.')
+        .option('-y, --yes', 'Use default values for all prompts.')
+        .option('--id [id]', 'The ID of the adaptation project.')
+        .option('--reference [reference]', 'The ID of the original application.')
+        .option('--url [url]', 'The URL that points to the target system which contains the original application.')
+        .option('--ignoreCertErrors', 'Ignore certificate errors when connecting to the target system.')
+        .option('--ft', 'Enable SAP Fiori tools for the generated project.')
+        .option('--ts', 'Enable TypeScript support for the generated project.')
+        .option('--package [package]', 'The ABAP package to be used for deployments.')
+        .option('--transport [transport]', 'The ABAP transport to be used for deployments.')
         .action(async (path, options) => {
         console.log(`\nThe generation of adaptation projects outside of SAP Business Application Studio is currently ${chalk_1.default.bold('experimental')}.`);
         console.log('Please report any issues or feedback at https://github.com/SAP/open-ux-tools/issues/new/choose.\n');

package/dist/cli/index.js

@@ -46,10 +46,10 @@ function getCommanderProgram() {
     const logger = (0, tracing_1.getLogger)();
     const program = new commander_1.Command();
     const version = getVersion();
-    program.description(`Configure features for Fiori applications and projects. (${version})`);
+    program.description(`Configure features for SAP Fiori applications and projects (@sap-ux/create version ${version}).`);
     program.addHelpText('after', `\nExample Usage:
-  'npx --yes @sap-ux/create@latest add --help'              Get available subcommands for the 'add' command.
-  'npx --yes @sap-ux/create@latest add html --help'         Get available options for the 'add html' command.
+  'npx --yes @sap-ux/create@latest add --help'              Get the available subcommands for the 'add' command.
+  'npx --yes @sap-ux/create@latest add html --help'         Get the available options for the 'add html' command.
   'npx --yes @sap-ux/create@latest add html --simulate'     Execute the 'add html' command using the 'simulate' option.\n`);
     program.option('--generateJsonSpec', 'Output the command structure as JSON');
     program.action((options) => {
@@ -66,28 +66,33 @@ function getCommanderProgram() {
     program.version(version);
     // Handler for create-fiori generate <feature> ..
     const genCommands = (0, generate_1.getGenerateCommands)();
-    genCommands.description(`Generate adaptation projects.
-                    Available Subcommands: ${getFeatureSummary(genCommands.commands)}\n`);
+    genCommands.description(`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: ${getFeatureSummary(genCommands.commands)}\n`);
     program.addCommand(genCommands);
     // Handler for create-fiori add <feature> ..
     const addCommands = (0, add_1.getAddCommands)();
-    addCommands.description(`Add features to an SAP Fiori app.
-                    Available Subcommands: ${getFeatureSummary(addCommands.commands)}\n`);
+    addCommands.description(`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: ${getFeatureSummary(addCommands.commands)}\n`);
     program.addCommand(addCommands);
     // Handler for create-fiori convert <feature> ..
     const convertCommands = (0, convert_1.getConvertCommands)();
-    convertCommands.description(`Convert existing SAP Fiori applications.
-                    Available Subcommands: ${getFeatureSummary(convertCommands.commands)}\n`);
+    convertCommands.description(`Command group for converting existing SAP Fiori applications. A subcommand is required.
+                    Usage: \`npx --yes @sap-ux/create@latest convert [subcommand] [options]\`
+                    The available subcommands are: ${getFeatureSummary(convertCommands.commands)}\n`);
     program.addCommand(convertCommands);
     // Handler for create-fiori remove <feature> ..
     const removeCommands = (0, remove_1.getRemoveCommands)();
-    removeCommands.description(`Remove features from existing SAP Fiori applications.
-                    Available Subcommands: ${getFeatureSummary(removeCommands.commands)}\n`);
+    removeCommands.description(`Command group for removing features from existing SAP Fiori applications. A subcommand is required.
+                    Usage: \`npx --yes @sap-ux/create@latest remove [subcommand] [options]\`
+                    The available subcommands are: ${getFeatureSummary(removeCommands.commands)}\n`);
     program.addCommand(removeCommands);
     // Handler for create-fiori change <feature> ..
     const changeCommands = (0, change_1.getChangeCommands)();
-    changeCommands.description(`Change existing adaptation projects.
-                    Available Subcommands: ${getFeatureSummary(changeCommands.commands)}`);
+    changeCommands.description(`Command group for changing existing SAP Fiori applications. A subcommand is required.
+                    Usage: \`npx --yes @sap-ux/create@latest change [subcommand] [options]\`
+                    The available subcommands are: ${getFeatureSummary(changeCommands.commands)}`);
     program.addCommand(changeCommands);
     return program;
 }
@@ -98,8 +103,8 @@ function getCommanderProgram() {
  * @returns - Summary of the subcommands
  */
 function getFeatureSummary(commands) {
-    const subCommandNames = commands.map((cmd) => cmd.name());
-    return subCommandNames.join(', ');
+    const subCommandNames = commands.map((cmd) => `\`${cmd.name()}\``);
+    return subCommandNames.join(', ').replace(/, ([^,]*)$/, ' and $1');
 }
 /**
  * Parses a commander.Option object into a simpler format for the JSON spec.

package/dist/cli/remove/mockserver-config.js

@@ -15,9 +15,11 @@ const validation_1 = require("../../validation");
  */
 function addRemoveMockserverConfigCommand(cmd) {
     cmd.command('mockserver-config [path]')
-        .description('Remove the configuration for the mockserver module from a project.')
-        .option('-v, --verbose', 'show verbose information')
-        .option('-f, --force', 'do not ask for confirmation when deleting files')
+        .description(`Removes the configuration for the \`@sap-ux/ui5-middleware-fe-mockserver\` mockserver module.\n
+Example:
+    \`npx --yes @sap-ux/create@latest remove mockserver-config\``)
+        .option('-v, --verbose', 'Show verbose information.')
+        .option('-f, --force', 'Do not ask for confirmation when deleting files.')
         .action(async (path, options) => {
         if (options.verbose === true) {
             (0, tracing_1.setLogLevelVerbose)();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/create",
   "description": "SAP Fiori tools module to add or remove features",
-  "version": "0.13.160",
+  "version": "0.13.162",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -30,19 +30,19 @@
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "prompts": "2.4.2",
-    "@sap-ux/abap-deploy-config-inquirer": "1.6.46",
     "@sap-ux/abap-deploy-config-writer": "0.2.33",
-    "@sap-ux/adp-tooling": "0.17.8",
     "@sap-ux/app-config-writer": "0.6.56",
+    "@sap-ux/abap-deploy-config-inquirer": "1.6.46",
     "@sap-ux/cap-config-writer": "0.12.24",
+    "@sap-ux/adp-tooling": "0.18.0",
     "@sap-ux/logger": "0.7.1",
-    "@sap-ux/mockserver-config-writer": "0.9.25",
     "@sap-ux/odata-service-writer": "0.27.29",
-    "@sap-ux/preview-middleware": "0.23.50",
+    "@sap-ux/mockserver-config-writer": "0.9.25",
+    "@sap-ux/preview-middleware": "0.23.51",
     "@sap-ux/project-access": "1.32.8",
     "@sap-ux/system-access": "0.6.28",
     "@sap-ux/ui5-config": "0.29.9",
-    "@sap-ux/flp-config-inquirer": "0.4.58"
+    "@sap-ux/flp-config-inquirer": "0.4.59"
   },
   "devDependencies": {
     "@types/diff": "5.0.9",
@@ -54,7 +54,7 @@
     "@sap-ux/store": "1.3.3"
   },
   "scripts": {
-    "build": "tsc --build",
+    "build": "tsc --build && node ./scripts/generate-readme.js",
     "clean": "rimraf --glob dist coverage *.tsbuildinfo",
     "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
     "lint": "eslint . --ext .ts",