Skip to content

Commit 71f1abe

Browse files
author
Dimitar Tachev
authored
Merge pull request #4039 from NativeScript/ggarabed/update-help
docs: updates to the help
2 parents 16d9674 + 86dd3f4 commit 71f1abe

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+717
-369
lines changed

‎docs/man_pages/cloud/cloud-setup.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,19 @@
22
title: tns cloud setup
33
position: 5
44
---<% } %>
5+
56
# tns cloud setup
67

8+
### Description
9+
10+
Install the `nativescript-cloud extension` to configure your environment for cloud builds.
11+
12+
### Commands
713

814
Usage | Synopsis
915
------|-------
1016
Install the `nativescript-cloud extension` | `$ tns cloud setup`
1117

12-
Install the `nativescript-cloud extension` to configure your environment for cloud builds.
13-
1418
### Related Commands
1519

1620
Command | Description

‎docs/man_pages/device/device-android.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,23 @@
22
title: tns device android
33
position: 1
44
---<% } %>
5+
56
# tns device android
67

8+
### Description
9+
10+
Lists all recognized connected Android physical and running virtual devices with serial number and index. <% if(isHtml) { %>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 and that USB debugging is enabled on the device.<% } %>
11+
12+
### Commands
713

814
Usage | Synopsis
915
------|-------
1016
General | `$ tns device android [--timeout <Milliseconds>]`
1117

