Skip to content

Commit 2186194

Browse files
Tsvetan Raikovrosen-vladimirov
Tsvetan Raikov
authored andcommitted
Updated CLI documentation after behavior changes in run command
1 parent 47effaa commit 2186194

17 files changed

+41
-83
lines changed

docs/man_pages/project/testing/build-android.md

-3
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,6 @@ Command | Description
3737
[emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
3838
[emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
3939
[emulate](emulate.html) | You must run the emulate command with a related command.
40-
[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
41-
[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices or the iOS Simulator.
42-
[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
4340
[run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
4441
[run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
4542
[run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.

docs/man_pages/project/testing/build-ios.md

-3
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,6 @@ Command | Description
3636
[emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
3737
[emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
3838
[emulate](emulate.html) | You must run the emulate command with a related command.
39-
[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
40-
[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices or the iOS Simulator.
41-
[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
4239
[run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
4340
[run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
4441
[run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.

docs/man_pages/project/testing/build.md

-3
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,6 @@ Command | Description
3232
[emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
3333
[emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
3434
[emulate](emulate.html) | You must run the emulate command with a related command.
35-
[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
36-
[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices or the iOS Simulator.
37-
[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
3835
[run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
3936
[run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
4037
[run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.

docs/man_pages/project/testing/debug-android.md

+4-12
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,23 @@ Deploy in Genymotion, run the app and stop at the first code statement | `$ tns
1010
Attach the debug tools to a running app on device | `$ tns debug android --start [--device <Device ID>] [--debug-port <port>] [--timeout <timeout>]`
1111
Attach the debug tools to a running app in the native emulator | `$ tns debug android --start --emulator [<Emulator Options>] [--timeout <timeout>]`
1212
Attach the debug tools to a running app in Genymotion | `$ tns debug android --start --geny <Geny Name> [--print-app-output] [--timeout <timeout>]`
13-
Livesync on device, run the app start Chrome DevTools, and attach the debugger | `$ tns debug android --no-rebuild`
14-
Livesync on device, run the app and stop at the first code statement | `$ tns debug android --no-rebuild --debug-brk [--device <Device ID>] [--debug-port <port>] [--timeout <timeout>]`
15-
Livesync in the native emulator, run the app and stop at the first code statement | `$ tns debug android --no-rebuild --debug-brk --emulator [<Emulator Options>] [--timeout <timeout>]`
16-
Livesync in Genymotion, run the app and stop at the first code statement | `$ tns debug android --no-rebuild --debug-brk --geny <Geny Name> [--timeout <timeout>]`
17-
Livesync on device/emulator, run the app, start and attach the debugger. Refresh everything automatically upon changes | `$ tns debug android --watch [--debug-brk]`
1813
Retrieve the device port on which you are debugging | `$ tns debug android [--device <Device ID>] --get-port`
1914
Detach the debug tools | `$ tns debug android --stop`
2015

21-
Debugs your project on a connected device, in a native emulator or in Genymotion.
16+
Prepares, builds and deploys the project when necessary. Debugs your project on a connected device, in a native emulator or in Genymotion.
17+
While debugging, prints the output from the application in the console and watches for changes in your code. Once a change is detected, it synchronizes the change with all selected devices and restarts/refreshes the application.
2218

2319
### Options
2420
* `--device` - Specifies a connected device on which to debug the app.
2521
* `--emulator` - Specifies that you want to debug the app in the native Android emulator from the Android SDK.
26-
* `--geny` - Specifies a Genymotion emulator on which you want to debug your app.
2722
* `--debug-brk` - Prepares, builds and deploys the application package on a device or in an emulator, launches the Chrome DevTools of your Chrome browser and stops at the first code statement.
2823
* `--start` - Attaches the debug tools to a deployed and running app.
2924
* `--stop` - Detaches the debug tools.
3025
* `--get-port` - Retrieves the port on which you are debugging your application.
3126
* `--debug-port` - Sets a new port on which to attach the debug tools.
3227
* `--timeout` - Sets the number of seconds that the NativeScript CLI will wait for the debugger to boot. If not set, the default timeout is 90 seconds.
33-
* `--no-rebuild` - Livesyncs to device/emulator when possible. Otherwise builds and deploys the application.
34-
* `--watch` - If set, when you save changes to the project, changes are automatically synchronized to the connected device and the debugger is restarted. This option is available only when using `--no-rebuild`.
28+
* `--no-watch` - If set, changes in your code will not be reflected during the execution of this command.
29+
* `--clean` - If set, forces rebuilding the native application.
3530

3631
### Attributes
3732
* `<Device ID>` is the index or name of the target device as listed by `$ tns device`
@@ -57,9 +52,6 @@ Command | Description
5752
[emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
5853
[emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
5954
[emulate](emulate.html) | You must run the emulate command with a related command.
60-
[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
61-
[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices or the iOS Simulator.
62-
[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
6355
[run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
6456
[run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
6557
[run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.

docs/man_pages/project/testing/debug-ios.md

+6-11
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,24 @@ Deploy on device, run the app and stop at the first code statement | `$ tns debu
88
Deploy in the iOS Simulator, run the app and stop at the first code statement | `$ tns debug ios --debug-brk --emulator [<Emulator Options>] [--no-client]`
99
Attach the debug tools to a running app on device | `$ tns debug ios --start [--device <Device ID>] [--no-client]`
1010
Attach the debug tools to a running app in the iOS Simulator | `$ tns debug ios --start --emulator [<Emulator Options>] [--no-client]`
11-
Livesync on device, run the app, start Safari Web Inspector and attach the debugger | `$ tns debug ios --no-rebuild`
12-
Livesync on device, run the app and stop at the first code statement | `$ tns debug ios --no-rebuild --debug-brk [--device <Device ID>] [--no-client]`
13-
Livesync in the iOS Simulator, run the app and stop at the first code statement | `$ tns debug ios --no-rebuild --debug-brk --emulator [<Emulator Options>] [--no-client]`
14-
Livesync on device/simulator, run the app, start and attach the debugger. Refresh everything automatically upon changes | `$ tns debug ios --watch [--debug-brk]`
1511

16-
Debugs your project on a connected device or in the iOS Simulator. <% if(isHtml) { %>Any debugging traffic is forwarded on port 8080 from the device to the local machine.<% } %>
12+
Prepares, builds and deploys the project when necessary. Debugs your project on a connected device or in the iOS Simulator. <% if(isHtml) { %>Any debugging traffic is forwarded on port 8080 from the device to the local machine.<% } %>
13+
While debugging, prints the output from the application in the console and watches for changes in your code. Once a change is detected, it synchronizes the change with all selected devices and restarts/refreshes the application.
1714

1815
<% if(isConsole && (isWindows || isLinux)) { %>WARNING: You can run this command only on OS X systems. To view the complete help for this command, run `$ tns help debug ios`<% } %>
1916

2017
<% if((isConsole && isMacOS) || isHtml) { %>
2118
<% if(isHtml) { %>> <% } %>IMPORTANT: Before building for iOS device, verify that you have configured a valid pair of certificate and provisioning profile on your OS X system. <% if(isHtml) { %>For more information, see [Obtaining Signing Identities and Downloading Provisioning Profiles](https://developer.apple.com/library/mac/recipes/xcode_help-accounts_preferences/articles/obtain_certificates_and_provisioning_profiles.html).<% } %>
2219

2320
### Options
21+
* `--device` - Specifies a connected device on which to run the app.
22+
* `--emulator` - Indicates that you want to debug your app in the iOS simulator.
2423
* `--debug-brk` - Prepares, builds and deploys the application package on a device or in an emulator, runs the app, launches the developer tools of your Safari browser and stops at the first code statement.
2524
* `--start` - Attaches the debug tools to a deployed and running app and launches the developer tools of your Safari browser.
26-
* `--emulator` - Indicates that you want to debug your app in the iOS simulator.
2725
* `--no-client` - If set, the NativeScript CLI attaches the debug tools but does not launch the developer tools in Safari.
2826
* `--timeout` - Sets the number of seconds that NativeScript CLI will wait for the debugger to boot. If not set, the default timeout is 90 seconds.
29-
* `--no-rebuild` - Livesyncs to device/emulator when possible. Otherwise builds and deploys the application.
30-
* `--watch` - If set, when you save changes to the project, changes are automatically synchronized to the connected device and the debugger is restarted. This option is available only when using `--no-rebuild`.
27+
* `--no-watch` - If set, changes in your code will not be reflected during the execution of this command.
28+
* `--clean` - If set, forces rebuilding the native application.
3129

3230
### Attributes
3331
* `<Device ID>` is the index or name of the target device as listed by `$ tns device`
@@ -55,9 +53,6 @@ Command | Description
5553
[emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
5654
[emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
5755
[emulate](emulate.html) | You must run the emulate command with a related command.
58-
[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
59-
[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices or the iOS Simulator.
60-
[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
6156
[run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
6257
[run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
6358
[run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.

docs/man_pages/project/testing/debug.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Usage | Synopsis
55
---|---
66
<% if((isConsole && isMacOS) || isHtml) { %>General | `$ tns debug <Platform>`<% } %><% if(isConsole && (isLinux || isWindows)) { %>General | `$ tns debug android`<% } %>
77

8-
Debugs your project on a connected device or in a native emulator. <% if(isMacOS) { %>You must specify the target platform on which you want to debug.<% } %>
8+
Debugs your project on a connected device or in a native emulator. <% if(isMacOS) { %>You must specify the target platform on which you want to debug.<% } %> The command will prepare, build and deploy the app when necessary. By default listens for changes in your code, synchronizes those changes and refreshes the selected device.
99

1010
<% if((isConsole && isMacOS) || isHtml) { %>### Attributes
1111
`<Platform>` is the target mobile platform for which you want to debug your project. You can set the following target platforms.
@@ -30,9 +30,6 @@ Command | Description
3030
[emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
3131
[emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
3232
[emulate](emulate.html) | You must run the emulate command with a related command.
33-
[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
34-
[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices or the iOS Simulator.
35-
[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
3633
[run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
3734
[run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
3835
[run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.

docs/man_pages/project/testing/deploy.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Usage | Synopsis
66
Deploy on Android | `$ tns deploy android [--device <Device ID>] [--key-store-path <File Path> --key-store-password <Password> --key-store-alias <Name> --key-store-alias-password <Password>] [--release]`
77
<% if(isMacOS) { %>Deploy on iOS | `$ tns deploy ios [--device <Device ID>] [--release]`<% } %>
88

9-
Builds and deploys the project to a connected physical or virtual device. <% if(isMacOS) { %>You must specify the target platform on which you want to deploy.<% } %>
9+
Prepares, builds and deploys the project to a connected physical or virtual device. <% if(isMacOS) { %>You must specify the target platform on which you want to deploy.<% } %> It will deploy the app on all connected devices targeting the selected platform.
1010

1111
<% if(isMacOS) { %>
1212
<% if(isHtml) { %>> <% } %>IMPORTANT: Before building for iOS device, verify that you have configured a valid pair of certificate and provisioning profile on your OS X system. <% if(isHtml) { %>For more information, see [Obtaining Signing Identities and Downloading Provisioning Profiles](https://developer.apple.com/library/mac/recipes/xcode_help-accounts_preferences/articles/obtain_certificates_and_provisioning_profiles.html).<% } %>
@@ -24,7 +24,7 @@ Builds and deploys the project to a connected physical or virtual device. <% if(
2424
* `--key-store-alias-password` - Provides the password for the alias specified with `--key-store-alias-password`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options.
2525

2626
### Attributes
27-
* `<Device ID>` is the index or name of the target device as listed by `$ tns device`
27+
* `<Device ID>` is the index or name of the target device as listed by `$ tns devices`
2828

2929
<% if(isHtml) { %>
3030
### Command Limitations
@@ -47,9 +47,6 @@ Command | Description
4747
[emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
4848
[emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
4949
[emulate](emulate.html) | You must run the emulate command with a related command.
50-
[livesync](livesync.html) | Synchronizes the latest changes in your project to devices.
51-
[livesync ios](livesync-ios.html) | Synchronizes the latest changes in your project to iOS devices or the iOS Simulator.
52-
[livesync android](livesync-android.html) | Synchronizes the latest changes in your project to Android devices.
5350
[run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
5451
[run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
5552
[run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.

0 commit comments

Comments
 (0)