Skip to content

Commit 554cd82

Browse files
author
Iva Koevska
committed
Reworking help.txt
1 parent 07ff9a0 commit 554cd82

File tree

1 file changed

+96
-36
lines changed

1 file changed

+96
-36
lines changed

resources/help.txt

Lines changed: 96 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
Usage:
44
$ tns <command> [command parameters] [--command <options>]
5+
$ nativescript <command> [command parameters] [--command <options>]
56

67
General commands:
78
help <command> Shows additional information about the commands in this list.
@@ -11,13 +12,14 @@ General commands:
1112
platform list Lists all platforms that the project currently targets.
1213
platform remove Removes the selected platform from the platforms that the project currently targets.
1314
This operation deletes all platform-specific files and subdirectories from your project.
14-
prepare Copies cross-platform content to the subdirectory for the selected target platform.
15+
prepare Copies relevant content from the app directory to the subdirectory for the selected target platform.
1516
This lets you build the project with the SDK for the selected platform and deploy it on device.
16-
build Builds the project for the selected target platform and produces an application package.
17-
deploy Deploys the project to a connected device.
18-
emulate Deploys the project on emulator.
17+
build Builds the project for the selected target platform and produces an application package or an
18+
emulator package.
19+
deploy Deploys the project to a connected physical or virtual device.
20+
emulate Deploys the project in the native emulator for the selected target platform.
1921
run Runs your project on a connected device. This is shorthand for prepare, build, and deploy.
20-
list-devices Lists all recognized connected devices.
22+
list-devices Lists all recognized connected physical or virtual device.
2123
feature-usage-tracking Configures anonymous feature usage tracking.
2224

2325
General options:
@@ -31,6 +33,7 @@ General options:
3133

3234
Usage:
3335
$ tns help [<Command>]
36+
$ nativescript [<Command>]
3437

3538
Lists the available commands or shows information about the selected command.
3639
<Command> is any of the available commands as listed by $ tns help.
@@ -41,8 +44,9 @@ Lists the available commands or shows information about the selected command.
4144

4245
Usage:
4346
$ tns create <App name> [--path <Directory>] [--appid <App ID>] [--copy-from <Directory>]
47+
$ nativescript create <App name> [--path <Directory>] [--appid <App ID>] [--copy-from <Directory>]
4448

45-
Creates a new project for native development with NativeScript.
49+
Creates a new project for native development with NativeScript from the default template or from an existing NativeScript project.
4650
<App name> is the name of project. The specified name must meet the requirements of all platforms that you want to target.
4751
For projects that target Android, you can use uppercase or lowercase letters, numbers, and underscores. The name must start with a letter.
4852
For projects that target iOS, you can use uppercase or lowercase letters, numbers, and hyphens.
@@ -54,22 +58,23 @@ Options:
5458
meet the requirements of all platforms that you want to target.
5559
For projects that target Android, you can use uppercase or lowercase letters, numbers, and underscores in the strings of the reversed domain name, separated by a dot. Strings must be separated by a dot and must start with a letter. For example: com.nativescript.My_Andro1d_App
5660
For projects that target iOS, you can use uppercase or lowercase letters, numbers, and hyphens in the strings of the reversed domain name. Strings must be separated by a dot. For example: com.nativescript.My-i0s-App
57-
If not specified, the application identifier is set to com.telerik.<App name>.
58-
--copy-from - Specifies a directory which contains custom assets that you want to use in your NativeScript project. If not set,
59-
the default hello-world template is used.
61+
If not specified, the application identifier is set to org.nativescript.<App name>.
62+
--copy-from - Specifies a directory which contains an existing NativeScript project.
63+
If not set, the Telerik NativeScript CLI creates the project from the default hello-world template.
6064

6165
--[/]--
6266

6367
--[platform]--
6468

6569
Usage:
6670
$ tns platform <Command>
71+
$ nativescript platform <Command>
6772

6873
You must run the platform command with a related command.
6974

