Skip to content

Commit 9616e95

Browse files
committed
Merge pull request #432 from NativeScript/ikoevska/extend-helpmd
Updated the help for the help command as it now opens the browser
2 parents c3e9def + 8d9b2ce commit 9616e95

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -246,9 +246,9 @@ Quick Start
246246

247247
## The Commands
248248

249-
Run `tns help` to list all available commands. Run or `tns <Command> --help` to view more information about a selected command.
249+
Run `tns help` to view all available commands in the browser. Run `tns help <Command>` to view more information about a selected command in the browser.
250250

251-
* `help` lists all available commands.
251+
* `help` opens a new browser window and lists all available commands.
252252
* `create <App Name> [--path <Directory>] [--appid <App ID>] [--copy-from <Directory>]` creates a new project with the specified settings.
253253
* `platform list` lists the current target platforms for your project.
254254
* `platform add <Platform>` adds a new target platform to your project.

docs/man_pages/general/help.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,13 @@ Usage | Synopsis
55
------|-------
66
General | `$ tns help [<Command>]`
77

8-
Lists the available commands or shows information about the selected command.
8+
Opens the command reference for all commands in your browser or shows information about the selected command in the browser.
9+
10+
To list all commands in the console, run `$ tns -h`
11+
To print information about a selected command in the console, run `$ tns <Command> -h`
912

1013
### Attributes
11-
* `<Command>` is any of the available commands as listed by `$ tns help`
14+
* `<Command>` is any of the available commands as listed by `$ tns help` or `$ tns -h`
1215

1316
<% if(isHtml) { %>
1417
### Related Commands

docs/man_pages/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Alias | `$ nativescript <Command> [Command Parameters] [--command <Options>]`
99

1010
Command | Description
1111
-------|----------
12-
[help `<Command>`](general/help.html) | Shows additional information about the commands in this list.
12+
[help `<Command>`](general/help.html) | Shows additional information about the commands in this list in the browser.
1313
[autocomplete](general/autocomplete.html) | Configures your current command-line completion settings.
1414
[feature-usage-tracking](general/feature-usage-tracking.html) | Configures anonymous feature usage tracking.
1515

@@ -40,7 +40,7 @@ Command | Description
4040
## Global Options
4141
Option | Description
4242
-------|---------
43-
--help, -h, /? | Prints help about the current command.
43+
--help, -h, /? | Prints help about the selected command in the console.
4444
--path `<Directory>` | Specifies the directory that contains the project. If not set, the project is searched for in the current directory and all directories above it.
4545
--version | Prints the client version.
4646
--log trace | Prints a detailed diagnostic log for the execution of the current command.

0 commit comments

Comments
 (0)