Skip to content

Commit 895bc64

Browse files
committed
Merge pull request #82 from NativeScript/ns-helptxt
Reworking help.txt
2 parents aa19c94 + 874b888 commit 895bc64

File tree

1 file changed

+110
-37
lines changed

1 file changed

+110
-37
lines changed

resources/help.txt

Lines changed: 110 additions & 37 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,15 @@ 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.
19-
run Runs your project on a connected device. This is shorthand for prepare, build, and deploy.
20-
list-devices Lists all recognized connected devices.
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.
21+
run Runs your project on a connected device or in the native emulator, if configured.
22+
This is shorthand for prepare, build, and deploy.
23+
list-devices Lists all recognized connected physical or virtual device.
2124
feature-usage-tracking Configures anonymous feature usage tracking.
2225

2326
General options:
@@ -31,6 +34,7 @@ General options:
3134

3235
Usage:
3336
$ tns help [<Command>]
37+
$ nativescript [<Command>]
3438

3539
Lists the available commands or shows information about the selected command.
3640
<Command> is any of the available commands as listed by $ tns help.
@@ -41,8 +45,9 @@ Lists the available commands or shows information about the selected command.
4145

4246
Usage:
4347
$ tns create <App name> [--path <Directory>] [--appid <App ID>] [--copy-from <Directory>]
48+
$ nativescript create <App name> [--path <Directory>] [--appid <App ID>] [--copy-from <Directory>]
4449

45-
Creates a new project for native development with NativeScript.
50+
Creates a new project for native development with NativeScript from the default template or from an existing NativeScript project.
4651
<App name> is the name of project. The specified name must meet the requirements of all platforms that you want to target.
4752
For projects that target Android, you can use uppercase or lowercase letters, numbers, and underscores. The name must start with a letter.
4853
For projects that target iOS, you can use uppercase or lowercase letters, numbers, and hyphens.
@@ -54,22 +59,23 @@ Options:
5459
meet the requirements of all platforms that you want to target.
5560
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
5661
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.
62+
If not specified, the application identifier is set to org.nativescript.<App name>.
63+
--copy-from - Specifies a directory which contains an existing NativeScript project.
64+
If not set, the Telerik NativeScript CLI creates the project from the default hello-world template.
6065

6166
--[/]--
6267

6368
--[platform]--
6469

6570
Usage:
6671
$ tns platform <Command>
72+
$ nativescript platform <Command>
6773

6874
You must run the platform command with a related command.
6975

7076
<Command> is a related command that extends the platform command. You can run the following related commands:
7177
list - Lists all platforms that the project currently targets. You can build and deploy your project only for
72-
the active target platforms.
78+
these target platforms.
7379
add - Configures the current project to target the selected platform. After adding the target platform, you can
7480
build and deploy your app to it.
7581
remove - Removes the selected platform from the platforms that the project currently targets. After removing
@@ -82,110 +88,178 @@ You must run the platform command with a related command.
8288

8389
Usage:
8490
$ tns platform list
91+
$ nativescript platform list
8592

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

8895
--[/]--
8996

9097
--[platform|add]--
9198

9299
Usage:
93100
$ tns platform add <Platform>
101+
$ nativescript platform add <Platform>
94102

95103
Platform-specific usage:
96104
$ tns platform add android
97105
$ tns platform add ios
106+
$ nativescript platform add android
107+
$ nativescript platform add ios
98108

99109
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.
100110

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.
111+
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.
102112
On Windows systems, you can target Android.
103113
On OS X systems, you can target Android and iOS.
104114

105-
106115
--[/]--
107116

108117
--[platform|remove]--
109118

110119
Usage:
111-
$ tns platform remove <platform>
120+
$ tns platform remove <Platform>
121+
$ nativescript platform remove <Platform>
112122

113123
Platform-specific usage:
114124
$ tns platform remove android
115125
$ tns platform remove ios
126+
$ nativescript platform remove android
127+
$ nativescript platform remove ios
116128

117129
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.
118130

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

121133
--[/]--
122134

123135
--[prepare]--
124136

125137
Usage:
126-
$ tns prepare [<Platform>]
138+
$ tns prepare <Platform>
139+
$ nativescript prepare <Platform>
127140

128141
Platform-specific usage:
129142
$ tns prepare android
130143
$ tns prepare ios
144+
$ nativescript prepare android
145+
$ nativescript prepare ios
131146

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.
147+
Copies common and relevant platform-specific content from the app directory to the subdirectory for the selected target platform
148+
in the platforms directory. This lets you build the project with the SDK for the selected platform.
134149

135150
--[/]--
136151

137152
--[build]--
138153

139154
Usage:
140-
$ tns build [<platform>]
155+
$ tns build <Platform> [--device] [--release]
156+
$ nativescript build <Platform> [--device] [--release]
141157