7075
<Command> is a related command that extends the platform command. You can run the following related commands:
7176
list - Lists all platforms that the project currently targets. You can build and deploy your project only for
72-
the active target platforms.
77+
these target platforms.
7378
add - Configures the current project to target the selected platform. After adding the target platform, you can
7479
build and deploy your app to it.
7580
remove - Removes the selected platform from the platforms that the project currently targets. After removing
@@ -82,110 +87,166 @@ You must run the platform command with a related command.
8287

8388
Usage:
8489
$ tns platform list
90+
$ nativescript platform list
8591

86-
Lists all platforms that the project currently targets. You can build and deploy your project only for the active target platforms.
92+
Lists all platforms that the project currently targets. You can build and deploy your project only for these target platforms.
8793

8894
--[/]--
8995

9096
--[platform|add]--
9197

9298
Usage:
9399
$ tns platform add <Platform>
100+
$ nativescript platform add <Platform>
94101

95102
Platform-specific usage:
96103
$ tns platform add android
97104
$ tns platform add ios
105+
$ nativescript platform add android
106+
$ nativescript platform add ios
98107

99108
Configures the current project to target the selected platform. When you add a target platform, the Telerik 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.
100109

101-
In this version of Telerik NativeScript, you can target iOS and Android, based on your system. You need to have your system configured for development with the target platform.
110+
In this version of the Telerik 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.
102111
On Windows systems, you can target Android.
103112
On OS X systems, you can target Android and iOS.
104113

105-
106114
--[/]--
107115

108116
--[platform|remove]--
109117

110118
Usage:
111-
$ tns platform remove <platform>
119+
$ tns platform remove <Platform>
120+
$ nativescript platform remove <Platform>
112121

113122
Platform-specific usage:
114123
$ tns platform remove android
115124
$ tns platform remove ios
125+
$ nativescript platform remove android
126+
$ nativescript platform remove ios
116127

117128
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 to it.
118129

119-
This operation deletes all platform-specific files and subdirectories from your project.
130+
This operation deletes the subdirectory for the selected platform from the platforms directory.
120131

121132
--[/]--
122133

123134
--[prepare]--
124135

125136
Usage:
126-
$ tns prepare [<Platform>]
137+
$ tns prepare <Platform>
138+
$ nativescript prepare <Platform>
127139

128140
Platform-specific usage:
129141
$ tns prepare android
130142
$ tns prepare ios
143+
$ nativescript prepare android
144+
$ nativescript prepare ios
131145

132-
Copies cross-platform content to the subdirectory for the selected target platform. This lets you build the project with
133-
the SDK for the selected platform.
146+
Copies common and relevant platform-specific content from the app directory to the subdirectory for the selected target platform
147+
in the platforms directory. This lets you build the project with the SDK for the selected platform.
134148

135149
--[/]--
136150

137151
--[build]--
138152

139153
Usage:
140-
$ tns build [<platform>]
154+
$ tns build <Platform> [--device] [--release]
155+
$ nativescript build <Platform> [--device] [--release]
141156

142157
Platform-specific usage:
143-
$ tns build android
144-
$ tns build ios
158+
$ tns build android [--release]
159+
$ tns build ios [--device] [--release]
160+
$ nativescript build android [--release]
161+
$ nativescript build ios [--device] [--release]
162+
163+
Builds the project for the selected target platform and produces an application package that you can manually deploy on device or in the native emulator.
145164

146-
Builds the project for the selected target platform. This generates platform-specific code within the platform subdirectory
147-
in the project.
165+
Before building for iOS device, verify that you have configured a valid pair of certificate and provisioning profile on your OS X system.
166+
167+
Options:
168+
--release - If set, produces a release build. Otherwise, produces a debug build.
169+
--device - This flag is applicable only to iOS. If set, produces an application package that you can deploy on device.
170+
Otherwise, produces a build that you can run only in the native iOS Simulator.
148171

149172
--[/]--
150173

