diff --git a/docs/man_pages/index.md b/docs/man_pages/index.md index 50d4c7b827..3cbf625ba6 100644 --- a/docs/man_pages/index.md +++ b/docs/man_pages/index.md @@ -28,7 +28,8 @@ Command | Description [emulate ``](project/testing/emulate.html) | Deploys the project in the native emulator for the selected target platform. [run ``](project/testing/run.html) | Runs your project on a connected device or in the native emulator, if configured. [debug ``](project/testing/debug.html) | Debugs your project on a connected device. -[plugin](plugin.html) | Lists all installed plugins for your project or lets you manage the plugins for your project. +[install](project/configuration/install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory. +[plugin](lib-management/plugin.html) | Lets you manage the plugins for your project. ## Device Commands Command | Description diff --git a/docs/man_pages/project/configuration/install.md b/docs/man_pages/project/configuration/install.md new file mode 100644 index 0000000000..71adca50ee --- /dev/null +++ b/docs/man_pages/project/configuration/install.md @@ -0,0 +1,27 @@ +install +========== + +Usage | Synopsis +---|--- +General | `$ tns install [--path]` + +Installs all platforms and dependencies described in the `package.json` file in the current directory. + +<% if(isHtml) { %> +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. +<% } %> + +### Options +* `--path` - Specifies the directory where you want to create the project, if different from the current directory. The directory must be empty. + +<% if(isHtml) { %> +### Related Commands + +Command | Description +----------|---------- +[platform add](platform-add.html) | Configures the current project to target the selected platform. +[platform remove](platform-remove.html) | Removes the selected platform from the platforms that the project currently targets. +[platform update](platform-update.html) | Updates the NativeScript runtime for the specified platform. +[platform](platform.html) | Lists all platforms that the project currently targets. +[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. +<% } %> \ No newline at end of file diff --git a/docs/man_pages/project/configuration/platform-add.md b/docs/man_pages/project/configuration/platform-add.md index 6f728cc8c6..45cc27b025 100644 --- a/docs/man_pages/project/configuration/platform-add.md +++ b/docs/man_pages/project/configuration/platform-add.md @@ -31,6 +31,7 @@ To list only experimental versions for ios, run `$ npm view tns-ios dist-tags` Command | Description ----------|---------- +[install](install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory. [platform remove](platform-remove.html) | Removes the selected platform from the platforms that the project currently targets. [platform update](platform-update.html) | Updates the NativeScript runtime for the specified platform. [platform](platform.html) | Lists all platforms that the project currently targets. diff --git a/docs/man_pages/project/configuration/platform-remove.md b/docs/man_pages/project/configuration/platform-remove.md index 99d9a6b4a3..021f43e612 100644 --- a/docs/man_pages/project/configuration/platform-remove.md +++ b/docs/man_pages/project/configuration/platform-remove.md @@ -24,6 +24,7 @@ Removes the selected platform from the platforms that the project currently targ Command | Description ----------|---------- +[install](install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory. [platform add](platform-add.html) | Configures the current project to target the selected platform. [platform update](platform-update.html) | Updates the NativeScript runtime for the specified platform. [platform](platform.html) | Lists all platforms that the project currently targets. diff --git a/docs/man_pages/project/configuration/platform-update.md b/docs/man_pages/project/configuration/platform-update.md index ef43d2c102..79381aca70 100644 --- a/docs/man_pages/project/configuration/platform-update.md +++ b/docs/man_pages/project/configuration/platform-update.md @@ -29,6 +29,7 @@ To list only experimental versions for ios, run `$ npm view tns-ios dist-tags` Command | Description ----------|---------- +[install](install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory. [platform add](platform-add.html) | Configures the current project to target the selected platform. [platform remove](platform-remove.html) | Removes the selected platform from the platforms that the project currently targets. [platform](platform.html) | Lists all platforms that the project currently targets. diff --git a/docs/man_pages/project/configuration/platform.md b/docs/man_pages/project/configuration/platform.md index ddb6d4730d..0412312f95 100644 --- a/docs/man_pages/project/configuration/platform.md +++ b/docs/man_pages/project/configuration/platform.md @@ -12,6 +12,7 @@ Lists all platforms that the project currently targets. You can build and deploy Command | Description ----------|---------- +[install](install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory. [platform add](platform-add.html) | Configures the current project to target the selected platform. [platform remove](platform-remove.html) | Removes the selected platform from the platforms that the project currently targets. [platform update](platform-update.html) | Updates the NativeScript runtime for the specified platform. diff --git a/docs/man_pages/project/configuration/prepare.md b/docs/man_pages/project/configuration/prepare.md index bfca2d296c..ad076725d1 100644 --- a/docs/man_pages/project/configuration/prepare.md +++ b/docs/man_pages/project/configuration/prepare.md @@ -23,6 +23,7 @@ in the `platforms` directory. This lets you build the project with the SDK for t Command | Description ----------|---------- +[install](install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory. [platform add](platform-add.html) | Configures the current project to target the selected platform. [platform remove](platform-remove.html) | Removes the selected platform from the platforms that the project currently targets. [platform update](platform-update.html) | Updates the NativeScript runtime for the specified platform.