142158
Platform-specific usage:
143-
$ tns build android
144-
$ tns build ios
159+
$ tns build android [--release]
160+
$ tns build ios [--device] [--release]
161+
$ nativescript build android [--release]
162+
$ nativescript build ios [--device] [--release]
163+
164+
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.
165+
166+
Before building for iOS device, verify that you have configured a valid pair of certificate and provisioning profile on your OS X system.
145167

146-
Builds the project for the selected target platform. This generates platform-specific code within the platform subdirectory
147-
in the project.
168+
Options:
169+
--release - If set, produces a release build. Otherwise, produces a debug build.
170+
--device - This flag is applicable only to iOS. If set, produces an application package that you can deploy on device.
171+
Otherwise, produces a build that you can run only in the native iOS Simulator.
148172

149173
--[/]--
150174

151175
--[deploy]--
152-
Usage:
153-
$ tns deploy <Platform> [--device <Device ID>]
176+
177+
Usage:
178+
$ tns deploy <Platform> [--device <Device ID>]
179+
$ nativescript deploy <Platform> [--device <Device ID>]
154180

155181
Platform-specific usages:
156182
$ tns deploy android [--device <Device ID>]
157183
$ tns deploy ios [--device <Device ID>]
184+
$ nativescript deploy android [--device <Device ID>]
185+
$ nativescript deploy ios [--device <Device ID>]
158186

159-
Deploys the project to a connected device.
187+
Builds and deploys the project to a connected physical or virtual device.
188+
<Device ID> is the index or name of the target device as listed by $ tns list-devices.
189+
190+
Before building for iOS device, verify that you have configured a valid pair of certificate and provisioning profile on your OS X system.
160191

161192
--[/]--
162193

163194
--[run]--
164195

165196
Usage:
166-
$ tns run [<platform>]
197+
$ tns run <Platform> [--device <Device ID>] [--emulator]
198+
$ nativescript run <Platform> [--device <Device ID>] [--emulator]
167199

168200
Platform-specific usage:
169-
$ tns run android
170-
$ tns run ios
201+
$ tns run android [--device <Device ID>] [--emulator]
202+
$ tns run ios [--device <Device ID>] [--emulator]
203+
$ nativescript run android [--device <Device ID>] [--emulator]
204+
$ nativescript run ios [--device <Device ID>] [--emulator]
205+
206+
Runs your project on a connected device or in the native emulator, if configured. This is shorthand for prepare, build, and deploy.
207+
<Device ID> is the index or name of the target device as listed by $ tns list-devices.
208+
209+
Before building for the Android emulator, verify that you have met the following requirements.
210+
You have added the file paths to the following directories from the Android SDK to your PATH environment variable.
211+
tools
212+
platform-tools
213+
You have created at least one device with the Android Virtual Device manager.
214+
215+
Before building for the iOS simulator, verify that you have installed the ios-sim npm package.
216+
217+
Before building for iOS device, verify that you have configured a valid pair of certificate and provisioning profile on your OS X system.
171218

172-
Runs your project on a connected device. This is shorthand for prepare, build, and deploy.
219+
Options:
220+
--device - Specifies a connected device on which to run the app.
221+
--emulator - If set, runs the app in the native emulator for the target platform, if configured.
173222

174223
--[/]--
175224

176225
--[emulate]--
177226

178227
Usage:
179-
$ tns emulate [<platform>]
228+
$ tns emulate <Platform>
229+
$ nativescript emulate <Platform>
230+
231+
Platform-specific usage:
232+
$ tns emulate android
233+
$ tns emulate ios
234+
$ nativescript emulate android
235+
$ nativescript emulate ios
180236

181-
Deploys the project on emulator.
237+
Builds and runs the project in the native emulator for the selected target platform.
238+
239+
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.
240+
You have added the file paths to the following directories from the Android SDK to your PATH environment variable.
241+
tools
242+
platform-tools
243+
You have created at least one device with the Android Virtual Device manager.
244+
For iOS, this operation runs your project in the iOS Simulator. Before running this command, verify that you have installed the ios-sim npm package.
182245

183246
--[/]--
184247

185248
--[list-devices]--
186249

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.
250+
Usage:
251+
$ tns list-devices [<Platform>]
252+
$ nativescript list-devices [<Platform>]
253+
254+
Platform-specific usage:
255+
$ tns list-devices android
256+
$ tns list-devices ios
257+
$ nativescript list-devices android
258+
$ nativescript list-devices ios
259+
260+
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.
261+
262+
In this version of the Telerik NativeScript CLI, you can connect only iOS and Android devices.
189263

190264
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
191265
and that USB debugging is enabled on the device.
@@ -207,5 +281,4 @@ All data gathered is used strictly for improving the product and will never be u
207281
for improving the product and will never be used to identify or contact you.
208282
disable - Disables anonymous usage statistics tracking.
209283

210-
--[/]--
211-
284+
--[/]--

0 commit comments

Comments
 (0)