12-
Lists all recognized connected Android physical and running virtual devices with serial number and index. <% if(isHtml) { %>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 and that USB debugging is enabled on the device.<% } %>
13-
1418
### Options
19+
1520
* `--available-devices` - Lists all available emulators for Android.
16-
* `--timeout` - Sets the time in milliseconds for the operation to search for connected devices before completing. If not set, the default value is 4000. <% if(isHtml) { %>The operation will continue to wait and listen for newly connected devices and will list them after the specified time expires.
21+
* `--timeout` - Sets the time in milliseconds for the operation to search for connected devices before completing. If not set, the default value is 4000. <% if(isHtml) { %>The operation will continue to wait and listen for newly connected devices and will list them after the specified time expires.
1722

1823
### Related Commands
1924

‎docs/man_pages/device/device-ios.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,25 @@
22
title: tns device ios
33
position: 2
44
---<% } %>
5+
56
# tns device ios
67

8+
### Description
9+
10+
Lists all recognized connected iOS devices with serial number and index.
11+
12+
<% if(isConsole && (isLinux)) { %>WARNING: You can run this command only on Windows and macOS systems. To view the complete help for this command, run `$ tns help device ios`<% } %>
13+
14+
### Commands
715

816
Usage | Synopsis
917
------|-------
1018
General | `$ tns device ios [--timeout <Milliseconds>]`
1119

12-
Lists all recognized connected iOS devices with serial number and index.
13-
14-
<% if(isConsole && (isLinux)) { %>WARNING: You can run this command only on Windows and OS X systems. To view the complete help for this command, run `$ tns help device ios`<% } %>
15-
1620
<% if((isConsole && (isWindows || isMacOS)) || isHtml) { %>
21+
1722
### Options
23+
1824
* `--available-devices` - Lists all available emulators for iOS.
1925
* `--timeout` - Sets the time in milliseconds for the operation to search for connected devices before completing. If not set, the default value is 4000. <% } %><% if(isHtml) { %>The operation will continue to wait and listen for newly connected devices and will list them after the specified time expires.
2026

‎docs/man_pages/device/device-list-applications.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,25 @@
22
title: tns device list-applications
33
position: 3
44
---<% } %>
5+
56
# tns device list-applications
67

8+
### Description
9+
10+
Lists the installed applications on all connected Android <% if(isWindows || isMacOS) { %>and iOS <% } %>devices.
11+
12+
### Commands
713

814
Usage | Synopsis
915
------|-------
1016
General | `$ tns device list-applications [--device <Device ID>]`
1117

12-
Lists the installed applications on all connected Android <% if(isWindows || isMacOS) { %>and iOS <% } %>devices.
13-
1418
### Options
15-
* `--device` - If multiple devices are connected, sets the device for which you want to list all currently installed applications.
1619

17-
### Attributes
18-
* `<Device ID>` is the device index or identifier as listed by run `$ tns device`
20+
* `--device` - If multiple devices are connected, sets the device for which you want to list all currently installed applications. `<Device ID>` is the device index or identifier as listed by the `$ tns device` command.
21+
22+
<% if(isHtml) { %>
1923

20-
<% if(isHtml) { %>
2124
### Command Limitations
2225

2326
* You cannot work with connected iOS devices on Linux systems.

‎docs/man_pages/device/device-log.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,25 @@
22
title: tns device log
33
position: 4
44
---<% } %>
5+
56
# tns device log
67

8+
### Description
9+
10+
Opens the device log stream for a selected connected Android <% if(isWindows || isMacOS) { %>or iOS <% } %>device.
11+
12+
### Commands
713

814
Usage | Synopsis
915
------|-------
1016
General | `$ tns device log [--device <Device ID>]`
1117

12-
Opens the device log stream for a selected connected Android <% if(isWindows || isMacOS) { %>or iOS <% } %>device.
13-
1418
### Options
15-
* `--device` - If multiple devices are connected, sets the device for which you want to stream the log in the console.
1619

17-
### Attributes
18-
* `<Device ID>` is the device index or identifier as listed by `$ tns device`
20+
* `--device` - If multiple devices are connected, sets the device for which you want to stream the log in the console. `<Device ID>` is the device index or identifier as listed by the `$ tns device` command.
21+
22+
<% if(isHtml) { %>
1923

20-
<% if(isHtml) { %>
2124
### Command Limitations
2225

2326
* You cannot work with connected iOS devices on Linux systems.

‎docs/man_pages/device/device-run.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,36 @@
22
title: tns device run
33
position: 5
44
---<% } %>
5+
56
# tns device run
67

8+
### Description
9+
10+
Runs the selected application on a connected Android <% if(isMacOS) { %>or iOS <% } %>device.
11+
12+
<% if(isConsole && (isWindows || isLinux)) { %>WARNING: You can work only with connected Android devices.<% } %>
13+
14+
### Commands
715

816
Usage | Synopsis
917
------|-------
1018
General | `$ tns device run <Application ID> [--device <Device ID>]`
1119

12-
Runs the selected application on a connected Android <% if(isMacOS) { %>or iOS <% } %>device.
20+
### Options
1321

14-
<% if(isConsole && (isWindows || isLinux)) { %>WARNING: You can work only with connected Android devices.<% } %>
22+
* `--device` - If multiple devices are connected, sets the device on which you want to run the app. `<Device ID>` is the device index or identifier as listed by the `$ tns device` command.
1523

16-
### Options
17-
* `--device` - If multiple devices are connected, sets the device on which you want to run the app.
24+
### Arguments
1825

19-
### Attributes
20-
* `<Application ID>` is the application identifier as listed by `$ tns device list-applications`
21-
* `<Device ID>` is the device index or identifier as listed by run `$ tns device`
26+
* `<Application ID>` is the application identifier as listed by `$ tns device list-applications`.
2227

2328
<% if(isHtml) { %>
29+
2430
### Prerequisites
25-
Before running your app on an iOS device, verify that your system and app meet the following requirements.
2631

27-
* You are running the NativeScript CLI on an OS X system.
28-
* You have installed Xcode 5 or later.
32+
Before running your app on an iOS device, verify that your system and app meet the following requirements.
33+
* You are running the NativeScript CLI on a macOS system.
34+
* You have installed the latest version of Xcode.
2935
* You have built your app with the debug build configuration.
3036

3137
Before running your app on an Android device, verify that your app meets the following requirement.
@@ -35,7 +41,7 @@ Before running your app on an Android device, verify that your app meets the fol
3541
### Command Limitations
3642

3743
* You can run this command on one connected device at a time.
38-
* You can run this command for iOS devices only on OS X systems.
44+
* You can run this command for iOS devices only on macOS systems.
3945

4046
### Related Commands
4147

‎docs/man_pages/device/device.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,37 @@
22
title: tns device
33
position: 6
44
---<% } %>
5+
56
# tns device
67

8+
### Description
9+
10+
Lists all recognized connected Android <% if(isWindows || isMacOS) { %>or iOS devices <% } %>with serial number and index<% if(isWindows || isMacOS) { %>, grouped by platform<% } %>.
11+
12+
### Commands
713

814
Usage | Synopsis
915
------|---------
1016
General | `$ tns device [<Command>]`
1117

12-
Lists all recognized connected Android <% if(isWindows || isMacOS) { %>or iOS devices <% } %>with serial number and index<% if(isWindows || isMacOS) { %>, grouped by platform<% } %>.
18+
### Arguments
1319

14-
### Attributes
15-
`<Command>` extends the `device` command. You can set the following values for this attribute.
20+
`<Command>` extends the `device` command. You can set the following values for this argument:
1621
* `android` - Lists all recognized connected Android physical and running Android virtual devices.
17-
<% if(isWindows || isMacOS) { %>* `ios` - Lists all recognized connected iOS devices. <% } %>
22+
<% if(isWindows || isMacOS) { %>* `ios` - Lists all recognized connected iOS devices. <% } %>
1823
* `log` - Opens the device log stream for a selected connected device.
1924
* `list-applications` - Lists the installed applications on all connected Android <% if(isWindows || isMacOS) { %>or iOS <%}%>devices.
2025
* `run` - Runs the selected application on a connected Android <% if(isMacOS) { %>or iOS <%}%>device.
2126

22-
<% if(isHtml) { %>
27+
<% if(isHtml) { %>
28+
2329
### Command Limitations
2430

25-
* You can run `$ tns device ios` on Windows and OS X systems.
31+
* You can run `$ tns device ios` on Windows and macOS systems.
2632

2733
### Aliases
2834

29-
* You can use `$ tns devices` as an alias for `$ tns device`.
35+
* You can use `$ tns devices` as an alias for `$ tns device`.
3036

3137
### Related Commands
3238

‎docs/man_pages/env-configuration/setup.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,19 @@
22
title: tns setup
33
position: 5
44
---<% } %>
5+
56
# tns setup
67

8+
### Description
9+
10+
Run the setup script to automatically install the NativeScript dependencies and configure your environment for local builds.
11+
12+
### Commands
713

814
Usage | Synopsis
915
------|-------
1016
Run the setup script | `$ tns setup`
1117

12-
Run the setup script to try to automatically configure your environment for local builds.
13-
1418
### Related Commands
1519

1620
Command | Description

‎docs/man_pages/general/autocomplete-disable.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,23 @@
22
title: tns autocomplete disable
33
position: 1
44
---<% } %>
5+
56
# tns autocomplete disable
67

8+
### Description
9+
10+
Disables command-line completion for bash and zsh shells. You need to restart the shell to complete the operation.
11+
12+
<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files.
13+
14+
### Commands
715

816
Usage | Synopsis
917
------|-------
1018
General | `$ tns autocomplete disable`
1119

12-
Disables command-line completion for bash and zsh shells. You need to restart the shell to complete the operation.
13-
14-
<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files.
1520
<% if(isHtml) { %>
21+
1622
### Related Commands
1723

1824
Command | Description

‎docs/man_pages/general/autocomplete-enable.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,23 @@
22
title: tns autocomplete enable
33
position: 2
44
---<% } %>
5+
56
# tns autocomplete enable
67

8+
### Description
9+
10+
Enables command-line completion for bash and zsh shells. You need to restart the shell to complete the operation.
11+
12+
<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files.
13+
14+
### Commands
715

816
Usage | Synopsis
917
------|-------
1018
General | `$ tns autocomplete enable`
1119

12-
Enables command-line completion for bash and zsh shells. You need to restart the shell to complete the operation.
13-
14-
<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files.
1520
<% if(isHtml) { %>
21+
1622
### Related Commands
1723

1824
Command | Description

‎docs/man_pages/general/autocomplete-status.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,21 @@
22
title: tns autocomplete status
33
position: 3
44
---<% } %>
5+
56
# tns autocomplete status
67

8+
### Description
9+
10+
Prints your current command-line completion settings.
11+
12+
### Commands
713

814
Usage | Synopsis
915
------|-------
1016
General | `$ tns autocomplete status`
1117

12-
Prints your current command-line completion settings.
13-
1418
<% if(isHtml) { %>
19+
1520
### Related Commands
1621

1722
Command | Description

‎docs/man_pages/general/autocomplete.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,16 @@
22
title: tns autocomplete
33
position: 4
44
---<% } %>
5+
56
# tns autocomplete
67

8+
### Description
9+
10+
Prints your current command-line completion settings. If disabled, prompts you to enable it.
11+
12+
<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files.
13+
14+
### Commands
715

816
Usage | Synopsis
917
------|-------
@@ -12,17 +20,15 @@ Get settings | `$ tns autocomplete status`
1220
Enable | `$ tns autocomplete enable`
1321
Disable | `$ tns autocomplete disable`
1422

15-
Prints your current command-line completion settings. If disabled, prompts you to enable it.
23+
### Arguments
1624

17-
<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files.
18-
19-
### Attributes
2025
`<Command>` extends the `autocomplete` command. You can set the following values for this attribute.
2126
* `status` - Prints your current command-line completion settings.
2227
* `enable` - Enables command-line completion. You need to restart the shell to complete the operation.
2328
* `disable` - Disables command-line completion. You need to restart the shell to complete the operation.
2429

2530
<% if(isHtml) { %>
31+
2632
### Related Commands
2733

2834
Command | Description

0 commit comments

Comments
 (0)