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
Updated CLI documentation after behavior changes in run command (#2435)
* Updated CLI documentation after behavior changes in run command
* Remove usages of in help content.
* Update message for livesync deprecation as it should not contain concrete release version
Copy file name to clipboardExpand all lines: docs/man_pages/project/testing/debug-android.md
+5-16
Original file line number
Diff line number
Diff line change
@@ -6,39 +6,31 @@ Usage | Synopsis
6
6
Deploy on device, run the app start Chrome DevTools, and attach the debugger | `$ tns debug android`
7
7
Deploy on device, run the app and stop at the first code statement | `$ tns debug android --debug-brk [--device <Device ID>] [--debug-port <port>] [--timeout <timeout>]`
8
8
Deploy in the native emulator, run the app and stop at the first code statement | `$ tns debug android --debug-brk --emulator [<Emulator Options>] [--timeout <timeout>]`
9
-
Deploy in Genymotion, run the app and stop at the first code statement | `$ tns debug android --debug-brk --geny <Geny Name> [--timeout <timeout>]`
10
9
Attach the debug tools to a running app on device | `$ tns debug android --start [--device <Device ID>] [--debug-port <port>] [--timeout <timeout>]`
11
10
Attach the debug tools to a running app in the native emulator | `$ tns debug android --start --emulator [<Emulator Options>] [--timeout <timeout>]`
12
-
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]`
18
11
Detach the debug tools | `$ tns debug android --stop`
19
12
20
-
Debugs your project on a connected device, in a native emulator or in Genymotion.
13
+
Prepares, builds and deploys the project when necessary. Debugs your project on a connected device or emulator.
14
+
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.
21
15
22
16
### Options
23
17
*`--device` - Specifies a connected device on which to debug the app.
24
18
*`--emulator` - Specifies that you want to debug the app in the native Android emulator from the Android SDK.
25
-
*`--geny` - Specifies a Genymotion emulator on which you want to debug your app.
26
19
*`--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.
27
20
*`--start` - Attaches the debug tools to a deployed and running app.
28
21
*`--stop` - Detaches the debug tools.
29
22
*`--debug-port` - Sets a new port on which to attach the debug tools.
30
23
*`--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.
31
-
*`--no-rebuild` - Livesyncs to device/emulator when possible. Otherwise builds and deploys the application.
32
-
*`--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`.
24
+
*`--no-watch` - If set, changes in your code will not be reflected during the execution of this command.
25
+
*`--clean` - If set, forces rebuilding the native application.
33
26
34
27
### Attributes
35
28
*`<Device ID>` is the index or name of the target device as listed by `$ tns device`
36
29
*`<Port>` is an accessible port on the device to which you want to attach the debugging tools.
37
30
*`<Emulator Options>` is any valid combination of options as listed by `$ tns help emulate android`
38
-
*`<GenyName>` is the name of the Genymotion virtual device that you want to use as listed by `$ genyshell -c "devices list"`
39
31
40
32
<% if(isHtml) { %>
41
-
###Prerequisites
33
+
###Prerequisites
42
34
43
35
* You must have Chrome installed on your system.<br/>If you are using a non-standard named Chrome app on an OS X system (for example, a nightly Canary update), you need to set this name in the `ANDROID_DEBUG_UI_MAC` setting in the NativeScript [config.json](file:///<%= #{config.getConfigPath(config)} %>).
44
36
@@ -55,9 +47,6 @@ Command | Description
55
47
[emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
56
48
[emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
57
49
[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.
61
50
[run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
62
51
[run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
63
52
[run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
Copy file name to clipboardExpand all lines: docs/man_pages/project/testing/debug-ios.md
+6-11
Original file line number
Diff line number
Diff line change
@@ -8,26 +8,24 @@ Deploy on device, run the app and stop at the first code statement | `$ tns debu
8
8
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]`
9
9
Attach the debug tools to a running app on device | `$ tns debug ios --start [--device <Device ID>] [--no-client]`
10
10
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]`
15
11
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.
17
14
18
15
<% 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`<% } %>
19
16
20
17
<% if((isConsole && isMacOS) || isHtml) { %>
21
18
<% 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).<% } %>
22
19
23
20
### 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.
24
23
*`--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.
25
24
*`--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.
27
25
*`--no-client` - If set, the NativeScript CLI attaches the debug tools but does not launch the developer tools in Safari.
28
26
*`--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.
31
29
32
30
### Attributes
33
31
*`<Device ID>` is the index or name of the target device as listed by `$ tns device`
@@ -55,9 +53,6 @@ Command | Description
55
53
[emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
56
54
[emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
57
55
[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.
61
56
[run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
62
57
[run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
63
58
[run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
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.
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.
10
10
11
11
<% if(isMacOS) { %>
12
12
<% 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(
24
24
*`--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.
25
25
26
26
### 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`
28
28
29
29
<% if(isHtml) { %>
30
30
### Command Limitations
@@ -47,9 +47,6 @@ Command | Description
47
47
[emulate android](emulate-android.html) | Builds the specified project and runs it in a native Android emulator.
48
48
[emulate ios](emulate-ios.html) | Builds the specified project and runs it in the native iOS Simulator.
49
49
[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.
53
50
[run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
54
51
[run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
55
52
[run](run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
0 commit comments