diff --git a/docs/man_pages/cloud/cloud-setup.md b/docs/man_pages/cloud/cloud-setup.md index 8534762698..36c307e157 100644 --- a/docs/man_pages/cloud/cloud-setup.md +++ b/docs/man_pages/cloud/cloud-setup.md @@ -2,15 +2,19 @@ title: tns cloud setup position: 5 ---<% } %> + # tns cloud setup +### Description + +Install the `nativescript-cloud extension` to configure your environment for cloud builds. + +### Commands Usage | Synopsis ------|------- Install the `nativescript-cloud extension` | `$ tns cloud setup` -Install the `nativescript-cloud extension` to configure your environment for cloud builds. - ### Related Commands Command | Description diff --git a/docs/man_pages/device/device-android.md b/docs/man_pages/device/device-android.md index 0ea424e8be..0499ec1103 100644 --- a/docs/man_pages/device/device-android.md +++ b/docs/man_pages/device/device-android.md @@ -2,18 +2,23 @@ title: tns device android position: 1 ---<% } %> + # tns device android +### Description + +Lists all recognized connected Android physical and running virtual devices with serial number and index. <% if(isHtml) { %>If a connected Android device is not shown in the list, make sure that you have installed the required Android USB drivers on your system and that USB debugging is enabled on the device.<% } %> + +### Commands Usage | Synopsis ------|------- General | `$ tns device android [--timeout ]` -Lists all recognized connected Android physical and running virtual devices with serial number and index. <% if(isHtml) { %>If a connected Android device is not shown in the list, make sure that you have installed the required Android USB drivers on your system and that USB debugging is enabled on the device.<% } %> - ### Options + * `--available-devices` - Lists all available emulators for Android. -* `--timeout` - Sets the time in milliseconds for the operation to search for connected devices before completing. If not set, the default value is 4000. <% if(isHtml) { %>The operation will continue to wait and listen for newly connected devices and will list them after the specified time expires. +* `--timeout` - Sets the time in milliseconds for the operation to search for connected devices before completing. If not set, the default value is 4000. <% if(isHtml) { %>The operation will continue to wait and listen for newly connected devices and will list them after the specified time expires. ### Related Commands diff --git a/docs/man_pages/device/device-ios.md b/docs/man_pages/device/device-ios.md index 6f0324e122..bfa846e443 100644 --- a/docs/man_pages/device/device-ios.md +++ b/docs/man_pages/device/device-ios.md @@ -2,19 +2,25 @@ title: tns device ios position: 2 ---<% } %> + # tns device ios +### Description + +Lists all recognized connected iOS devices with serial number and index. + +<% if(isConsole && (isLinux)) { %>WARNING: You can run this command only on Windows and macOS systems. To view the complete help for this command, run `$ tns help device ios`<% } %> + +### Commands Usage | Synopsis ------|------- General | `$ tns device ios [--timeout ]` -Lists all recognized connected iOS devices with serial number and index. - -<% if(isConsole && (isLinux)) { %>WARNING: You can run this command only on Windows and OS X systems. To view the complete help for this command, run `$ tns help device ios`<% } %> - <% if((isConsole && (isWindows || isMacOS)) || isHtml) { %> + ### Options + * `--available-devices` - Lists all available emulators for iOS. * `--timeout` - Sets the time in milliseconds for the operation to search for connected devices before completing. If not set, the default value is 4000. <% } %><% if(isHtml) { %>The operation will continue to wait and listen for newly connected devices and will list them after the specified time expires. diff --git a/docs/man_pages/device/device-list-applications.md b/docs/man_pages/device/device-list-applications.md index 50b27a84a7..1043777301 100644 --- a/docs/man_pages/device/device-list-applications.md +++ b/docs/man_pages/device/device-list-applications.md @@ -2,22 +2,25 @@ title: tns device list-applications position: 3 ---<% } %> + # tns device list-applications +### Description + +Lists the installed applications on all connected Android <% if(isWindows || isMacOS) { %>and iOS <% } %>devices. + +### Commands Usage | Synopsis ------|------- General | `$ tns device list-applications [--device ]` -Lists the installed applications on all connected Android <% if(isWindows || isMacOS) { %>and iOS <% } %>devices. - ### Options -* `--device` - If multiple devices are connected, sets the device for which you want to list all currently installed applications. -### Attributes -* `` is the device index or identifier as listed by run `$ tns device` +* `--device` - If multiple devices are connected, sets the device for which you want to list all currently installed applications. `` is the device index or identifier as listed by the `$ tns device` command. + +<% if(isHtml) { %> -<% if(isHtml) { %> ### Command Limitations * You cannot work with connected iOS devices on Linux systems. diff --git a/docs/man_pages/device/device-log.md b/docs/man_pages/device/device-log.md index 7682681e1c..00f351fed8 100644 --- a/docs/man_pages/device/device-log.md +++ b/docs/man_pages/device/device-log.md @@ -2,22 +2,25 @@ title: tns device log position: 4 ---<% } %> + # tns device log +### Description + +Opens the device log stream for a selected connected Android <% if(isWindows || isMacOS) { %>or iOS <% } %>device. + +### Commands Usage | Synopsis ------|------- General | `$ tns device log [--device ]` -Opens the device log stream for a selected connected Android <% if(isWindows || isMacOS) { %>or iOS <% } %>device. - ### Options -* `--device` - If multiple devices are connected, sets the device for which you want to stream the log in the console. -### Attributes -* `` is the device index or identifier as listed by `$ tns device` +* `--device` - If multiple devices are connected, sets the device for which you want to stream the log in the console. `` is the device index or identifier as listed by the `$ tns device` command. + +<% if(isHtml) { %> -<% if(isHtml) { %> ### Command Limitations * You cannot work with connected iOS devices on Linux systems. diff --git a/docs/man_pages/device/device-run.md b/docs/man_pages/device/device-run.md index 4ba1153f62..668d30c0de 100644 --- a/docs/man_pages/device/device-run.md +++ b/docs/man_pages/device/device-run.md @@ -2,30 +2,36 @@ title: tns device run position: 5 ---<% } %> + # tns device run +### Description + +Runs the selected application on a connected Android <% if(isMacOS) { %>or iOS <% } %>device. + +<% if(isConsole && (isWindows || isLinux)) { %>WARNING: You can work only with connected Android devices.<% } %> + +### Commands Usage | Synopsis ------|------- General | `$ tns device run [--device ]` -Runs the selected application on a connected Android <% if(isMacOS) { %>or iOS <% } %>device. +### Options -<% if(isConsole && (isWindows || isLinux)) { %>WARNING: You can work only with connected Android devices.<% } %> +* `--device` - If multiple devices are connected, sets the device on which you want to run the app. `` is the device index or identifier as listed by the `$ tns device` command. -### Options -* `--device` - If multiple devices are connected, sets the device on which you want to run the app. +### Arguments -### Attributes -* `` is the application identifier as listed by `$ tns device list-applications` -* `` is the device index or identifier as listed by run `$ tns device` +* `` is the application identifier as listed by `$ tns device list-applications`. <% if(isHtml) { %> + ### Prerequisites -Before running your app on an iOS device, verify that your system and app meet the following requirements. -* You are running the NativeScript CLI on an OS X system. -* You have installed Xcode 5 or later. +Before running your app on an iOS device, verify that your system and app meet the following requirements. +* You are running the NativeScript CLI on a macOS system. +* You have installed the latest version of Xcode. * You have built your app with the debug build configuration. Before running your app on an Android device, verify that your app meets the following requirement. @@ -35,7 +41,7 @@ Before running your app on an Android device, verify that your app meets the fol ### Command Limitations * You can run this command on one connected device at a time. -* You can run this command for iOS devices only on OS X systems. +* You can run this command for iOS devices only on macOS systems. ### Related Commands diff --git a/docs/man_pages/device/device.md b/docs/man_pages/device/device.md index 85ba342efd..5840e3e580 100644 --- a/docs/man_pages/device/device.md +++ b/docs/man_pages/device/device.md @@ -2,31 +2,37 @@ title: tns device position: 6 ---<% } %> + # tns device +### Description + +Lists all recognized connected Android <% if(isWindows || isMacOS) { %>or iOS devices <% } %>with serial number and index<% if(isWindows || isMacOS) { %>, grouped by platform<% } %>. + +### Commands Usage | Synopsis ------|--------- General | `$ tns device []` -Lists all recognized connected Android <% if(isWindows || isMacOS) { %>or iOS devices <% } %>with serial number and index<% if(isWindows || isMacOS) { %>, grouped by platform<% } %>. +### Arguments -### Attributes -`` extends the `device` command. You can set the following values for this attribute. +`` extends the `device` command. You can set the following values for this argument: * `android` - Lists all recognized connected Android physical and running Android virtual devices. -<% if(isWindows || isMacOS) { %>* `ios` - Lists all recognized connected iOS devices. <% } %> +<% if(isWindows || isMacOS) { %>* `ios` - Lists all recognized connected iOS devices. <% } %> * `log` - Opens the device log stream for a selected connected device. * `list-applications` - Lists the installed applications on all connected Android <% if(isWindows || isMacOS) { %>or iOS <%}%>devices. * `run` - Runs the selected application on a connected Android <% if(isMacOS) { %>or iOS <%}%>device. -<% if(isHtml) { %> +<% if(isHtml) { %> + ### Command Limitations -* You can run `$ tns device ios` on Windows and OS X systems. +* You can run `$ tns device ios` on Windows and macOS systems. ### Aliases -* You can use `$ tns devices` as an alias for `$ tns device`. +* You can use `$ tns devices` as an alias for `$ tns device`. ### Related Commands diff --git a/docs/man_pages/env-configuration/setup.md b/docs/man_pages/env-configuration/setup.md index 303aeb3f61..e90491e197 100644 --- a/docs/man_pages/env-configuration/setup.md +++ b/docs/man_pages/env-configuration/setup.md @@ -2,15 +2,19 @@ title: tns setup position: 5 ---<% } %> + # tns setup +### Description + +Run the setup script to automatically install the NativeScript dependencies and configure your environment for local builds. + +### Commands Usage | Synopsis ------|------- Run the setup script | `$ tns setup` -Run the setup script to try to automatically configure your environment for local builds. - ### Related Commands Command | Description diff --git a/docs/man_pages/general/autocomplete-disable.md b/docs/man_pages/general/autocomplete-disable.md index a0eec0eb60..c29b8221ff 100644 --- a/docs/man_pages/general/autocomplete-disable.md +++ b/docs/man_pages/general/autocomplete-disable.md @@ -2,17 +2,23 @@ title: tns autocomplete disable position: 1 ---<% } %> + # tns autocomplete disable +### Description + +Disables command-line completion for bash and zsh shells. You need to restart the shell to complete the operation. + +<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files. + +### Commands Usage | Synopsis ------|------- General | `$ tns autocomplete disable` -Disables command-line completion for bash and zsh shells. You need to restart the shell to complete the operation. - -<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files. <% if(isHtml) { %> + ### Related Commands Command | Description diff --git a/docs/man_pages/general/autocomplete-enable.md b/docs/man_pages/general/autocomplete-enable.md index e604ef6c54..93df378028 100644 --- a/docs/man_pages/general/autocomplete-enable.md +++ b/docs/man_pages/general/autocomplete-enable.md @@ -2,17 +2,23 @@ title: tns autocomplete enable position: 2 ---<% } %> + # tns autocomplete enable +### Description + +Enables command-line completion for bash and zsh shells. You need to restart the shell to complete the operation. + +<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files. + +### Commands Usage | Synopsis ------|------- General | `$ tns autocomplete enable` -Enables command-line completion for bash and zsh shells. You need to restart the shell to complete the operation. - -<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files. <% if(isHtml) { %> + ### Related Commands Command | Description diff --git a/docs/man_pages/general/autocomplete-status.md b/docs/man_pages/general/autocomplete-status.md index 8489319322..46e3ccc1e6 100644 --- a/docs/man_pages/general/autocomplete-status.md +++ b/docs/man_pages/general/autocomplete-status.md @@ -2,16 +2,21 @@ title: tns autocomplete status position: 3 ---<% } %> + # tns autocomplete status +### Description + +Prints your current command-line completion settings. + +### Commands Usage | Synopsis ------|------- General | `$ tns autocomplete status` -Prints your current command-line completion settings. - <% if(isHtml) { %> + ### Related Commands Command | Description diff --git a/docs/man_pages/general/autocomplete.md b/docs/man_pages/general/autocomplete.md index 7973370f82..49c164411a 100644 --- a/docs/man_pages/general/autocomplete.md +++ b/docs/man_pages/general/autocomplete.md @@ -2,8 +2,16 @@ title: tns autocomplete position: 4 ---<% } %> + # tns autocomplete +### Description + +Prints your current command-line completion settings. If disabled, prompts you to enable it. + +<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files. + +### Commands Usage | Synopsis ------|------- @@ -12,17 +20,15 @@ Get settings | `$ tns autocomplete status` Enable | `$ tns autocomplete enable` Disable | `$ tns autocomplete disable` -Prints your current command-line completion settings. If disabled, prompts you to enable it. +### Arguments -<% if(isHtml) { %>> <% } %>NOTE: This operation might modify the `.bash_profile`, `.bashrc` and `.zshrc` files. - -### Attributes `` extends the `autocomplete` command. You can set the following values for this attribute. * `status` - Prints your current command-line completion settings. * `enable` - Enables command-line completion. You need to restart the shell to complete the operation. * `disable` - Disables command-line completion. You need to restart the shell to complete the operation. <% if(isHtml) { %> + ### Related Commands Command | Description diff --git a/docs/man_pages/general/doctor.md b/docs/man_pages/general/doctor.md index bdf9de9d64..9cbd693e9c 100644 --- a/docs/man_pages/general/doctor.md +++ b/docs/man_pages/general/doctor.md @@ -2,16 +2,21 @@ title: tns doctor position: 5 ---<% } %> + # tns doctor +### Description + +Checks your system for configuration problems which might prevent the NativeScript CLI from working properly. + +### Commands Usage | Synopsis ------|------- General | `$ tns doctor` -Checks your system for configuration problems which might prevent the NativeScript CLI from working properly. - <% if(isHtml) { %> + ### Related Commands Command | Description diff --git a/docs/man_pages/general/error-reporting.md b/docs/man_pages/general/error-reporting.md index 54bfb67be8..76465a62b5 100644 --- a/docs/man_pages/general/error-reporting.md +++ b/docs/man_pages/general/error-reporting.md @@ -2,24 +2,28 @@ title: tns error-reporting position: 6 ---<% } %> + # tns error-reporting +### Description + +Configures anonymous error reporting for the NativeScript CLI. All data gathered is used strictly for improving the product and will never be used to identify or contact you. + +### Commands Usage | Synopsis ------|------- General | `$ tns error-reporting []` -Configures anonymous error reporting for the NativeScript CLI. +### Arguments -All data gathered is used strictly for improving the product and will never be used to identify or contact you. - -### Attributes `` extends the `error-reporting` command. You can set the following values for this attribute. * `status` - Shows the current configuration for anonymous error reporting for the NativeScript CLI. * `enable` - Enables anonymous error reporting. * `disable` - Disables anonymous error reporting. <% if(isHtml) { %> + ### Related Commands Command | Description diff --git a/docs/man_pages/general/extension-install.md b/docs/man_pages/general/extension-install.md index 5e8622c111..38493adac0 100644 --- a/docs/man_pages/general/extension-install.md +++ b/docs/man_pages/general/extension-install.md @@ -2,18 +2,22 @@ title: tns extension install position: 7 ---<% } %> + # tns extension install +### Description + +Installs specified extension. Each extension adds additional functionality that's accessible directly from NativeScript CLI. + +### Commands Usage | Synopsis ------|------- General | `$ tns extension install ` -Installs specified extension. Each extension adds additional functionality that's accessible directly from NativeScript CLI. - -### Attributes +### Arguments -* `` is any of the following. +* `` can be any of the following. * A `` or `@` where `` is the name of a package that is published in the npm registry and `` is a valid version of this plugin. * A `` to the directory which contains the extension, including its `package.json` file. * A `` to a `.tar.gz` archive containing a directory with the extension and its `package.json` file. @@ -21,6 +25,7 @@ Installs specified extension. Each extension adds additional functionality that' * A `` which resolves to a `.tar.gz` archive containing a directory with the extension and its `package.json` file. <% if(isHtml) { %> + ### Related Commands Command | Description diff --git a/docs/man_pages/general/extension-uninstall.md b/docs/man_pages/general/extension-uninstall.md index 3638ef804e..abfb2d905b 100644 --- a/docs/man_pages/general/extension-uninstall.md +++ b/docs/man_pages/general/extension-uninstall.md @@ -2,20 +2,25 @@ title: tns extension uninstall position: 8 ---<% } %> + # tns extension uninstall +### Description + +Uninstalls the specified extension, after which you will no longer be able to use the functionality added by this extensions to the NativeScript CLI. + +### Commands Usage | Synopsis ------|------- General | `$ tns extension uninstall ` -Uninstalls specified extension. After that you will not be able to use the functionality that this extensions adds to NativeScript CLI. - -### Attributes +### Arguments * `` is the name of the extension as listed in its `package.json` file. <% if(isHtml) { %> + ### Related Commands Command | Description diff --git a/docs/man_pages/general/extension.md b/docs/man_pages/general/extension.md index e5fa9adce0..45eafb32e0 100644 --- a/docs/man_pages/general/extension.md +++ b/docs/man_pages/general/extension.md @@ -2,16 +2,21 @@ title: tns extension position: 9 ---<% } %> + # tns extension +### Description + +Prints information about all installed extensions. + +### Commands Usage | Synopsis ------|------- General | `$ tns extension` -Prints information about all installed extensions. - <% if(isHtml) { %> + ### Related Commands Command | Description diff --git a/docs/man_pages/general/help.md b/docs/man_pages/general/help.md index 7d22ea0c04..e5c9ced413 100644 --- a/docs/man_pages/general/help.md +++ b/docs/man_pages/general/help.md @@ -2,22 +2,28 @@ title: tns help position: 10 ---<% } %> + # tns help +### Description + +Opens the command reference for all commands in your browser or shows information about the selected command in the browser. + +To list all commands available in the console, run `$ tns -h`. +To print information about a selected command in the console, run `$ tns -h`. + +### Commands Usage | Synopsis ------|------- General | `$ tns help []` -Opens the command reference for all commands in your browser or shows information about the selected command in the browser. - -To list all commands available in the console, run `$ tns -h` -To print information about a selected command in the console, run `$ tns -h` +### Arguments -### Attributes * `` is any of the available commands as listed by `$ tns help` or `$ tns -h` <% if(isHtml) { %> + ### Related Commands Command | Description diff --git a/docs/man_pages/general/info.md b/docs/man_pages/general/info.md index 6adc59724d..556a818281 100644 --- a/docs/man_pages/general/info.md +++ b/docs/man_pages/general/info.md @@ -2,16 +2,21 @@ title: tns info position: 11 ---<% } %> + # tns info +### Description + +Displays version information about the NativeScript CLI, core modules, and runtimes. + +### Commands Usage | Synopsis ------|------- General | `$ tns info` -Displays version information about the NativeScript CLI, core modules, and runtimes. - <% if(isHtml) { %> + ### Related Commands Command | Description diff --git a/docs/man_pages/general/proxy-clear.md b/docs/man_pages/general/proxy-clear.md index a01afa0abd..1ee40533ed 100644 --- a/docs/man_pages/general/proxy-clear.md +++ b/docs/man_pages/general/proxy-clear.md @@ -2,16 +2,21 @@ title: tns proxy clear position: 12 ---<% } %> + # tns proxy clear +### Description + +Clears the currently configured proxy settings of the NativeScript CLI. + +### Commands Usage | Synopsis ------|------- General | `$ tns proxy clear` -Clears proxy settings. - <% if(isHtml) { %> + ### Related Commands Command | Description diff --git a/docs/man_pages/general/proxy-set.md b/docs/man_pages/general/proxy-set.md index ad016f5534..ec14d3a1fa 100644 --- a/docs/man_pages/general/proxy-set.md +++ b/docs/man_pages/general/proxy-set.md @@ -2,28 +2,35 @@ title: tns proxy set position: 13 ---<% } %> + # tns proxy set +### Description + +Sets the proxy settings of the NativeScript CLI. + +### Commands Usage | Synopsis ------|------- General | `$ tns proxy set [ <% if(isWindows) {%>[ []]<%}%>]` -Sets proxy settings. - ### Options + * `--insecure` - Allows insecure SSL connections and transfers to be performed. In case your proxy doesn't have a CA certificate or has an invalid one you need to use this flag. -### Attributes -* `` the full url of the proxy. For example http://127.0.0.1:8888 If you do not provide this when running the command, the NativeScript CLI will prompt you to provide it. +### Arguments + +* `` is the full url of the proxy. For example, http://127.0.0.1:8888. If you do not provide the url when running the command, the NativeScript CLI will prompt you to provide it. <% if(isWindows) {%> -* `` and `` are your credentials for the proxy. These are not necessary, however if you provide a `` you need to provide a `` too. +* `` and `` are your credentials for the proxy. These are not necessary, however, if you provide a `` you need to provide a `` too. <% } %> <% if(isHtml) { %> + ### Command Limitations -* You can set credentials only on Windows Systems. +* You can set credentials only on Windows systems. * Proxy settings for npm and (Android) Gradle need to be set separately. * configuring `npm` proxy - https://docs.npmjs.com/misc/config#https-proxy * (Android) configuring Gradle proxy - set global configuration in the user directory - _/.gradle/gradle.properties_ - https://docs.gradle.org/3.3/userguide/build_environment.html#sec:accessing_the_web_via_a_proxy diff --git a/docs/man_pages/general/proxy.md b/docs/man_pages/general/proxy.md index 6066dd9c0d..c96cde80df 100644 --- a/docs/man_pages/general/proxy.md +++ b/docs/man_pages/general/proxy.md @@ -2,21 +2,26 @@ title: tns proxy position: 14 ---<% } %> + # tns proxy +### Description + +Displays the current proxy settings of the NativeScript CLI. + +### Commands Usage | Synopsis ------|------- General | `$ tns proxy []` -Displays proxy settings. - -### Attributes -`` extends the `proxy` command. You can set the following values for this attribute. +### Arguments +`` extends the `proxy` command. You can set the following values for this attribute: * `set` - Sets proxy settings * `clear` - Clears proxy settings <% if(isHtml) { %> + ### Related Commands Command | Description diff --git a/docs/man_pages/general/update.md b/docs/man_pages/general/update.md index 7053dc2037..c4849220a5 100644 --- a/docs/man_pages/general/update.md +++ b/docs/man_pages/general/update.md @@ -2,21 +2,26 @@ title: tns update position: 15 ---<% } %> -# tns update +# tns update -Usage | Synopsis -------|------- -General | `$ tns update` +### Description Updates the project with the latest versions of iOS/Android runtimes and cross-platform modules. -In order to get the latest development release instead, pass next as argument: +In order to get the latest development release instead, pass `next` as argument: `tns update next` -Also you can also switch to specific version by passing it to the command: -`tns update 3.0.0` +You can also switch to specific version by passing it to the command: +`tns update 5.0.0` + +### Commands + +Usage | Synopsis +------|------- +General | `$ tns update` <% if(isHtml) { %> + ### Related Commands Command | Description diff --git a/docs/man_pages/general/usage-reporting.md b/docs/man_pages/general/usage-reporting.md index beb052cbce..1b11115748 100644 --- a/docs/man_pages/general/usage-reporting.md +++ b/docs/man_pages/general/usage-reporting.md @@ -2,24 +2,28 @@ title: tns usage-reporting position: 16 ---<% } %> + # tns usage-reporting +### Description + +Configures anonymous usage reporting for the NativeScript CLI. All data gathered is used strictly for improving the product and will never be used to identify or contact you. + +### Commands Usage | Synopsis ------|------- General | `$ tns usage-reporting []` -Configures anonymous usage reporting for the NativeScript CLI. +### Arguments -All data gathered is used strictly for improving the product and will never be used to identify or contact you. - -### Attributes `` extends the `usage-reporting` command. You can set the following values for this attribute. * `status` - Shows the current configuration for anonymous usage reporting for the NativeScript CLI. * `enable` - Enables anonymous usage reporting. * `disable` - Disables anonymous usage reporting. <% if(isHtml) { %> + ### Related Commands Command | Description diff --git a/docs/man_pages/lib-management/plugin-add.md b/docs/man_pages/lib-management/plugin-add.md index 66d46144ec..400b8706ee 100644 --- a/docs/man_pages/lib-management/plugin-add.md +++ b/docs/man_pages/lib-management/plugin-add.md @@ -2,18 +2,22 @@ title: tns plugin add position: 1 ---<% } %> + # tns plugin add +### 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 | `$ tns plugin add ` Alias | `$ tns plugin install ` -<% 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).<% } %> - -### Attributes +### Arguments * `` is a valid NativeScript plugin, specified by any of the following. * A `` or `@` where `` is the name of a plugin that is published in the npm registry and `` is a valid version of this plugin. @@ -23,6 +27,7 @@ Alias | `$ tns plugin install ` * A `` 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. diff --git a/docs/man_pages/lib-management/plugin-build.md b/docs/man_pages/lib-management/plugin-build.md index 0caa204d77..0f7a327534 100644 --- a/docs/man_pages/lib-management/plugin-build.md +++ b/docs/man_pages/lib-management/plugin-build.md @@ -2,18 +2,22 @@ title: tns plugin build position: 8 ---<% } %> -# tns plugin build +# tns plugin build -Usage | Synopsis -------|------- -General | `$ tns plugin build` +### Description <% if(isConsole) { %>Attempts to build the plugin's Android-specific project files located in `platforms/android`. Strips and removes `include.gradle` flavor declarations, if any are present. <% } %> <% if(isHtml) { %>Attempts to build the plugin's Android-specific project files located in `platforms/android`. The resulting Android Library (aar), and the generated Android Gradle project used to build the library can be found at `platforms/android`. Also strips and removes `include.gradle` flavor declarations, if any are present. For more information about working with plugins, see [NativeScript Plugins](https://github.com/NativeScript/nativescript-cli/blob/master/PLUGINS.md).<% } %> +### Commands + +Usage | Synopsis +------|------- +General | `$ tns plugin build` <% if(isHtml) { %> + ### Prerequisites * Verify that the command is being executed in the source directory of a plugin - e.g. `nativescript-barcodescanner/src` diff --git a/docs/man_pages/lib-management/plugin-create.md b/docs/man_pages/lib-management/plugin-create.md index dd4e0f11fa..bfa6d6f7ad 100644 --- a/docs/man_pages/lib-management/plugin-create.md +++ b/docs/man_pages/lib-management/plugin-create.md @@ -2,12 +2,10 @@ title: tns plugin create position: 1 ---<% } %> + # tns plugin create -Usage | Synopsis ----|--- -Create from the default plugin seed | `$ tns plugin create [--path ]` -Create from a custom plugin seed | `$ tns plugin create [--path ] --template