Skip to content

Commit 9b381b9

Browse files
committed
Removing the nativescript alias mentions from the cmd syntax
Also, shifting the parameters a bit Added another line for the --emulator option
1 parent f95fe65 commit 9b381b9

File tree

1 file changed

+24
-52
lines changed

1 file changed

+24
-52
lines changed

resources/help.txt

Lines changed: 24 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Usage:
44
$ tns <command> [command parameters] [--command <options>]
5+
6+
Alias:
57
$ nativescript <command> [command parameters] [--command <options>]
68

79
General commands:
@@ -54,6 +56,7 @@ Usage:
5456
$ nativescript create <App name> [--path <Directory>] [--appid <App ID>] [--copy-from <Directory>]
5557

5658
Creates a new project for native development with NativeScript from the default template or from an existing NativeScript project.
59+
5760
<App name> is the name of project. The specified name must meet the requirements of all platforms that you want to target.
5861
For projects that target Android, you can use uppercase or lowercase letters, numbers, and underscores. The name must start with a letter.
5962
For projects that target iOS, you can use uppercase or lowercase letters, numbers, and hyphens.
@@ -105,22 +108,21 @@ Lists all platforms that the project currently targets. You can build and deploy
105108

106109
Usage:
107110
$ tns platform add <Platform> [--frameworkPath <File Path>] [--symlink]
108-
$ nativescript platform add <Platform> [--frameworkPath <File Path>] [--symlink]
109111

110112
Platform-specific usage:
111113
$ tns platform add android [--frameworkPath <File Path>] [--symlink]
112114
$ tns platform add ios [--frameworkPath <File Path>] [--symlink]
113-
$ nativescript platform add android [--frameworkPath <File Path>] [--symlink]
114-
$ nativescript platform add ios [--frameworkPath <File Path>] [--symlink]
115115

116-
Configures the current project to target the selected platform. When you add a target platform, the NativeScript CLI adds a corresponding platform-specific subdirectory under the platforms directory. This platform-specific directory contains the necessary files to let you build your project for the target platform.
116+
Configures the current project to target the selected platform.
117+
118+
<File Path> is the complete path to a valid npm package or a directory that contains a NativeScript runtime for the selected platform.
119+
120+
When you add a target platform, the NativeScript CLI adds a corresponding platform-specific subdirectory under the platforms directory. This platform-specific directory contains the necessary files to let you build your project for the target platform.
117121

118122
In this version of the NativeScript CLI, you can target iOS and Android, based on your system. You need to have your system configured for development with the target platform.
119123
On Windows and Linux systems, you can target Android.
120124
On OS X systems, you can target Android and iOS.
121125

122-
<File Path> is the complete path to a valid npm package or a directory that contains a NativeScript runtime for the selected platform.
123-
124126
Options:
125127
--frameworkPath - Sets the path to a NativeScript runtime for the specified platform that you want to use instead of the default runtime.
126128
If --symlink is specified, <File Path> must point to directory in which the runtime is already extracted.
@@ -135,13 +137,10 @@ Options:
135137

136138
Usage:
137139
$ tns platform remove <Platform>
138-
$ nativescript platform remove <Platform>
139140

140141
Platform-specific usage:
141142
$ tns platform remove android
142143
$ tns platform remove ios
143-
$ nativescript platform remove android
144-
$ nativescript platform remove ios
145144

146145
Removes the selected platform from the platforms that the project currently targets. After removing the target platform, you can no longer build and deploy your app on devices which run on the platform.
147146

@@ -153,13 +152,10 @@ This operation deletes the subdirectory for the selected platform from the platf
153152

154153
Usage:
155154
$ tns platform update <Platform>
156-
$ nativescript platform update <Platform>
157155

158156
Platform-specific usage:
159157
$ tns platform update android
160158
$ tns platform update ios
161-
$ nativescript platform update android
162-
$ nativescript platform update ios
163159

164160
Updates the NativeScript runtime for the specified platform.
165161
--[/]--
@@ -168,13 +164,10 @@ Updates the NativeScript runtime for the specified platform.
168164

169165
Usage:
170166
$ tns prepare <Platform>
171-
$ nativescript prepare <Platform>
172167

