@akylas/nativescript-cli 8.7.2

package/docs/man_pages/lib-management/plugin-create.md

@@ -0,0 +1,48 @@
+<% if (isJekyll) { %>---
+title: ns plugin create
+position: 1
+---<% } %>
+
+# ns plugin create
+
+### Description
+
+Creates a new project for NativeScript plugin development. The project uses the [NativeScript Plugin Seed](https://github.com/NativeScript/nativescript-plugin-seed) as a base and contains the following directories:
+
+* `src` - source code of the plugin
+* `publish` - shell scripts used to build and pack the plugin source code and publish it in [NPM](https://www.npmjs.com/)
+
+The command will also propose you to setup demo applications and if you accept them, it will create the following additional directories: 
+* `demo` - simple NativeScript application used to test and show plugin features
+* `demo-angular` - simple Angular application used to test and show plugin features
+
+The project is setup for easy commit in Github, which is why the command will ask you for your Github username.
+<% if(isHtml) { %>Before starting to code your first plugin, you can visit the NativeScript documentation page for [building plugins](https://docs.nativescript.org/plugins/building-plugins#step-2-set-up-a-development-workflow) or the [plugin seed repository](https://github.com/NativeScript/nativescript-plugin-seed/blob/master/README.md).<% } %>
+
+### Commands
+
+Usage | Synopsis
+---|---
+Create from the default plugin seed | `$ ns plugin create <Plugin Repository Name> [--path <Directory>]`
+Create from a custom plugin seed | `$ ns plugin create <Plugin Repository Name> [--path <Directory>] --template <Template>`
+
+### Options
+
+* `--path` - Specifies the directory where you want to create the project, if different from the current directory.
+* `--username` - Specifies the Github username, which will be used to build the URLs in the plugin's package.json file.
+* `--pluginName` - Used to set the default file and class names in the plugin source.
+* `--includeTypeScriptDemo` - Specifies if TypeScript demo should be created. Default value is `y` (i.e. `demo` will be created), in case you do not want to create this demo, pass `--includeTypeScriptDemo=n`
+* `--includeAngularDemo` - Specifies if Angular demo should be created. Default value is `y` (i.e. `demo-angular` will be created), in case you do not want to create this demo, pass `--includeAngularDemo=n`
+* `--template` - Specifies the custom seed archive, which you want to use to create your plugin. If `--template` is not set, the NativeScript CLI creates the plugin from the default NativeScript Plugin Seed. `<Template>` can be a URL or a local path to a `.tar.gz` file with the contents of a seed repository.<% if(isHtml) { %> This must be a clone of the [NativeScript Plugin Seed](https://github.com/NativeScript/nativescript-plugin-seed) and must contain a `src` directory with a package.json file and a script at `src/scripts/postclone.js`. After the archive is extracted, the postclone script will be executed with the username (`gitHubUsername`) and plugin name (`pluginName`) parameters given to the `ns plugin create` command prompts. For more information, visit the default plugin seed repository and [examine the source script](https://github.com/NativeScript/nativescript-plugin-seed/blob/master/src/scripts/postclone.js) there. Examples:
+
+  * Using a local file:
+
+    `ns plugin create nativescript-testplugin --template ../seeds/seed1.tar.gz`
+
+  * Using a `.tar.gz` file from a tag called `v4.0` in a Github repository:
+
+    `ns plugin create nativescript-testplugin --template https://github.com/NativeScript/nativescript-plugin-seed/archive/v.4.0.tar.gz`<% } %>
+
+### Arguments
+
+* `<Plugin Repository Name>` is the name of repository where your plugin will reside. A directory with the same name will be created. For example: `nativescript-awesome-list`. If a directory with the name already exists and is not empty, the plugin create command will fail.

package/docs/man_pages/lib-management/plugin-install.md

@@ -0,0 +1,42 @@
+<% if (isJekyll) { %>---
+title: ns plugin install
+position: 3
+---<% } %>
+
+# ns plugin install
+
+### Description
+
+<% if(isConsole) { %>Installs the specified plugin and any packages that it depends on.<% } %>
+<% if(isHtml) { %>Installs the specified plugin and its dependencies in the local `node_modules` folder, adds it to the `dependencies` section in `package.json`, and prepares the plugin for all installed platforms. If you have not configured any platforms for the project, the NativeScript CLI will prepare the plugin when you add a platform. For more information about working with plugins, see [NativeScript Plugins](https://github.com/NativeScript/nativescript-cli/blob/master/PLUGINS.md).<% } %>
+
+### Commands
+
+Usage | Synopsis
+------|-------
+General | `$ ns plugin install <Plugin>`
+Alias | `$ ns plugin add <Plugin>`
+
+### Arguments
+
+* `<Plugin>` is a valid NativeScript plugin, specified by any of the following.
+    * A `<Name>` or `<Name>@<Version>` where `<Name>` is the name of a plugin that is published in the npm registry and `<Version>` is a valid version of this plugin.
+    * A `<Local Path>` to the directory which contains the plugin, including its `package.json` file.
+    * A `<Local Path>` to a `.tar.gz` archive containing a directory with the plugin and its `package.json` file.
+    * A `<URL>` which resolves to a `.tar.gz` archive containing a directory with the plugin and its `package.json` file.
+    * A `<git Remote URL>` which resolves to a `.tar.gz` archive containing a directory with the plugin and its `package.json` file.
+
+<% if(isHtml) { %>
+
+### Prerequisites
+
+* Verify that the plugin that you want to add contains a valid `package.json` file. Valid `package.json` files contain a `nativescript` section.
+
+### Related Commands
+
+Command | Description
+----------|----------
+[plugin](plugin.html) | Lets you manage the plugins for your project.
+[plugin add](plugin-add.html) | Installs the specified plugin and its dependencies.
+[plugin remove](plugin-remove.html) | Uninstalls the specified plugin and its dependencies.
+<% } %>

package/docs/man_pages/lib-management/plugin-remove.md

@@ -0,0 +1,31 @@
+<% if (isJekyll) { %>---
+title: ns plugin remove
+position: 4
+---<% } %>
+
+# ns plugin remove
+
+### Description
+
+<% if(isConsole) { %>Uninstalls a plugin by its name.<% } %>
+<% if(isHtml) { %>Removes the specified plugin and its dependencies from the local `node_modules` folder and the `dependencies` section in `package.json`. This operation does not remove the plugin from the installed platforms and you need to run `$ ns prepare` to finish uninstalling the plugin.<% } %>
+
+### Commands
+
+Usage | Synopsis
+------|-------
+General | `$ ns plugin remove <Plugin>`
+
+### Arguments
+
+* `<Plugin>` is the name of the plugin as listed in its `package.json` file.
+
+<% if(isHtml) { %>
+
+### Related Commands
+
+Command | Description
+----------|----------
+[plugin](plugin.html) | Lets you manage the plugins for your project.
+[plugin add](plugin-add.html) | Installs the specified plugin and its dependencies.
+<% } %>

package/docs/man_pages/lib-management/plugin-update.md

@@ -0,0 +1,41 @@
+<% if (isJekyll) { %>---
+title: ns plugin update
+position: 7
+---<% } %>
+
+# ns plugin update
+
+### Description
+
+<% if(isConsole) { %>Uninstalls and installs the specified plugin(s) and any packages that it depends on.<% } %>
+<% if(isHtml) { %>Uninstalls and installs the specified plugin(s) and its dependencies in the local `node_modules` folder, adds it to the `dependencies` section in `package.json`, and prepares the plugin(s) for all installed platforms. If you have not configured any platforms for the project, the NativeScript CLI will prepare the plugin(s) when you add a platform.<% } %>
+
+### Commands
+
+Usage | Synopsis
+------|-------
+General | `$ ns plugin update <Plugin(s)>`
+
+### Arguments
+
+* `<Plugin(s)>` is a valid NativeScript plugin or list of plugins, specified by any of the following. If not specified the command will use currently installed plugins in the project.
+    * A `<Name>` or `<Name>@<Version>` where `<Name>` is the name of a plugin that is published in the npm registry and `<Version>` is a valid version of this plugin.
+    * A `<Local Path>` to the directory which contains the plugin, including its `package.json` file.
+    * A `<Local Path>` to a `.tar.gz` archive containing a directory with the plugin and its `package.json` file.
+    * A `<URL>` which resolves to a `.tar.gz` archive containing a directory with the plugin and its `package.json` file.
+    * A `<git Remote URL>` which resolves to a `.tar.gz` archive containing a directory with the plugin and its `package.json` file.
+
+<% if(isHtml) { %>
+
+### Prerequisites
+
+* Verify that the plugin that you want to add contains a valid `package.json` file. Valid `package.json` files contain a `nativescript` section.
+
+### Related Commands
+
+Command | Description
+----------|----------
+[plugin](plugin.html) | Lets you manage the plugins for your project.
+[plugin add](plugin-add.html) | Installs the specified plugin and its dependencies.
+[plugin remove](plugin-remove.html) | Uninstalls the specified plugin and its dependencies.
+<% } %>

package/docs/man_pages/lib-management/plugin.md

@@ -0,0 +1,39 @@
+<% if (isJekyll) { %>---
+title: ns plugin
+position: 10
+---<% } %>
+
+# ns plugin
+
+### Description
+
+Lets you manage the plugins for your project.
+
+### Commands
+
+Usage | Synopsis
+---|---
+List plugins | `$ ns plugin`
+Manage plugins | `$ ns plugin <Command>`
+
+### Arguments
+
+`<Command>` extends the `plugin` command. You can set the following values for this argument.
+* `add` - Installs the specified plugin and its dependencies.
+* `remove` - Uninstalls the specified plugin and its dependencies.
+* `update` - Uninstalls and installs the specified plugin(s) and its dependencies.
+* `build` - Builds the Android parts of a NativeScript plugin.
+* `create` - Creates a project for building a new NativeScript plugin.
+
+<% if(isHtml) { %>
+
+### Related Commands
+
+Command | Description
+----------|----------
+[plugin add](plugin-add.html) | Installs the specified plugin and its dependencies.
+[plugin remove](plugin-remove.html) | Uninstalls the specified plugin and its dependencies.
+[plugin update](plugin-update.html) | Updates the specified plugin(s) and its dependencies.
+[plugin build](plugin-build.html) | Builds the Android project of a NativeScript plugin, and updates the `include.gradle`.
+[plugin create](plugin-create.html) | Creates a new project for NativeScript plugin development.
+<% } %>

package/docs/man_pages/project/configuration/generate.md

@@ -0,0 +1,36 @@
+<% if (isJekyll) { %>---
+title: ns generate
+position: 9
+---<% } %>
+
+# ns generate
+
+### Description
+
+Modifies the project by executing a specified schematic to it.
+
+### Commands
+
+Usage | Synopsis
+------|-------
+General | `$ ns generate <Schematic Name> [--collection <Collection>] [option=value]`
+
+### Options
+
+* `--collection` - specifies the node package to be used as schematics collection. If it's not specified, `@nativescript/schematics` will be used.
+
+### Arguments
+
+* `<Schematic Name>` - name of the schematic to be executed. The schematic should be specified in the used collection.
+* `<option=value>` - options for executed schematic.
+
+<% if(isHtml) { %>
+
+### Related Commands
+
+Command | Description
+----------|----------
+[update](update.md) | Updates a NativeScript project to the latest (or specified) version.
+[resources generate icons](resources-generate-icons.md) | Generates icons for Android and iOS.
+[resources generate splashes](resources-generate-splashes.md) | Generates splashscreens for Android and iOS.
+<% } %>

package/docs/man_pages/project/configuration/install.md

@@ -0,0 +1,43 @@
+<% if (isJekyll) { %>---
+title: ns install
+position: 1
+---<% } %>
+
+# ns install
+
+### Description
+
+Installs all dependencies described in a valid `package.json` or installs a selected NativeScript development module as a dev dependency.
+
+<% 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 `$ ns init` in the directory of a NativeScript project.
+<% } %>
+
+### Commands
+
+Usage | Synopsis
+---|---
+Install all dependencies | `$ ns install [--path]`
+Install a selected npm module | `$ ns install <Module>`
+Enable TypeScript support | `$ ns install typescript`
+
+### Options
+
+* `--path` - Specifies the directory which contains the `package.json` file, if different from the current directory.
+
+### Arguments
+
+* `<Module>` - Specifies a NativeScript development module by path to a local directory containing a valid npm module or by name in the npm registry.<% if(isHtml) { %> When a `<Module>` is specified, this command adds the module as a dev dependency in your `package.json`.
+
+> **TIP:** When installing a module from the npm registry, you can specify it by full name or suffix. NativeScript development modules are published in the npm registry with the following name format: `nativescript-dev-<suffix>`.
+
+### 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.
+<% } %>

package/docs/man_pages/project/configuration/open-android.md

@@ -0,0 +1,27 @@
+<% if (isJekyll) { %>---
+title: ns open android
+position: 10
+---<% } %>
+
+# ns open android
+
+### Description
+
+Opens the Android native project from the corresponding `platforms` directory. 
+
+If the native project has not already been generated, the `prepare` command will be issued to generate the project, and the project will then be opened.
+
+### Commands
+
+Usage | Synopsis
+------|-------
+Open the project in Android Studio | `$ ns open android`
+
+<% if(isHtml) { %>
+
+### Related Commands
+
+Command | Description
+----------|----------
+[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.
+<% } %>

package/docs/man_pages/project/configuration/open-ios.md

@@ -0,0 +1,31 @@
+<% if (isJekyll) { %>---
+title: ns open ios
+position: 10
+---<% } %>
+
+# ns open ios
+
+### Description
+
+Opens the iOS native project from the corresponding `platforms` directory. 
+
+If the native project has not already been generated, the `prepare` command will be issued to generate the project, and the project will then be opened.
+
+### Commands
+
+Usage | Synopsis
+------|-------
+Open the project in Xcode | `$ ns open ios`
+
+<% if(isHtml) { %>
+
+### Command Limitations
+
+* You can run `$ ns open ios` only on macOS systems.
+
+### Related Commands
+
+Command | Description
+----------|----------
+[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.
+<% } %>

package/docs/man_pages/project/configuration/open.md

@@ -0,0 +1,36 @@
+<% if (isJekyll) { %>---
+title: ns open
+position: 10
+---<% } %>
+
+# ns open
+
+### Description
+
+Opens the iOS/Android native project from the corresponding `platforms` directory. 
+
+If the native project has not already been generated, the `prepare` command will be issued to generate the project, and the project will then be opened.
+
+### Commands
+
+Usage | Synopsis
+------|-------
+<% if((isConsole && isMacOS) || isHtml) { %>General | `$ ns open <Platform>`<% } %><% if(isConsole && (isLinux || isWindows)) { %>General | `$ ns open android`<% } %>
+
+<% if(isMacOS) { %>### Arguments
+`<Platform>` is the target mobile platform for which you want to open the native project. You can set the following target platforms.
+* `android` - Opens the Android project in Android Studio.
+* `ios` - Opens native iOS project in Xcode.<% } %>
+
+<% if(isHtml) { %>
+
+### Command Limitations
+
+* You can run `$ ns open ios` only on macOS systems.
+
+### Related Commands
+
+Command | Description
+----------|----------
+[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.
+<% } %>

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

@@ -0,0 +1,46 @@
+<% if (isJekyll) { %>---
+title: ns platform add
+position: 2
+---<% } %>
+
+# ns platform add
+
+### Description
+
+Configures the current project to target the selected platform. <% if(isHtml) { %>When you add a target platform, the NativeScript CLI creates a corresponding platform-specific subdirectory under the platforms directory. This platform-specific directory contains the necessary files to let you build your project for the target platform.<% } %>
+
+### Commands
+
+Usage | Synopsis
+------|-------
+Android latest runtime | `$ ns platform add android [--framework-path <File Path>]`
+Android selected runtime | `$ ns platform add android[@<Version>] [--framework-path <File Path>] `
+<% if (isMacOS) { %>iOS latest runtime | `$ ns platform add ios [--framework-path <File Path>]`
+iOS selected runtime | `$ ns platform add ios[@<Version>] [--framework-path <File Path>] `<% } %>
+
+### Options
+
+* `--framework-path` - Sets the path to a NativeScript runtime for the specified platform that you want to use instead of the default runtime. `<File Path>` must point to a valid npm package.
+
+### Arguments
+
+* `<Version>` is any available version of the respective platform runtime published in npm. <% if(isHtml) { %>If `@<Version>` is not specified, the NativeScript CLI installs the latest stable runtime for the selected platform.
+To list all available versions for Android, run `$ npm view @nativescript/android versions`
+To list only experimental versions for Android, run `$ npm view @nativescript/android dist-tags`
+To list all available versions for iOS, run `$ npm view @nativescript/ios versions`
+To list only experimental versions for iOS, run `$ npm view @nativescript/ios dist-tags`
+
+### Command Limitations
+
+* You can run `$ ns platform add ios` only on macOS systems.
+
+### Related Commands
+
+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.
+[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.
+<% } %>

package/docs/man_pages/project/configuration/platform-clean.md

@@ -0,0 +1,41 @@
+<% if (isJekyll) { %>---
+title: ns platform clean
+position: 3
+---<% } %>
+
+# ns platform clean
+
+### Description
+
+Removes and adds the selected platform to the project currently targets. <% if(isMacOS) { %>You must specify the target platform that you want to remove.<% } %>
+
+### Commands
+
+Usage | Synopsis
+------|-------
+<% if((isConsole && isMacOS) || isHtml) { %>General | `$ ns platform clean <Platform>`<% } %>
+<% if(isConsole && (isLinux || isWindows)) { %>General | `$ ns platform clean android`<% } %>
+
+<% if(isMacOS) { %>### Arguments
+`<Platform>` is the target mobile platform that you want to clean in your project. You can set the following target platforms.
+* `android` - Removes configuration changes for Android development.
+* `ios` - Removes configuration changes for iOS development.<% } %>
+
+<% if(isHtml) { %>
+
+### Command Limitations
+
+* You can run `$ ns platform clean ios` only on macOS systems.
+* Clean command will not preserve your current installed platform version but will download and install latest platform version. If you are using clean with custom version of the runtime, specify the version in the command `ns clean ios@2.1.0` or `ns clean ios --frameworkPath <path-to-tgz>`.
+
+### Related Commands
+
+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 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.
+[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.
+<% } %>

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

@@ -0,0 +1,41 @@
+<% if (isJekyll) { %>---
+title: ns platform remove
+position: 4
+---<% } %>
+
+# ns platform remove
+
+### Description
+
+Removes the selected platform from the platforms that the project currently targets. After removing the target platform, you can no longer build and deploy your app on devices which run on the platform. <% if(isMacOS) { %>You must specify the target platform that you want to remove.<% } %>
+
+<% if(isHtml) { %>This operation deletes the subdirectory for the selected platform from the platforms directory. <% } %>
+
+### Commands
+
+Usage | Synopsis
+------|-------
+<% if((isConsole && isMacOS) || isHtml) { %>General | `$ ns platform remove <Platform>`<% } %>
+<% if(isConsole && (isLinux || isWindows)) { %>General | `$ ns platform remove android`<% } %>
+
+<% if(isMacOS) { %>### Arguments
+`<Platform>` is the target mobile platform that you want to remove from your project. You can set the following target platforms.
+* `android` - Removes configuration changes for Android development.
+* `ios` - Removes configuration changes for iOS development.<% } %>
+
+<% if(isHtml) { %>
+
+### Command Limitations
+
+* You can run `$ ns platform remove ios` only on macOS systems.
+
+### Related Commands
+
+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.
+[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.
+<% } %>

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

@@ -0,0 +1,45 @@
+<% if (isJekyll) { %>---
+title: ns platform update
+position: 5
+---<% } %>
+
+# ns platform update
+
+### Description
+
+Updates the NativeScript runtime for the specified platform. <% if(isMacOS) { %>You must specify the target platform that you want to update.<% } %>
+
+### Commands
+
+Usage | Synopsis
+------|-------
+Android latest runtime |`$ ns platform update android`
+Android selected runtime | `$ ns platform update android@<Version>`
+<% if(isMacOS) { %>iOS latest runtime | `$ ns platform update ios`
+iOS selected runtime | `$ ns platform update ios@<Version>` <% } %> 
+
+### Arguments
+
+<% if(isMacOS) { %>* `<Platform>` is the target mobile platform whose runtime you want to update. You can set the following target platforms.
+	* `android` - Updates the Android runtime.
+	* `ios` - Updates the iOS runtime.<% } %>
+* `<Version>` is any available version of the respective platform runtime published in npm. <% if(isHtml) { %>If `@<Version>` is not specified, the NativeScript CLI installs the latest stable runtime for the selected platform.  
+To list all available versions for Android, run `$ npm view @nativescript/android versions`
+To list only experimental versions for Android, run `$ npm view @nativescript/android dist-tags`
+To list all available versions for iOS, run `$ npm view @nativescript/ios versions`
+To list only experimental versions for iOS, run `$ npm view @nativescript/ios dist-tags`
+
+### Command Limitations
+
+* You can run `$ ns platform update ios` only on macOS systems.
+
+### Related Commands
+
+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.
+[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.
+<% } %>

package/docs/man_pages/project/configuration/platform.md

@@ -0,0 +1,29 @@
+<% if (isJekyll) { %>---
+title: ns platform
+position: 6
+---<% } %>
+
+# ns platform
+
+### Description
+
+Lists all platforms that the project currently targets. You can build and deploy your project only for these target platforms.
+
+### Commands
+
+Usage | Synopsis
+---|---
+General | `$ ns platform list`
+
+<% if(isHtml) { %>
+
+### Related Commands
+
+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.
+[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.
+<% } %>

package/docs/man_pages/project/configuration/prepare.md

@@ -0,0 +1,49 @@
+<% if (isJekyll) { %>---
+title: ns prepare
+position: 7
+---<% } %>
+
+# ns prepare
+
+### Description
+
+Starts a Webpack compilation and prepares the app's `App_Resources` and the plugins `platforms` directories. The output is generated in a subdirectory for the selected target platform in the `platforms` directory. This lets you build the project for the selected platform. <% if(isMacOS) { %>You must specify the target platform for which you want to prepare your project.<% } %>
+
+When running this command the HMR (Hot Module Replacement) is not enabled by default. In case you want to enable HMR, you can pass `--hmr` flag.
+
+<% if(isHtml) { %>
+> NOTE: When passing `--release` CLI will disable HMR.
+<% } %>
+
+### Commands
+
+Usage | Synopsis
+------|-------
+<% if((isConsole && isMacOS) || isHtml) { %>General | `$ ns prepare <Platform>`<% } %><% if(isConsole && (isLinux || isWindows)) { %>General | `$ ns prepare android`<% } %>
+
+<% if(isMacOS) { %>### Arguments
+`<Platform>` is the target mobile platform for which you want to prepare your project. You can set the following target platforms.
+* `android` - Prepares your project for an Android build.
+* `ios` - Prepares your project for an iOS build.<% } %>
+
+### Options
+
+* `--hmr` - Enables the hot module replacement (HMR) feature.
+* `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `ns migrate`.
+
+<% if(isHtml) { %>
+
+### Command Limitations
+
+* You can run `$ ns prepare ios` only on macOS systems.
+
+### Related Commands
+
+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.
+[platform](platform.html) | Lists all platforms that the project currently targets.
+<% } %>