From 5b2b4d9d85a5d3bda5930748c5a8b1e14c3dbb1a Mon Sep 17 00:00:00 2001 From: Iva Koevska Date: Thu, 2 Jul 2015 13:58:23 +0300 Subject: [PATCH] Documenting `$ tns doctor` --- README.md | 30 +++++++++++++++++-- .../man_pages/general/autocomplete-disable.md | 2 +- docs/man_pages/general/autocomplete-enable.md | 2 +- docs/man_pages/general/autocomplete-status.md | 2 +- docs/man_pages/general/autocomplete.md | 2 +- docs/man_pages/general/doctor.md | 3 +- .../general/feature-usage-tracking-disable.md | 2 +- .../general/feature-usage-tracking-enable.md | 2 +- .../general/feature-usage-tracking-status.md | 2 +- .../general/feature-usage-tracking.md | 2 +- docs/man_pages/general/help.md | 2 +- docs/man_pages/index.md | 1 + 12 files changed, 38 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 40ec59b5be..7f5796e787 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ The NativeScript CLI lets you create, build, and deploy NativeScript-based proje * [Deploy Your Project](#deploy-your-project) * [Emulate Your Project](#emulate-your-project) * [Run Your Project](#run-your-project) +* [Troubleshooting](#troubleshooting) * [Known Issues](#known-issues) * [How to Contribute](#how-to-contribute) * [License](#license) @@ -130,7 +131,7 @@ If you have installed Chocolatey, you can complete these steps to set up JDK, Ap ```Shell android update sdk ``` -1. Select all packages for the Android 19 SDK and any other SDKs that you want to install and click **Install**. +1. Select all packages for the Android 19 SDK and any other SDKs that you want to install, click **Install** and wait for the installation to complete. ## OS X @@ -157,7 +158,7 @@ Path to the platform-tools subdirectory in the Android SDK installation director For example: ``` -export PATH=${PATH}:/ant/apache-ant-1.9.4/bin:/Applications/Android Studio.app/sdk/tools:/Applications/Android Studio.app/sdk/platform-tools +export PATH=${PATH}:/ant/apache-ant-1.9.4/bin:/Applications/Android\ Studio.app/sdk/tools:/Applications/Android\ Studio.app/sdk/platform-tools ``` ## Linux @@ -215,6 +216,12 @@ Windows | `npm install nativescript -g` | `npm install nativescript -g` OS X | `sudo npm install nativescript -g --unsafe-perm` | `npm install nativescript -g` Linux | `sudo npm install nativescript -g --unsafe-perm` | `npm install nativescript -g` +To check if your system is configured properly, run the following command. + +```Shell +tns doctor +``` + ## Configure Proxy Usage If you are working with the NativeScript CLI behind a web proxy, you might need to configure your proxy settings. @@ -484,6 +491,21 @@ tns run ios --emulator [Back to Top][1] +Troubleshooting +=== + +If the NativeScript CLI does not behave as expected, you might be facing a configuration issue. For example, a missing `JAVA` path. To check if your system is configured properly for the NativeScript CLI, run the following command. + +```bash +tns doctor +``` + +This command prints warnings about current configuration issues and provides basic information about how to resolve them. + +If addressing the configuration issues does not resolve your problem, you can [report an issue](CONTRIBUTING.md#report-an-issue) or [post in the NativeScript page in Google Groups](https://groups.google.com/forum/#!forum/nativescript). + +[Back to Top][1] + Known Issues === @@ -494,6 +516,8 @@ Known Issues 1. Provide your authentication credentials for accessing the Internet. 1. Run the terminal and continue working with the NativeScript CLI. +[Back to Top][1] + How to Contribute === @@ -528,4 +552,4 @@ This software is licensed under the Apache 2.0 license, quoted \ No newline at end of file diff --git a/docs/man_pages/general/autocomplete-enable.md b/docs/man_pages/general/autocomplete-enable.md index b168e2f8f0..c9b895af93 100644 --- a/docs/man_pages/general/autocomplete-enable.md +++ b/docs/man_pages/general/autocomplete-enable.md @@ -18,5 +18,5 @@ Command | Description [autocomplete-disable](autocomplete-disable.html) | Disables command-line completion for bash and zsh shells. [feature-usage-tracking](feature-usage-tracking.html) | Configures anonymous usage statistics tracking for the NativeScript command-line interface. [help](help.html) | Lists the available commands or shows information about the selected command. -[doctor](doctor.html) | Checks your system and reports potential problems which may prevent developing with NativeScript. +[doctor](doctor.html) | Checks your system for configuration problems which might prevent the NativeScript CLI from working properly. <% } %> \ No newline at end of file diff --git a/docs/man_pages/general/autocomplete-status.md b/docs/man_pages/general/autocomplete-status.md index 5c1bc142d0..7e98daae87 100644 --- a/docs/man_pages/general/autocomplete-status.md +++ b/docs/man_pages/general/autocomplete-status.md @@ -17,5 +17,5 @@ Command | Description [autocomplete-disable](autocomplete-disable.html) | Disables command-line completion for bash and zsh shells. [feature-usage-tracking](feature-usage-tracking.html) | Configures anonymous usage statistics tracking for the NativeScript command-line interface. [help](help.html) | Lists the available commands or shows information about the selected command. -[doctor](doctor.html) | Checks your system and reports potential problems which may prevent developing with NativeScript. +[doctor](doctor.html) | Checks your system for configuration problems which might prevent the NativeScript CLI from working properly. <% } %> \ No newline at end of file diff --git a/docs/man_pages/general/autocomplete.md b/docs/man_pages/general/autocomplete.md index 1e5e3d571a..335e242467 100644 --- a/docs/man_pages/general/autocomplete.md +++ b/docs/man_pages/general/autocomplete.md @@ -27,5 +27,5 @@ Command | Description [autocomplete-enable](autocomplete-enable.html) | Configures your current command-line completion settings. [autocomplete-disable](autocomplete-disable.html) | Disables command-line completion for bash and zsh shells. [feature-usage-tracking](feature-usage-tracking.html) | Configures anonymous usage statistics tracking for the NativeScript command-line interface. -[doctor](doctor.html) | Checks your system and reports potential problems which may prevent developing with NativeScript. +[doctor](doctor.html) | Checks your system for configuration problems which might prevent the NativeScript CLI from working properly. <% } %> \ No newline at end of file diff --git a/docs/man_pages/general/doctor.md b/docs/man_pages/general/doctor.md index 3b4439acc6..98b9f6321e 100644 --- a/docs/man_pages/general/doctor.md +++ b/docs/man_pages/general/doctor.md @@ -5,8 +5,7 @@ Usage | Synopsis ------|------- General | `$ tns doctor` -Checks your system and reports potential problems which may prevent developing with NativeScript. - +Checks your system for configuration problems which might prevent the NativeScript CLI from working properly. <% if(isHtml) { %> ### Related Commands diff --git a/docs/man_pages/general/feature-usage-tracking-disable.md b/docs/man_pages/general/feature-usage-tracking-disable.md index df66d609e1..1ebd3f9d0e 100644 --- a/docs/man_pages/general/feature-usage-tracking-disable.md +++ b/docs/man_pages/general/feature-usage-tracking-disable.md @@ -18,5 +18,5 @@ Command | Description [autocomplete-status](autocomplete-status.html) | Prints the current status of your command-line completion settings. [autocomplete-enable](autocomplete-enable.html) | Configures your current command-line completion settings. [autocomplete-disable](autocomplete-disable.html) | Disables command-line completion for bash and zsh shells. -[doctor](doctor.html) | Checks your system and reports potential problems which may prevent developing with NativeScript. +[doctor](doctor.html) | Checks your system for configuration problems which might prevent the NativeScript CLI from working properly. <% } %> \ No newline at end of file diff --git a/docs/man_pages/general/feature-usage-tracking-enable.md b/docs/man_pages/general/feature-usage-tracking-enable.md index 6220c59f34..8810cbd9d5 100644 --- a/docs/man_pages/general/feature-usage-tracking-enable.md +++ b/docs/man_pages/general/feature-usage-tracking-enable.md @@ -18,5 +18,5 @@ Command | Description [autocomplete-status](autocomplete-status.html) | Prints the current status of your command-line completion settings. [autocomplete-enable](autocomplete-enable.html) | Configures your current command-line completion settings. [autocomplete-disable](autocomplete-disable.html) | Disables command-line completion for bash and zsh shells. -[doctor](doctor.html) | Checks your system and reports potential problems which may prevent developing with NativeScript. +[doctor](doctor.html) | Checks your system for configuration problems which might prevent the NativeScript CLI from working properly. <% } %> \ No newline at end of file diff --git a/docs/man_pages/general/feature-usage-tracking-status.md b/docs/man_pages/general/feature-usage-tracking-status.md index f5953a7432..221bc98264 100644 --- a/docs/man_pages/general/feature-usage-tracking-status.md +++ b/docs/man_pages/general/feature-usage-tracking-status.md @@ -18,5 +18,5 @@ Command | Description [autocomplete-status](autocomplete-status.html) | Prints the current status of your command-line completion settings. [autocomplete-enable](autocomplete-enable.html) | Configures your current command-line completion settings. [autocomplete-disable](autocomplete-disable.html) | Disables command-line completion for bash and zsh shells. -[doctor](doctor.html) | Checks your system and reports potential problems which may prevent developing with NativeScript. +[doctor](doctor.html) | Checks your system for configuration problems which might prevent the NativeScript CLI from working properly. <% } %> \ No newline at end of file diff --git a/docs/man_pages/general/feature-usage-tracking.md b/docs/man_pages/general/feature-usage-tracking.md index e57892f45a..01e2fd1dce 100644 --- a/docs/man_pages/general/feature-usage-tracking.md +++ b/docs/man_pages/general/feature-usage-tracking.md @@ -27,5 +27,5 @@ Command | Description [autocomplete-status](autocomplete-status.html) | Prints the current status of your command-line completion settings. [autocomplete-enable](autocomplete-enable.html) | Configures your current command-line completion settings. [autocomplete-disable](autocomplete-disable.html) | Disables command-line completion for bash and zsh shells. -[doctor](doctor.html) | Checks your system and reports potential problems which may prevent developing with NativeScript. +[doctor](doctor.html) | Checks your system for configuration problems which might prevent the NativeScript CLI from working properly. <% } %> \ No newline at end of file diff --git a/docs/man_pages/general/help.md b/docs/man_pages/general/help.md index a3e9f748d7..09410348b2 100644 --- a/docs/man_pages/general/help.md +++ b/docs/man_pages/general/help.md @@ -20,5 +20,5 @@ Command | Description ----------|---------- [feature-usage-tracking](feature-usage-tracking.html) | Configures anonymous usage statistics tracking for the NativeScript CLI. [autocomplete](autocomplete.html) | Prints your current command-line completion settings. If disabled, prompts you to enable it. -[doctor](doctor.html) | Checks your system and reports potential problems which may prevent developing with NativeScript. +[doctor](doctor.html) | Checks your system for configuration problems which might prevent the NativeScript CLI from working properly. <% } %> \ No newline at end of file diff --git a/docs/man_pages/index.md b/docs/man_pages/index.md index 3cbf625ba6..98612cc82e 100644 --- a/docs/man_pages/index.md +++ b/docs/man_pages/index.md @@ -12,6 +12,7 @@ Command | Description [help ``](general/help.html) | Shows additional information about the commands in this list in the browser. [autocomplete](general/autocomplete.html) | Configures your current command-line completion settings. [feature-usage-tracking](general/feature-usage-tracking.html) | Configures anonymous feature usage tracking. +[doctor](doctor.html) | Checks your system for configuration problems which might prevent the NativeScript CLI from working properly. ## Project Development Commands Command | Description