173168
Platform-specific usage:
174169
$ tns prepare android
175170
$ tns prepare ios
176-
$ nativescript prepare android
177-
$ nativescript prepare ios
178171

179172
Copies common and relevant platform-specific content from the app directory to the subdirectory for the selected target platform
180173
in the platforms directory. This lets you build the project with the SDK for the selected platform.
@@ -184,7 +177,6 @@ in the platforms directory. This lets you build the project with the SDK for the
184177
--[build]--
185178
Usage:
186179
$ tns build <Command>
187-
$ nativescript build <Command>
188180

189181
You must run the create command with a related command.
190182

@@ -198,7 +190,6 @@ Builds the project for the selected target platform and produces an application
198190
--[build|android]--
199191
Usage:
200192
$ tns build android [--keyStorePath <File Path> --keyStorePassword <Password> --keyStoreAlias <Name> --keyStoreAliasPassword <Password>] [--release]
201-
$ nativescript build android [--keyStorePath <File Path> --keyStorePassword <Password> --keyStoreAlias <Name> --keyStoreAliasPassword <Password>] [--release]
202193

203194
Builds the project for Android and produces an APK that you can manually deploy on device or in the native emulator.
204195

@@ -223,7 +214,6 @@ Options:
223214

224215
Usage:
225216
$ tns build ios [--device] [--release]
226-
$ nativescript build ios [--device] [--release]
227217

228218
Builds the project for iOS and produces an APP or IPA that you can manually deploy in the iOS Simulator or on device, respectively.
229219

@@ -240,15 +230,13 @@ Options:
240230

241231
Usage:
242232
$ tns deploy <Platform> [--device <Device ID>] [--release]
243-
$ nativescript deploy <Platform> [--device <Device ID>] [--release]
244233

245234
Platform-specific usages:
246235
$ tns deploy android [--device <Device ID>] [--keyStorePath <File Path> --keyStorePassword <Password> --keyStoreAlias <Name> --keyStoreAliasPassword <Password>] [--release]
247236
$ tns deploy ios [--device <Device ID>] [--release]
248-
$ nativescript deploy android [--device <Device ID>] [--keyStorePath <File Path> --keyStorePassword <Password> --keyStoreAlias <Name> --keyStoreAliasPassword <Password>] [--release]
249-
$ nativescript deploy ios [--device <Device ID>] [--release]
250237

251238
Builds and deploys the project to a connected physical or virtual device.
239+
252240
<Device ID> is the index or name of the target device as listed by $ tns device
253241

254242
Before building for iOS device, verify that you have configured a valid pair of certificate and provisioning profile on your OS X system.
@@ -277,7 +265,6 @@ Options for android:
277265
--[run]--
278266
Usage:
279267
$ tns run <Command>
280-
$ nativescript run <Command>
281268

282269
You must run the run command with a related command.
283270

@@ -291,11 +278,12 @@ You must run the run command with a related command.
291278
Usage:
292279
$ tns run android [--device <Device ID>] [--keyStorePath <File Path> --keyStorePassword <Password> --keyStoreAlias <Name> --keyStoreAliasPassword <Password>] [--release]
293280
$ tns run android --emulator [<Emulator Options>] [--keyStorePath <File Path> --keyStorePassword <Password> --keyStoreAlias <Name> --keyStoreAliasPassword <Password>] [--release]
294-
$ nativescript run android [--device <Device ID>] [--keyStorePath <File Path> --keyStorePassword <Password> --keyStoreAlias <Name> --keyStoreAliasPassword <Password>] [--release]
295-
$ nativescript run android --emulator [<Emulator Options>] [--keyStorePath <File Path> --keyStorePassword <Password> --keyStoreAlias <Name> --keyStoreAliasPassword <Password>] [--release]
296281

297282
Runs your project on a connected Android device or in a native Android emulator, if configured. This is shorthand for prepare, build and deploy.
298283

284+
<Device ID> is the index or name of the target device as listed by $ tns device
285+
<Emulator Options> is any valid combination of options as listed by $ tns help emulate android
286+
299287
Prerequisites:
300288
Before running your app in the Android emulator from the Android SDK, verify that your system meets the following requirements.
301289
* Verify that you are running the NativeScript CLI on a Windows, OS X or Linux system.
@@ -310,13 +298,11 @@ Before running your app in the Genymotion emulator, verify that your system meet
310298
* /Applications/Genymotion.app/Contents/MacOS/
311299
* /Applications/Genymotion Shell.app/Contents/MacOS/
312300