151174
--[deploy]--
152-
Usage:
153-
$ tns deploy <Platform> [--device <Device ID>]
175+
176+
Usage:
177+
$ tns deploy <Platform> [--device <Device ID>]
178+
$ nativescript deploy <Platform> [--device <Device ID>]
154179

155180
Platform-specific usages:
156181
$ tns deploy android [--device <Device ID>]
157182
$ tns deploy ios [--device <Device ID>]
183+
$ nativescript deploy android [--device <Device ID>]
184+
$ nativescript deploy ios [--device <Device ID>]
185+
186+
Builds and deploys the project to a connected physical or virtual device.
187+
<Device ID> is the index or name of the target device as listed by $ tns list-devices.
158188

159-
Deploys the project to a connected device.
189+
Before building for iOS device, verify that you have configured a valid pair of certificate and provisioning profile on your OS X system.
160190

161191
--[/]--
162192

163193
--[run]--
164194

165195
Usage:
166-
$ tns run [<platform>]
196+
$ tns run <Platform> [--device <Device ID>]
197+
$ nativescript run <Platform> [--device <Device ID>]
167198

168199
Platform-specific usage:
169-
$ tns run android
170-
$ tns run ios
200+
$ tns run android [--device <Device ID>]
201+
$ tns run ios [--device <Device ID>]
202+
$ nativescript run android [--device <Device ID>]
203+
$ nativescript run ios [--device <Device ID>]
171204

172-
Runs your project on a connected device. This is shorthand for prepare, build, and deploy.
205+
Runs your project on connected device. This is shorthand for prepare, build, and deploy.
206+
<Device ID> is the index or name of the target device as listed by $ tns list-devices.
207+
208+
Before building for iOS device, verify that you have configured a valid pair of certificate and provisioning profile on your OS X system.
173209

174210
--[/]--
175211

176212
--[emulate]--
177213

178214
Usage:
179-
$ tns emulate [<platform>]
215+
$ tns emulate <Platform>
216+
$ nativescript emulate <Platform>
217+
218+
Platform-specific usage:
219+
$ tns emulate android
220+
$ tns emulate ios
221+
$ nativescript emulate android
222+
$ nativescript emulate ios
223+
224+
Builds and runs the project in the native emulator for the selected target platform.
180225

181-
Deploys the project on emulator.
226+
For Android, this operation runs your project in the earliest created virtual device or the currently running Android virtual device. Before running this command, verify that you have met the following requirements.
227+
You have added the file paths to the following directories from the Android SDK to your PATH environment variable.
228+
tools
229+
platform-tools
230+
You have created at least one device with the Android Virtual Device manager.
231+
For iOS, this operation runs your project in the iOS Simulator.
182232

183233
--[/]--
184234

185235
--[list-devices]--
186236

187-
Lists all recognized connected devices with serial number and index, grouped by platform. In this version of the Telerik NativeScript CLI,
188-
you can connect only iOS and Android devices.
237+
Usage:
238+
$ tns list-devices [<Platform>]
239+
$ nativescript list-devices [<Platform>]
240+
241+
Platform-specific usage:
242+
$ tns list-devices android
243+
$ tns list-devices ios
244+
$ nativescript list-devices android
245+
$ nativescript list-devices ios
246+
247+
Lists all recognized connected devices with serial number and index, grouped by platform. The Telerik NativeScript CLI recognizes running Android virtual devices as connected devices.
248+
249+
In this version of the Telerik NativeScript CLI, you can connect only iOS and Android devices.
189250

190251
If a connected Android device is not shown in the list, make sure that you have installed the required Android USB drivers on your system
191252
and that USB debugging is enabled on the device.
@@ -207,5 +268,4 @@ All data gathered is used strictly for improving the product and will never be u
207268
for improving the product and will never be used to identify or contact you.
208269
disable - Disables anonymous usage statistics tracking.
209270

210-
--[/]--
211-
271+
--[/]--

0 commit comments

Comments
 (0)