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
Copy file name to clipboardExpand all lines: docs/commands.md
+41-41Lines changed: 41 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,13 +33,13 @@ Builds the JavaScript bundle for offline use.
33
33
34
34
Path to the root JS file, either absolute or relative to JS root.
35
35
36
-
#### `--platform [string]`
36
+
#### `--platform <string>`
37
37
38
38
> default: ios
39
39
40
40
Either "ios" or "android".
41
41
42
-
#### `--transformer [string]`
42
+
#### `--transformer <string>`
43
43
44
44
Specify a custom transformer to be used.
45
45
@@ -71,21 +71,21 @@ The expected path for the js bundle can be found on the line that starts with <c
71
71
72
72
</details>
73
73
74
-
#### `--bundle-encoding [string]`
74
+
#### `--bundle-encoding <string>`
75
75
76
76
> default: utf8
77
77
78
78
Encoding the bundle should be written in (https://nodejs.org/api/buffer.html#buffer_buffer).
79
79
80
-
#### `--max-workers [number]`
80
+
#### `--max-workers <number>`
81
81
82
82
Specifies the maximum number of workers the worker-pool will spawn for transforming files. This defaults to the number of the cores available on your machine.
83
83
84
-
#### `--sourcemap-output [string]`
84
+
#### `--sourcemap-output <string>`
85
85
86
86
File name where to store the sourcemap file for resulting bundle, ex. `/tmp/groups.map`.
87
87
88
-
#### `--sourcemap-sources-root [string]`
88
+
#### `--sourcemap-sources-root <string>`
89
89
90
90
Path to make sourcemaps sources entries relative to, ex. `/root/dir`.
91
91
@@ -95,7 +95,7 @@ Path to make sourcemaps sources entries relative to, ex. `/root/dir`.
95
95
96
96
Report SourceMapURL using its full path.
97
97
98
-
#### `--assets-dest [string]`
98
+
#### `--assets-dest <string>`
99
99
100
100
Directory name where to store assets referenced in the bundle.
101
101
@@ -123,7 +123,7 @@ Removes cached files.
123
123
124
124
Try to fetch transformed JS code from the global cache, if configured.
125
125
126
-
#### `--config [string]`
126
+
#### `--config <string>`
127
127
128
128
Path to the CLI configuration file.
129
129
@@ -153,19 +153,19 @@ Initialize a new React Native project named <projectName> in a directory of the
153
153
154
154
#### Options
155
155
156
-
#### `--version [string]`
156
+
#### `--version <string>`
157
157
158
158
Shortcut for `--template react-native@version`.
159
159
160
-
#### `--directory [string]`
160
+
#### `--directory <string>`
161
161
162
162
Uses a custom directory instead of `<projectName>`.
163
163
164
-
#### `--title [string]`
164
+
#### `--title <string>`
165
165
166
166
Uses a custom app title instead of `<projectName>`.
167
167
168
-
#### `--template [string]`
168
+
#### `--template <string>`
169
169
170
170
Uses a custom template. Accepts following template sources:
171
171
@@ -310,59 +310,59 @@ Builds your app and starts it on a connected Android emulator or device.
310
310
311
311
#### Options
312
312
313
-
#### `--root [string]`
313
+
#### `--root <string>`
314
314
315
315
> **DEPRECATED** – root is discovered automatically
316
316
317
317
Override the root directory for the Android build (which contains the android directory)'.
318
318
319
-
#### `--variant [string]`
319
+
#### `--variant <string>`
320
320
321
321
> default: 'debug'
322
322
323
323
Specify your app's build variant.
324
324
325
-
#### `--appFolder [string]`
325
+
#### `--appFolder <string>`
326
326
327
327
> **DEPRECATED** – use "project.android.appName" in react-native.config.js
328
328
329
329
> default: 'app'
330
330
331
331
Specify a different application folder name for the Android source. If not, we assume is "app".
332
332
333
-
#### `--appId [string]`
333
+
#### `--appId <string>`
334
334
335
335
Specify an `applicationId` to launch after build. If not specified, `package` from AndroidManifest.xml will be used.
336
336
337
-
#### `--appIdSuffix [string]`
337
+
#### `--appIdSuffix <string>`
338
338
339
339
Specify an `applicationIdSuffix` to launch after build.
340
340
341
-
#### `--main-activity [string]`
341
+
#### `--main-activity <string>`
342
342
343
343
> default: 'MainActivity'
344
344
345
345
Name of the activity to start.
346
346
347
-
#### `--deviceId [string]`
347
+
#### `--deviceId <string>`
348
348
349
349
builds your app and starts it on a specific device/simulator with the given device id (listed by running "adb devices" on the command line).
Launches the Metro Bundler in a new window using the specified terminal path.
364
364
365
-
#### `--tasks [list]`
365
+
#### `--tasks <list>`
366
366
367
367
> default: 'installDebug'
368
368
@@ -387,7 +387,7 @@ Builds your app and starts it on iOS simulator.
387
387
388
388
#### Options
389
389
390
-
#### `--simulator [simulator_name]`
390
+
#### `--simulator <simulator_name>`
391
391
392
392
> default: iPhone 11
393
393
@@ -406,23 +406,23 @@ Example: this will launch your projet directly onto the iPhone XS Max simulator:
406
406
react-native run-ios --simulator "iPhone XS Max"
407
407
```
408
408
409
-
#### `--configuration [string]`
409
+
#### `--configuration <string>`
410
410
411
411
Explicitly set the scheme configuration to use default: 'Debug'.
412
412
413
-
#### `--scheme [string]`
413
+
#### `--scheme <string>`
414
414
415
415
Explicitly set Xcode scheme to use.
416
416
417
-
#### `--project-path [string]`
417
+
#### `--project-path <string>`
418
418
419
419
Path relative to project root where the Xcode project (.xcodeproj) lives. default: 'ios'.
420
420
421
421
#### `--device [string]`
422
422
423
423
Explicitly set device to use by name. The value is not required if you have a single device connected.
424
424
425
-
#### `--udid [string]`
425
+
#### `--udid <string>`
426
426
427
427
Explicitly set device to use by udid.
428
428
@@ -434,7 +434,7 @@ Do not launch packager while building.
434
434
435
435
Do not use `xcpretty` even if installed.
436
436
437
-
#### `--port [number]`
437
+
#### `--port <number>`
438
438
439
439
Runs packager on specified port
440
440
@@ -452,35 +452,35 @@ Starts the server that communicates with connected devices
452
452
453
453
#### Options
454
454
455
-
#### `--port [number]`
455
+
#### `--port <number>`
456
456
457
457
Specify port to listen on
458
458
459
-
#### `--projectRoot [path]`
459
+
#### `--projectRoot <path>`
460
460
461
461
Path to a custom project root
462
462
463
-
#### `--watchFolders [list]`
463
+
#### `--watchFolders <list>`
464
464
465
465
Specify any additional folders to be added to the watch list
466
466
467
-
#### `--sourceExts [list]`
467
+
#### `--sourceExts <list>`
468
468
469
469
Specify any additional source extensions to be used by the packager
470
470
471
-
#### `--max-workers [number]`
471
+
#### `--max-workers <number>`
472
472
473
473
Specifies the maximum number of workers the worker-pool will spawn for transforming files. This defaults to the number of the cores available on your machine
0 commit comments