313-
<Device ID> is the index or name of the target device as listed by $ tns device
314-
<Emulator Options> is any valid combination of options as listed by $ tns help emulate android
315-
316301
Options:
317302
--device - Specifies a connected device on which to run the app.
318303
You cannot use --device and --emulator simultaneously.
319304
--emulator - If set, runs the app in a native emulator for the target platform, if configured.
305+
When set, you can also set any other valid combination of emulator options as listed by $ tns help emulate android
320306
You cannot use --device and --emulator simultaneously.
321307
--release - If set, produces a release build. Otherwise, produces a debug build.
322308
When the --keyStore* options are specified, produces a signed release build.
@@ -338,10 +324,9 @@ Options:
338324
Usage:
339325
$ tns run ios [--device <Device ID>] [--release]
340326
$ tns run ios --emulator [<Emulator Options>] [--release]
341-
$ nativescript run ios [--device <Device ID>] [--release]
342-
$ nativescript run ios --emulator [<Emulator Options>] [--release]
343327

344328
Runs your project on a connected iOS device or in the iOS Simulator, if configured. This is shorthand for prepare, build, and deploy.
329+
345330
<Device ID> is the index or name of the target device as listed by $ tns device
346331
<Emulator Options> is any valid combination of options as listed by $ tns help emulate ios
347332

@@ -353,13 +338,11 @@ Before running the iOS Simulator, verify that you have met the following require
353338
You have installed Xcode. The version of Xcode must be compatible with the ios-sim-portable npm package on which the
354339
NativeScript CLI depends. For more information, visit https://www.npmjs.org/package/ios-sim-portable
355340

356-
<Device ID> is the index or name of the target device as listed by $ tns device
357-
<Emulator Options> is any valid combination of options as listed by $ tns help emulate android
358-
359341
Options:
360342
--device - Specifies a connected device on which to run the app.
361343
You cannot use --device and --emulator simultaneously.
362344
--emulator - If set, runs the app in a native emulator for the target platform, if configured.
345+
When set, you can also set any other valid combination of emulator options as listed by $ tns help emulate ios
363346
You cannot use --device and --emulator simultaneously.
364347
--release - If set, produces a release build. Otherwise, produces a debug build.
365348
--[/]--
@@ -400,7 +383,6 @@ Options:
400383

401384
Usage:
402385
$ tns emulate emulate <Command> [--release]
403-
$ nativescript emulate <Command> [--release]
404386

405387
You must run the emulate command with a related command.
406388

@@ -420,11 +402,14 @@ Usage:
420402
$ tns emulate android [--path <Directory>] [--timeout <Seconds>] [--keyStorePath <File Path> --keyStorePassword <Password> --keyStoreAlias <Name> --keyStoreAliasPassword <Password>] [--release]
421403
$ tns emulate android [--avd <Name>] [--path <Directory>] [--timeout <Seconds>] [--keyStorePath <File Path> --keyStorePassword <Password> --keyStoreAlias <Name> --keyStoreAliasPassword <Password>] [--release]
422404
$ tns emulate android [--geny <GenyName>] [--path <Directory>] [--timeout <Seconds>] [--keyStorePath <File Path> --keyStorePassword <Password> --keyStoreAlias <Name> --keyStoreAliasPassword <Password>] [--release]
423-
$ nativescript emulate android [--path <Directory>] [--timeout <Seconds>] [--keyStorePath <File Path> --keyStorePassword <Password> --keyStoreAlias <Name> --keyStoreAliasPassword <Password>] [--release]
424-
$ nativescript emulate android [--avd <Name>] [--path <Directory>] [--timeout <Seconds>] [--keyStorePath <File Path> --keyStorePassword <Password> --keyStoreAlias <Name> --keyStoreAliasPassword <Password>] [--release]
425-
$ nativescript emulate android [--geny <GenyName>] [--path <Directory>] [--timeout <Seconds>] [--keyStorePath <File Path> --keyStorePassword <Password> --keyStoreAlias <Name> --keyStoreAliasPassword <Password>] [--release]
426405

