Skip to content

Commit 938a9c5

Browse files
FatmeFatme
Fatme
authored and
Fatme
committed
Merge pull request #596 from NativeScript/fatme/help-for-install-command
Help for install command
2 parents c14e84d + 9239231 commit 938a9c5

File tree

7 files changed

+34
-1
lines changed

7 files changed

+34
-1
lines changed

docs/man_pages/index.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ Command | Description
2828
[emulate `<Platform>`](project/testing/emulate.html) | Deploys the project in the native emulator for the selected target platform.
2929
[run `<Platform>`](project/testing/run.html) | Runs your project on a connected device or in the native emulator, if configured.
3030
[debug `<Platform>`](project/testing/debug.html) | Debugs your project on a connected device.
31-
[plugin](plugin.html) | Lists all installed plugins for your project or lets you manage the plugins for your project.
31+
[install](project/configuration/install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory.
32+
[plugin](lib-management/plugin.html) | Lets you manage the plugins for your project.
3233

3334
## Device Commands
3435
Command | Description
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
install
2+
==========
3+
4+
Usage | Synopsis
5+
---|---
6+
General | `$ tns install [--path]`
7+
8+
Installs all platforms and dependencies described in the `package.json` file in the current directory.
9+
10+
<% if(isHtml) { %>
11+
The `package.json` file must be a valid `package.json` describing the configuration of a NativeScript project. If missing or corrupted, you can recreate the file by running `$ tns init` in the directory of a NativeScript project.
12+
<% } %>
13+
14+
### Options
15+
* `--path` - Specifies the directory where you want to create the project, if different from the current directory. The directory must be empty.
16+
17+
<% if(isHtml) { %>
18+
### Related Commands
19+
20+
Command | Description
21+
----------|----------
22+
[platform add](platform-add.html) | Configures the current project to target the selected platform.
23+
[platform remove](platform-remove.html) | Removes the selected platform from the platforms that the project currently targets.
24+
[platform update](platform-update.html) | Updates the NativeScript runtime for the specified platform.
25+
[platform](platform.html) | Lists all platforms that the project currently targets.
26+
[prepare](prepare.html) | Copies common and relevant platform-specific content from the app directory to the subdirectory for the selected target platform in the platforms directory.
27+
<% } %>

docs/man_pages/project/configuration/platform-add.md

+1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ To list only experimental versions for ios, run `$ npm view tns-ios dist-tags`
3131

3232
Command | Description
3333
----------|----------
34+
[install](install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory.
3435
[platform remove](platform-remove.html) | Removes the selected platform from the platforms that the project currently targets.
3536
[platform update](platform-update.html) | Updates the NativeScript runtime for the specified platform.
3637
[platform](platform.html) | Lists all platforms that the project currently targets.

docs/man_pages/project/configuration/platform-remove.md

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Removes the selected platform from the platforms that the project currently targ
2424

2525
Command | Description
2626
----------|----------
27+
[install](install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory.
2728
[platform add](platform-add.html) | Configures the current project to target the selected platform.
2829
[platform update](platform-update.html) | Updates the NativeScript runtime for the specified platform.
2930
[platform](platform.html) | Lists all platforms that the project currently targets.

docs/man_pages/project/configuration/platform-update.md

+1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ To list only experimental versions for ios, run `$ npm view tns-ios dist-tags`
2929

3030
Command | Description
3131
----------|----------
32+
[install](install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory.
3233
[platform add](platform-add.html) | Configures the current project to target the selected platform.
3334
[platform remove](platform-remove.html) | Removes the selected platform from the platforms that the project currently targets.
3435
[platform](platform.html) | Lists all platforms that the project currently targets.

docs/man_pages/project/configuration/platform.md

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Lists all platforms that the project currently targets. You can build and deploy
1212

1313
Command | Description
1414
----------|----------
15+
[install](install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory.
1516
[platform add](platform-add.html) | Configures the current project to target the selected platform.
1617
[platform remove](platform-remove.html) | Removes the selected platform from the platforms that the project currently targets.
1718
[platform update](platform-update.html) | Updates the NativeScript runtime for the specified platform.

docs/man_pages/project/configuration/prepare.md

+1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ in the `platforms` directory. This lets you build the project with the SDK for t
2323

2424
Command | Description
2525
----------|----------
26+
[install](install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory.
2627
[platform add](platform-add.html) | Configures the current project to target the selected platform.
2728
[platform remove](platform-remove.html) | Removes the selected platform from the platforms that the project currently targets.
2829
[platform update](platform-update.html) | Updates the NativeScript runtime for the specified platform.

0 commit comments

Comments
 (0)