You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> Part of the [UI5 Build and Development Tooling](https://github.com/SAP/ui5-tooling)
6
7
@@ -14,14 +15,18 @@
14
15
**The UI5 Build and Development Tooling described here is not intended for productive use yet. Breaking changes are to be expected.**
15
16
16
17
## General Information
17
-
- General information regarding the **UI5 Build and Development Tooling** project can be found **[here](https://github.com/SAP/ui5-tooling)**
18
-
- Details regarding **project configuration** can be found **[here](https://github.com/SAP/ui5-project#configuration)**
18
+
19
+
- General information regarding the **UI5 Build and Development Tooling** project can be found **[here](https://github.com/SAP/ui5-tooling)**
20
+
- Details regarding **project configuration** can be found **[here](https://github.com/SAP/ui5-project#configuration)**
19
21
20
22
## Installing the UI5 CLI
23
+
21
24
### Requirements
22
-
-[Node.js](https://nodejs.org/) (**version 8.5 or higher** ⚠️)
25
+
26
+
-[Node.js](https://nodejs.org/) (**version 8.5 or higher** ⚠️)
23
27
24
28
### Installation
29
+
25
30
```sh
26
31
npm install --global @ui5/cli
27
32
@@ -30,7 +35,9 @@ ui5 --help
30
35
```
31
36
32
37
## CLI Usage
38
+
33
39
### Overview
40
+
34
41
```
35
42
Usage: ui5 <command> [options]
36
43
@@ -56,8 +63,11 @@ Examples:
56
63
The CLI automatically checks for updates using [update-notifier](https://github.com/yeoman/update-notifier). While this is skipped in CI environments, you might also opt-out manually by following the steps described [here](https://github.com/yeoman/update-notifier/blob/master/readme.md#user-settings).
57
64
58
65
### Commands
66
+
59
67
#### build
68
+
60
69
`ui5 build [options]` builds the project in the current directory.
70
+
61
71
```
62
72
Commands:
63
73
dev Dev build: Skips non-essential and time-intensive tasks during build
@@ -85,8 +95,11 @@ Examples:
85
95
ui5 build dev --all --dev-exclude-project=sap.ui.core sap.m Build project and dependencies in dev mode, except "sap.ui.core" and "sap.m" (useful in combination with --include-task)
86
96
ui5 build dev Build project and dependencies in dev mode. Only a set of essential tasks is executed.
87
97
```
98
+
88
99
#### serve
100
+
89
101
`ui5 serve [options]` starts a webserver for the current project.
102
+
90
103
```
91
104
Options:
92
105
--help, -h Show help [boolean]
@@ -109,8 +122,11 @@ Examples:
109
122
ui5 serve --translator static:/path/to/projectDependencies.yaml Use a "static" translator with translator parameters.
110
123
ui5 serve --port 1337 --open tests/QUnit.html Listen to port 1337 and launch default browser with http://localhost:1337/test/QUnit.html
111
124
```
125
+
112
126
#### tree
113
-
`ui5 tree [options]` outputs the dependency tree of the current project to *stdout*. It takes all relevant parameters of ui5 build into account.
127
+
128
+
`ui5 tree [options]` outputs the dependency tree of the current project to _stdout_. It takes all relevant parameters of ui5 build into account.
129
+
114
130
```
115
131
Options:
116
132
--help, -h Show help [boolean]
@@ -128,7 +144,9 @@ Examples:
128
144
```
129
145
130
146
#### init
147
+
131
148
`ui5 init [options]` initializes the UI5 Build and Development Tooling configuration for an application or library project.
149
+
132
150
```
133
151
Options:
134
152
--help, -h Show help [boolean]
@@ -139,7 +157,23 @@ Options:
139
157
--loglevel Set the logging level (error|warn|info|verbose|silly). [string] [default: "info"]
140
158
```
141
159
160
+
#### versions
161
+
162
+
`ui5 versions [options]` show the versions of all UI5 Build and Development Tooling packages.
163
+
164
+
```
165
+
Options:
166
+
--help, -h Show help [boolean]
167
+
--version, -v Show version number [boolean]
168
+
--config Path to config file [string]
169
+
--translator, --t8r Translator to use. Including optional colon separated translator parameters. [string] [default: "npm"]
170
+
--verbose Enable verbose logging. [boolean]
171
+
--loglevel Set the logging level (error|warn|info|verbose|silly). [string] [default: "info"]
172
+
173
+
```
174
+
142
175
### Local vs. Global Installation
176
+
143
177
In general a global installation of the UI5 CLI (`npm install --global @ui5/cli`) is recommended.
144
178
145
179
However, it makes sense to add the UI5 CLI as a [devDependency](https://docs.npmjs.com/files/package.json#devdependencies) (`npm install --save-dev @ui5/cli`) for a project that is using `ui5`-commands in its build or test scripts or otherwise depends on the UI5 CLI for development workflows (like Continuous Integration).
@@ -151,24 +185,27 @@ This behavior can be disabled by setting the environment variable `UI5_CLI_NO_LO
151
185
**Example**
152
186
You have a project located at `/my-application`. The project has a devDependency to `@ui5/cli` and defines a start-script `"ui5 serve"`.
153
187
154
-
Current Working Directory | Command | Uses globally installed UI5 CLI | Uses locally installed UI5 CLI
0 commit comments