Skip to content

Merge release into master #4064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 25, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/man_pages/cloud/cloud-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,19 @@
title: tns cloud setup
position: 5
---<% } %>

# tns cloud setup

### Description

Install the `nativescript-cloud extension` to configure your environment for cloud builds.

### Commands

Usage | Synopsis
------|-------
Install the `nativescript-cloud extension` | `$ tns cloud setup`

Install the `nativescript-cloud extension` to configure your environment for cloud builds.

### Related Commands

Command | Description
Expand Down
11 changes: 8 additions & 3 deletions docs/man_pages/device/device-android.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,23 @@
title: tns device android
position: 1
---<% } %>

# tns device android

### Description

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.<% } %>

### Commands

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

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.<% } %>

### Options

* `--available-devices` - Lists all available emulators for Android.
* `--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.
* `--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.

### Related Commands

Expand Down
14 changes: 10 additions & 4 deletions docs/man_pages/device/device-ios.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,25 @@
title: tns device ios
position: 2
---<% } %>

# tns device ios

### Description

Lists all recognized connected iOS devices with serial number and index.

<% 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`<% } %>

### Commands

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

Lists all recognized connected iOS devices with serial number and index.

<% 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`<% } %>

<% if((isConsole && (isWindows || isMacOS)) || isHtml) { %>

### Options

* `--available-devices` - Lists all available emulators for iOS.
* `--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.

Expand Down
15 changes: 9 additions & 6 deletions docs/man_pages/device/device-list-applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,25 @@
title: tns device list-applications
position: 3
---<% } %>

# tns device list-applications

### Description

Lists the installed applications on all connected Android <% if(isWindows || isMacOS) { %>and iOS <% } %>devices.

### Commands

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

Lists the installed applications on all connected Android <% if(isWindows || isMacOS) { %>and iOS <% } %>devices.

### Options
* `--device` - If multiple devices are connected, sets the device for which you want to list all currently installed applications.

### Attributes
* `<Device ID>` is the device index or identifier as listed by run `$ tns device`
* `--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.

<% if(isHtml) { %>

<% if(isHtml) { %>
### Command Limitations

* You cannot work with connected iOS devices on Linux systems.
Expand Down
15 changes: 9 additions & 6 deletions docs/man_pages/device/device-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,25 @@
title: tns device log
position: 4
---<% } %>

# tns device log

### Description

Opens the device log stream for a selected connected Android <% if(isWindows || isMacOS) { %>or iOS <% } %>device.

### Commands

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

Opens the device log stream for a selected connected Android <% if(isWindows || isMacOS) { %>or iOS <% } %>device.

### Options
* `--device` - If multiple devices are connected, sets the device for which you want to stream the log in the console.

### Attributes
* `<Device ID>` is the device index or identifier as listed by `$ tns device`
* `--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.

<% if(isHtml) { %>

<% if(isHtml) { %>
### Command Limitations

* You cannot work with connected iOS devices on Linux systems.
Expand Down
28 changes: 17 additions & 11 deletions docs/man_pages/device/device-run.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,36 @@
title: tns device run
position: 5
---<% } %>

# tns device run

### Description

Runs the selected application on a connected Android <% if(isMacOS) { %>or iOS <% } %>device.

<% if(isConsole && (isWindows || isLinux)) { %>WARNING: You can work only with connected Android devices.<% } %>

### Commands

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

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

<% if(isConsole && (isWindows || isLinux)) { %>WARNING: You can work only with connected Android devices.<% } %>
* `--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.

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

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

<% if(isHtml) { %>

### Prerequisites
Before running your app on an iOS device, verify that your system and app meet the following requirements.

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

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

* You can run this command on one connected device at a time.
* You can run this command for iOS devices only on OS X systems.
* You can run this command for iOS devices only on macOS systems.

### Related Commands

Expand Down
20 changes: 13 additions & 7 deletions docs/man_pages/device/device.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,37 @@
title: tns device
position: 6
---<% } %>

# tns device

### Description

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

### Commands

Usage | Synopsis
------|---------
General | `$ tns device [<Command>]`

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

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

<% if(isHtml) { %>
<% if(isHtml) { %>

### Command Limitations

* You can run `$ tns device ios` on Windows and OS X systems.
* You can run `$ tns device ios` on Windows and macOS systems.

### Aliases

* You can use `$ tns devices` as an alias for `$ tns device`.
* You can use `$ tns devices` as an alias for `$ tns device`.

### Related Commands

Expand Down
8 changes: 6 additions & 2 deletions docs/man_pages/env-configuration/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,19 @@
title: tns setup
position: 5
---<% } %>

# tns setup

### Description

Run the setup script to automatically install the NativeScript dependencies and configure your environment for local builds.

### Commands

Usage | Synopsis
------|-------
Run the setup script | `$ tns setup`

Run the setup script to try to automatically configure your environment for local builds.

### Related Commands

Command | Description
Expand Down
12 changes: 9 additions & 3 deletions docs/man_pages/general/autocomplete-disable.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,23 @@
title: tns autocomplete disable
position: 1
---<% } %>

# tns autocomplete disable

### Description

Disables command-line completion for bash and zsh shells. You need to restart the shell to complete the operation.

<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files.

### Commands

Usage | Synopsis
------|-------
General | `$ tns autocomplete disable`

Disables command-line completion for bash and zsh shells. You need to restart the shell to complete the operation.

<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files.
<% if(isHtml) { %>

### Related Commands

Command | Description
Expand Down
12 changes: 9 additions & 3 deletions docs/man_pages/general/autocomplete-enable.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,23 @@
title: tns autocomplete enable
position: 2
---<% } %>

# tns autocomplete enable

### Description

Enables command-line completion for bash and zsh shells. You need to restart the shell to complete the operation.

<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files.

### Commands

Usage | Synopsis
------|-------
General | `$ tns autocomplete enable`

Enables command-line completion for bash and zsh shells. You need to restart the shell to complete the operation.

<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files.
<% if(isHtml) { %>

### Related Commands

Command | Description
Expand Down
9 changes: 7 additions & 2 deletions docs/man_pages/general/autocomplete-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,21 @@
title: tns autocomplete status
position: 3
---<% } %>

# tns autocomplete status

### Description

Prints your current command-line completion settings.

### Commands

Usage | Synopsis
------|-------
General | `$ tns autocomplete status`

Prints your current command-line completion settings.

<% if(isHtml) { %>

### Related Commands

Command | Description
Expand Down
14 changes: 10 additions & 4 deletions docs/man_pages/general/autocomplete.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,16 @@
title: tns autocomplete
position: 4
---<% } %>

# tns autocomplete

### Description

Prints your current command-line completion settings. If disabled, prompts you to enable it.

<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files.

### Commands

Usage | Synopsis
------|-------
Expand All @@ -12,17 +20,15 @@ Get settings | `$ tns autocomplete status`
Enable | `$ tns autocomplete enable`
Disable | `$ tns autocomplete disable`

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

<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files.

### Attributes
`<Command>` extends the `autocomplete` command. You can set the following values for this attribute.
* `status` - Prints your current command-line completion settings.
* `enable` - Enables command-line completion. You need to restart the shell to complete the operation.
* `disable` - Disables command-line completion. You need to restart the shell to complete the operation.

<% if(isHtml) { %>

### Related Commands

Command | Description
Expand Down
Loading