427406
Builds the specified project and runs it in a native Android emulator.
407+
408+
<Name> is the name of the Android virtual device that you want to use as listed by $ android list avd
409+
You can specify only one name at a time.
410+
<GenyName> is the name of the Genymotion virtual device that you want to use as listed by $ genyshell -c "devices list"
411+
You can specify only one name at a time.
412+
428413
If you do not select an Android virtual device (AVD) with the --avd option or a Genymotion
429414
virtual device with the --geny option, your app runs in the default AVD or a currently running emulator, if any.
430415
To list the available AVDs, run $ android list avd
@@ -447,11 +432,6 @@ Before running your app in the Genymotion emulator, verify that your system meet
447432
* /Applications/Genymotion.app/Contents/MacOS/
448433
* /Applications/Genymotion Shell.app/Contents/MacOS/
449434

450-
<Name> is the name of the Android virtual device that you want to use as listed by $ android list avd
451-
You can specify only one name at a time.
452-
<GenyName> is the name of the Genymotion virtual device that you want to use as listed by $ genyshell -c "devices list"
453-
You can specify only one name at a time.
454-
455435
Options:
456436
--path - Specifies the directory that contains the project. If not specified, the project is searched
457437
for in the current directory and all directories above it.
@@ -485,7 +465,6 @@ Options:
485465
--[emulate|ios]--
486466
Usage:
487467
$ tns emulate ios [--path <Directory>] [--device <Device Name>] [--availableDevices] [--release] [--timeout]
488-
$ nativescript emulate ios [--path <Directory>] [--device <Device Name>] [--availableDevices] [--release] [--timeout]
489468

490469
Builds the specified project in the cloud and runs it in the native iOS Simulator.
491470

@@ -514,15 +493,11 @@ Options:
514493

515494
Usage:
516495
$ tns device [<Platform>] [--timeout <Milliseconds>]
517-
$ nativescript device [<Platform>] [--timeout <Milliseconds>]
518496
$ tns device [<Command>]
519-
$ nativescript device [<Command>]
520497

521498
Platform-specific usage:
522499
$ tns device android [--timeout <Milliseconds>]
523500
$ tns device ios [--timeout <Milliseconds>]
524-
$ nativescript device android [--timeout <Milliseconds>]
525-
$ nativescript device ios [--timeout <Milliseconds>]
526501

527502
Lists all recognized connected devices with serial number and index, grouped by platform. The NativeScript CLI recognizes running Android virtual devices as connected devices.
528503

@@ -544,7 +519,6 @@ Options:
544519
--[device|log]--
545520
Usage:
546521
$ tns device log --device <Device ID>
547-
$ nativescript device log --device <Device ID>
548522

549523
Opens the device log stream for a selected connected device.
550524

@@ -559,7 +533,6 @@ Options:
559533

560534
Usage:
561535
$ tns device list-applications [--device <Device ID>]
562-
$ nativescript device list-applications [--device <Device ID>]
563536

564537
Lists the installed applications on all connected Android and iOS devices.
565538

@@ -574,11 +547,13 @@ Options:
574547

575548
Usage:
576549
$ tns device run <ApplicationId> [--device <Device ID>]
577-
$ nativescript device run <ApplicationId> [--device <Device ID>]
578550

579551
Runs the selected application on a connected Android or iOS device.
580552
You can run this command on one connected device at a time.
581553

554+
<Application ID> is the application identifier as listed by $ tns device list-applications
555+
<Device ID> is the device index or identifier as listed by run $ tns device
556+
582557
Prerequisites:
583558
Before running your app on an iOS device, verify that your system and app meet the following requirements.
584559
* You are running the NativeScript CLI on an OS X system.
@@ -587,9 +562,6 @@ Before running your app on an iOS device, verify that your system and app meet t
587562
Before running your app on an Android device, verify that your app meets the following requirement.
588563
* You have built your app with the debug build configuration.
589564

590-
<Application ID> is the application identifier as listed by $ tns device list-applications
591-
<Device ID> is the device index or identifier as listed by run $ tns device
592-
593565
Options:
594566
--device - If multiple devices are connected, sets the device on which you want to run the app.
595567
You can run this command on one connected device at a time.

0 commit comments

Comments
 (0)