@sap/ux-ui5-tooling 1.3.0 → 1.3.5

package/dist/markdowns/add/add.en.md

@@ -0,0 +1,37 @@
+SAP Fiori tools CLI.
+
+COMMAND NAME:
+
+    add - Create or update a target configuration
+
+USAGE:
+
+    fiori add [SUBCOMMAND] [...OPTIONS]
+
+SUBCOMMANDS:
+
+    deploy-config - Generate or update deploy config in ui5-deploy.yaml file.
+|               |    |                            |
+|---------------|----|----------------------------|
+| --package     | -p | Package name of target deploy system |
+| --transport   | -t | Transport number of target deploy system |
+| --client      | -l | Client number of target deploy system |
+| --index       | -i | Generate index.html in the app (y/n) |
+| --overwrite   | -f | Overwrite existing deploy config (y/n) |
+| --config      | -c | App deploy config file name if it is not ui5-deploy.yaml |
+| --base        | -b | App configuration file name if it is not ui5.yaml |
+
+    flp-config - Generate or update Fior Launchpad configuration
+|               |    |                            |
+|---------------|----|----------------------------|
+| --object      | -o | Semantic object |
+| --action      | -a | Action |
+| --title       | -t | Title displayed on Fiori Launchpad tile |
+| --subtitle    | -s | Subtile displayed on Fiori Launchpad tile |
+| --overwrite   | -f | Overwrite existing FLP config (y/n) |
+
+    flp-embedded-config - Adds the necessary configuration for running a Fiori application in FLP Embedded Mode. Mandatory parameters
+|               |    |                            |
+|---------------|----|----------------------------|
+| --config      |    | Path to the YAML file from which to copy the backend configuration |
+| --flp         |    | Path to the FLP in the backend, e.g. sap/bc/ui5_ui5/ui2/ushell/shells/abap/Fiorilaunchpad.html |

package/dist/markdowns/cfDeploy/cfDeploy.en.md

@@ -0,0 +1,9 @@
+SAP Fiori tools CLI.
+
+COMMAND NAME:
+
+    cfDeploy - Deploy project bundle to Cloud Foundry 
+
+USAGE:
+
+    fiori cfDeploy

package/dist/markdowns/deploy/deploy.en.md

@@ -0,0 +1,27 @@
+SAP Fiori tools CLI.
+
+COMMAND NAME:
+
+    deploy - Deploy project bundle to ABAP system
+
+USAGE:
+
+    fiori deploy [...OPTIONS]
+
+OPTIONS:
+
+|                |     |             |
+|----------------|-----|-------------|
+| --config       | -c  | Path to deployment config yaml file, default ui5-deploy.yaml |
+| --destination  | -d  | Destination of BTP system |
+| --failfast     | -f  | Terminate deploy and throw error when encoutering first error (y/N) |
+| --yes          | -y  | Generate index.html file (y/n) |
+| --url          | -u  | URL of deploy target ABAP system |
+| --client       | -l  | Client number of deploy target ABAP system |
+| --transport    | -t  | Transport number for deploy target ABAP system |
+| --name         | -n  | Project name of the app |
+| --package      | -p  | Package name for deploy target ABAP system |
+| --description  | -e  | Project description of the app |
+| --archive-url  | -au | Download app bundle from this url and upload this bundle for deployment |
+| --strict-ssl   | -ss | Perform certificate validation on archive url (Y/n)|
+| --archive-path | -ap | Provide path of the app bundle for deployment |

package/dist/markdowns/index/index.en.md

@@ -0,0 +1,21 @@
+SAP Fiori tools CLI.
+
+USAGE:
+
+    fiori [COMMAND] [COMMAND OPTIONS]
+
+COMMAND:
+
+|               | |                                         |
+|---------------|-|-----------------------------------------|
+| add           | | Create or update a target configuration |
+| run           | | Starts a local web server for running a FE application |
+| deploy        | | Deploy project bundle to ABAP system |
+| undeploy      | | Undeploy project on ABAP system |
+| cfDeploy      | | Deploy project bundle to Cloud Foundry |
+
+GLOBAL COMMAND OPTIONS:
+
+|               |    |             |
+|---------------|----|-------------|
+| --help        | -h | Show help for the given command |

package/dist/markdowns/run/run.en.md

@@ -0,0 +1,24 @@
+SAP Fiori tools CLI.
+
+COMMAND NAME:
+
+    run - Starts a local web server for running a FE application
+
+USAGE:
+
+    fiori run [...OPTIONS]
+
+OPTIONS:
+
+|                |     |             |
+|----------------|-----|-------------|
+| --config       | -c  | Path to config file (default: ui5.yaml in project root folder) |
+| --verbose      |     | Enable verbose logging (default: false) |
+| --port         | -p  | Port to start the server on (default for HTTP: 8080, HTTPS: 8443) |
+| --open         | -o  | Open web server root directory in default browser |
+| --https        |     | Enables HTTPS over the HTTP/2 protocol for the web server (default: false). If --key and --cert parameters are not provided with this parameter, a private key and certificate will be created automatically if OpenSSL is installed. Using HTTPS over HTTP/2 is currently not supported in SAP Business Application Studio |
+| --key          |     | Path to the private key for https (default: "$HOME/.ui5/server/server.key") |
+| --cert         |     | Path to the certificate for https (default: "$HOME/.ui5/server/server.crt") |
+| --ui5          |     | UI5 version to use when running the application (default: version from ui5.yaml) |
+| --ui5Uri       |     | UI5 uri to load the UI5 resources from (default: uri from ui5.yaml) |
+| --proxy        |     | Proxy configuration. e.g. https://myproxy:8443 (default: uses host machine proxy configuration) |

package/dist/markdowns/undeploy/undeploy.en.md

@@ -0,0 +1,19 @@
+SAP Fiori tools CLI.
+
+COMMAND NAME:
+
+    undeploy - Undeploy project on ABAP system  
+
+USAGE:
+
+    fiori undeploy [...OPTIONS]
+
+OPTIONS:
+
+|                |     |             |
+|----------------|-----|-------------|
+| --config       | -c  | Path to deployment config yaml file, default ui5-deploy.yaml |
+| --destination  | -d  | Destination of BTP system |
+| --url          | -u  | URL of deploy target ABAP system |
+| --transport    | -t  | Transport number for deploy target ABAP system |
+| --name         | -n  | Project name of the app |