-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathng_help.txt
342 lines (327 loc) · 34.2 KB
/
ng_help.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
ng build <options...>
Builds your app and places it into the output path (dist/ by default).
aliases: b
--target (String) (Default: development) Defines the build target.
aliases: -t <value>, -dev (--target=development), -prod (--target=production), --target <value>
--environment (String) Defines the build environment.
aliases: -e <value>, --environment <value>
--output-path (Path) Path where output will be placed.
aliases: -op <value>, --outputPath <value>
--aot (Boolean) Build using Ahead of Time compilation.
aliases: -aot
--sourcemaps (Boolean) Output sourcemaps.
aliases: -sm, --sourcemap, --sourcemaps
--vendor-chunk (Boolean) (Default: true) Use a separate bundle containing only vendor libraries.
aliases: -vc, --vendorChunk
--base-href (String) Base url for the application being built.
aliases: -bh <value>, --baseHref <value>
--deploy-url (String) URL where files will be deployed.
aliases: -d <value>, --deployUrl <value>
--verbose (Boolean) (Default: false) Adds more details to output logging.
aliases: -v, --verbose
--progress (Boolean) (Default: true) Log progress to the console while building.
aliases: -pr, --progress
--i18n-file (String) Localization file to use for i18n.
aliases: --i18nFile <value>
--i18n-format (String) Format of the localization file specified with --i18n-file.
aliases: --i18nFormat <value>
--locale (String) Locale to use for i18n.
aliases: --locale <value>
--extract-css (Boolean) Extract css from global styles onto css files instead of js ones.
aliases: -ec, --extractCss
--watch (Boolean) (Default: false) Run build when files change.
aliases: -w, --watch
--output-hashing=none|all|media|bundles (String) Define the output filename cache-busting hashing mode.
aliases: -oh <value>, --outputHashing <value>
--poll (Number) Enable and define the file watching poll time period (milliseconds).
aliases: -poll <value>
--app (String) Specifies app name or index to use.
aliases: -a <value>, -app <value>
--stats-json (Boolean) (Default: false) Generates a `stats.json` file which can be analyzed using tools such as: `webpack-bundle-analyzer` or https://webpack.github.io/analyse.
aliases: --statsJson
ng completion <options...>
Adds autocomplete functionality to `ng` commands and subcommands.
--all (Boolean) (Default: true) Generate a completion script compatible with both bash and zsh.
aliases: -a, -all
--bash (Boolean) (Default: false) Generate a completion script for bash.
aliases: -b, -bash
--zsh (Boolean) (Default: false) Generate a completion script for zsh.
aliases: -z, -zsh
ng doc <keyword>
Opens the official Angular documentation for a given keyword.
ng e2e <options...>
Run e2e tests in existing project.
aliases: e
--target (String) (Default: development) Defines the build target.
aliases: -t <value>, -dev (--target=development), -prod (--target=production), --target <value>
--environment (String) Defines the build environment.
aliases: -e <value>, --environment <value>
--output-path (Path) Path where output will be placed.
aliases: -op <value>, --outputPath <value>
--aot (Boolean) Build using Ahead of Time compilation.
aliases: -aot
--sourcemaps (Boolean) Output sourcemaps.
aliases: -sm, --sourcemap, --sourcemaps
--vendor-chunk (Boolean) (Default: true) Use a separate bundle containing only vendor libraries.
aliases: -vc, --vendorChunk
--base-href (String) Base url for the application being built.
aliases: -bh <value>, --baseHref <value>
--deploy-url (String) URL where files will be deployed.
aliases: -d <value>, --deployUrl <value>
--verbose (Boolean) (Default: false) Adds more details to output logging.
aliases: -v, --verbose
--progress (Boolean) (Default: true) Log progress to the console while building.
aliases: -pr, --progress
--i18n-file (String) Localization file to use for i18n.
aliases: --i18nFile <value>
--i18n-format (String) Format of the localization file specified with --i18n-file.
aliases: --i18nFormat <value>
--locale (String) Locale to use for i18n.
aliases: --locale <value>
--extract-css (Boolean) Extract css from global styles onto css files instead of js ones.
aliases: -ec, --extractCss
--watch (Boolean) (Default: false) Run build when files change.
aliases: -w, --watch
--output-hashing=none|all|media|bundles (String) Define the output filename cache-busting hashing mode.
aliases: -oh <value>, --outputHashing <value>
--poll (Number) Enable and define the file watching poll time period (milliseconds).
aliases: -poll <value>
--app (String) Specifies app name or index to use.
aliases: -a <value>, -app <value>
--port (Number) (Default: 0) The port to use to serve the application.
aliases: -p <value>, -port <value>
--host (String) (Default: localhost) Listens only on localhost by default.
aliases: -H <value>, -host <value>
--proxy-config (Path) Proxy configuration file.
aliases: -pc <value>, --proxyConfig <value>
--ssl (Boolean) (Default: false) Serve using HTTPS.
aliases: -ssl
--ssl-key (String) (Default: ssl/server.key) SSL key to use for serving HTTPS.
aliases: --sslKey <value>
--ssl-cert (String) (Default: ssl/server.crt) SSL certificate to use for serving HTTPS.
aliases: --sslCert <value>
--open (Boolean) (Default: false) Opens the url in default browser.
aliases: -o, -open
--live-reload (Boolean) (Default: true) Whether to reload the page on change, using live-reload.
aliases: -lr, --liveReload
--live-reload-client (String) Specify the URL that the live reload browser client will use.
aliases: --liveReloadClient <value>
--hmr (Boolean) (Default: false) Enable hot module replacement.
aliases: -hmr
--config (String) Use a specific config file. Defaults to the protractor config file in angular-cli.json.
aliases: -c <value>, --config <value>
--specs (Array) (Default: ) Override specs in the protractor config. Can send in multiple specs by repeating flag (ng e2e --specs=spec1.ts --specs=spec2.ts).
aliases: -sp <value>, --specs <value>
--element-explorer (Boolean) (Default: false) Start Protractor's Element Explorer for debugging.
aliases: -ee, --elementExplorer
--webdriver-update (Boolean) (Default: true) Try to update webdriver.
aliases: -wu, --webdriverUpdate
--serve (Boolean) (Default: true) Compile and Serve the app. All non-reload related serve options are also available (e.g. --port=4400).
aliases: -s, --serve
ng eject <options...>
Ejects your app and output the proper webpack configuration and scripts.
--target (String) (Default: development) Defines the build target.
aliases: -t <value>, -dev (--target=development), -prod (--target=production), --target <value>
--environment (String) Defines the build environment.
aliases: -e <value>, --environment <value>
--output-path (Path) Path where output will be placed.
aliases: -op <value>, --outputPath <value>
--aot (Boolean) Build using Ahead of Time compilation.
aliases: -aot
--sourcemaps (Boolean) Output sourcemaps.
aliases: -sm, --sourcemap, --sourcemaps
--vendor-chunk (Boolean) (Default: true) Use a separate bundle containing only vendor libraries.
aliases: -vc, --vendorChunk
--base-href (String) Base url for the application being built.
aliases: -bh <value>, --baseHref <value>
--deploy-url (String) URL where files will be deployed.
aliases: -d <value>, --deployUrl <value>
--verbose (Boolean) (Default: false) Adds more details to output logging.
aliases: -v, --verbose
--progress (Boolean) (Default: true) Log progress to the console while building.
aliases: -pr, --progress
--i18n-file (String) Localization file to use for i18n.
aliases: --i18nFile <value>
--i18n-format (String) Format of the localization file specified with --i18n-file.
aliases: --i18nFormat <value>
--locale (String) Locale to use for i18n.
aliases: --locale <value>
--extract-css (Boolean) Extract css from global styles onto css files instead of js ones.
aliases: -ec, --extractCss
--watch (Boolean) (Default: false) Run build when files change.
aliases: -w, --watch
--output-hashing=none|all|media|bundles (String) Define the output filename cache-busting hashing mode.
aliases: -oh <value>, --outputHashing <value>
--poll (Number) Enable and define the file watching poll time period (milliseconds).
aliases: -poll <value>
--force (Boolean) Overwrite any webpack.config.js and npm scripts already existing.
aliases: --force
--app (String) Specifies app name to use.
aliases: -a <value>, -app <value>
ng generate <blueprint> <options...>
Generates new code from blueprints.
aliases: g
--dry-run (Boolean) (Default: false) Run through without making any changes.
aliases: -d, --dryRun
--verbose (Boolean) (Default: false) Adds more details to output logging.
aliases: -v, --verbose
ng get <options...>
Get a value from the configuration.
--global (Boolean) (Default: false) Get the value in the global configuration (in your home directory).
aliases: --global
ng help <command-name (Default: all)>
Shows help for the CLI.
ng lint <options...>
Lints code in existing project.
aliases: l
--fix (Boolean) (Default: false) Fixes linting errors (may overwrite linted files).
aliases: -fix
--type-check (Boolean) (Default: false) Controls the type check for linting.
aliases: --typeCheck
--force (Boolean) (Default: false) Succeeds even if there was linting errors.
aliases: --force
--format (String) (Default: prose) Output format (prose, json, stylish, verbose, pmd, msbuild, checkstyle, vso, fileslist).
aliases: --format <value>
ng new <options...>
Creates a new directory and a new Angular app.
--dry-run (Boolean) (Default: false) Run through without making any changes.
aliases: -d, --dryRun
--verbose (Boolean) (Default: false) Adds more details to output logging.
aliases: -v, --verbose
--link-cli (Boolean) (Default: false) Automatically link the `@angular/cli` package.
aliases: -lc, --linkCli
--skip-install (Boolean) (Default: false) Skip installing packages.
aliases: -si, --skipInstall
--skip-git (Boolean) (Default: false) Skip initializing a git repository.
aliases: -sg, --skipGit
--skip-tests (Boolean) (Default: false) Skip creating spec files.
aliases: -st, --skipTests
--skip-commit (Boolean) (Default: false) Skip committing the first commit to git.
aliases: -sc, --skipCommit
--directory (String) The directory name to create the app in.
aliases: -dir <value>, --directory <value>
--source-dir (String) (Default: src) The name of the source directory.
aliases: -sd <value>, --sourceDir <value>
--style (String) (Default: css) The style file default extension.
aliases: --style <value>
--prefix (String) (Default: app) The prefix to use for all component selectors.
aliases: -p <value>, --prefix <value>
--routing (Boolean) (Default: false) Generate a routing module.
aliases: --routing
--inline-style (Boolean) (Default: false) Should have an inline style.
aliases: -is, --inlineStyle
--inline-template (Boolean) (Default: false) Should have an inline template.
aliases: -it, --inlineTemplate
ng serve <options...>
Builds and serves your app, rebuilding on file changes.
aliases: server, s
--target (String) (Default: development) Defines the build target.
aliases: -t <value>, -dev (--target=development), -prod (--target=production), --target <value>
--environment (String) Defines the build environment.
aliases: -e <value>, --environment <value>
--output-path (Path) Path where output will be placed.
aliases: -op <value>, --outputPath <value>
--aot (Boolean) Build using Ahead of Time compilation.
aliases: -aot
--sourcemaps (Boolean) Output sourcemaps.
aliases: -sm, --sourcemap, --sourcemaps
--vendor-chunk (Boolean) (Default: true) Use a separate bundle containing only vendor libraries.
aliases: -vc, --vendorChunk
--base-href (String) Base url for the application being built.
aliases: -bh <value>, --baseHref <value>
--deploy-url (String) URL where files will be deployed.
aliases: -d <value>, --deployUrl <value>
--verbose (Boolean) (Default: false) Adds more details to output logging.
aliases: -v, --verbose
--progress (Boolean) (Default: true) Log progress to the console while building.
aliases: -pr, --progress
--i18n-file (String) Localization file to use for i18n.
aliases: --i18nFile <value>
--i18n-format (String) Format of the localization file specified with --i18n-file.
aliases: --i18nFormat <value>
--locale (String) Locale to use for i18n.
aliases: --locale <value>
--extract-css (Boolean) Extract css from global styles onto css files instead of js ones.
aliases: -ec, --extractCss
--watch (Boolean) (Default: true) Rebuild on change.
aliases: -w, --watch
--output-hashing=none|all|media|bundles (String) Define the output filename cache-busting hashing mode.
aliases: -oh <value>, --outputHashing <value>
--poll (Number) Enable and define the file watching poll time period (milliseconds).
aliases: -poll <value>
--app (String) Specifies app name or index to use.
aliases: -a <value>, -app <value>
--port (Number) (Default: 4200) Port to listen to for serving.
aliases: -p <value>, -port <value>
--host (String) (Default: localhost) Listens only on localhost by default.
aliases: -H <value>, -host <value>
--proxy-config (Path) Proxy configuration file.
aliases: -pc <value>, --proxyConfig <value>
--ssl (Boolean) (Default: false) Serve using HTTPS.
aliases: -ssl
--ssl-key (String) (Default: ssl/server.key) SSL key to use for serving HTTPS.
aliases: --sslKey <value>
--ssl-cert (String) (Default: ssl/server.crt) SSL certificate to use for serving HTTPS.
aliases: --sslCert <value>
--open (Boolean) (Default: false) Opens the url in default browser.
aliases: -o, -open
--live-reload (Boolean) (Default: true) Whether to reload the page on change, using live-reload.
aliases: -lr, --liveReload
--live-reload-client (String) Specify the URL that the live reload browser client will use.
aliases: --liveReloadClient <value>
--hmr (Boolean) (Default: false) Enable hot module replacement.
aliases: -hmr
ng set <options...>
Set a value in the configuration.
--global (Boolean) (Default: false) Set the value in the global configuration rather than in your project's.
aliases: -g, --global
ng test <options...>
Runs your app's test suite.
aliases: t
--watch (Boolean) (Default: true) Run build when files change.
aliases: -w, --watch
--code-coverage (Boolean) (Default: false) Coverage report will be in the coverage/ directory.
aliases: -cc, --codeCoverage
--config (String) Use a specific config file. Defaults to the karma config file in .angular-cli.json.
aliases: -c <value>, --config <value>
--single-run (Boolean) (Default: false) Run tests a single time.
aliases: -sr, --singleRun
--progress (Boolean) (Default: true) Log progress to the console while in progress.
aliases: --progress
--browsers (String) Override which browsers tests are run against.
aliases: --browsers <value>
--colors (Boolean) Enable or disable colors in the output (reporters and logs).
aliases: --colors
--log-level (String) Level of logging.
aliases: --logLevel <value>
--port (Number) Port where the web server will be listening.
aliases: -port <value>
--reporters (String) List of reporters to use.
aliases: --reporters <value>
--sourcemaps (Boolean) (Default: true) Output sourcemaps.
aliases: -sm, --sourcemap, --sourcemaps
--poll (Number) Enable and define the file watching poll time period (milliseconds).
aliases: -poll <value>
--app (String) Specifies app name to use.
aliases: -a <value>, -app <value>
ng version <options...>
Outputs Angular CLI version.
aliases: v, --version, -v
--verbose (Boolean) (Default: false) Adds more details to output logging.
aliases: --verbose
ng xi18n <options...>
Extracts i18n messages from source code.
--i18n-format (String) (Default: xlf) Output format for the generated file.
aliases: -f <value>, -xmb (--i18n-format=xmb), -xlf (--i18n-format=xlf), --xliff (--i18n-format=xlf), --i18nFormat <value>
--output-path (Path) (Default: null) Path where output will be placed.
aliases: -op <value>, --outputPath <value>
--verbose (Boolean) (Default: false) Adds more details to output logging.
aliases: --verbose
--progress (Boolean) (Default: true) Log progress to the console while running.
aliases: --progress
--app (String) Specifies app name to use.
aliases: -a <value>, -app <value>
--locale (String) Specifies the source language of the application.
aliases: -l <value>, --locale <value>
--out-file (String) Name of the file to output.
aliases: -of <value>, --outFile <value>