@akylas/nativescript-cli 8.7.2

package/docs/man_pages/project/testing/typings.md

@@ -0,0 +1,52 @@
+<% if (isJekyll) { %>---
+title: ns typings
+position: 25
+---<% } %>
+
+# ns typings
+
+### Description
+
+Generate iOS & Android typings by default (respecting platform support, so no ios typings generated on windows/linux machines)
+
+### Commands
+
+Usage | Synopsis
+---|---
+Generate typings to Android | `$ ns typings android [--jar <Jar1> --jar <Jar2>] [--aar <Aar1>] [--copy-to <Path>]`
+Generate typings to iOS | `$ ns typings ios [--filter <Filter>] [--copy-to <Path>]`
+
+### Options
+
+* `--jar` - Path to jar file to generate typings for (Supports multiple by passing them individually) (Android only)
+* `--aar` - Path to aar file to generate typings for (Currently unsupported) (Android only)
+* `--filter` - Regex to filter typings (Currently unsupported) (iOS only)
+
+* `--copy-to` - Copy generated typings to the specified folder
+
+<% if((isConsole && isMacOS) || isHtml) { %>### Arguments
+`<Platform>` is the target mobile platform for which you want to generate typings. You can set the following target platforms:
+ * `android` - Generate typings for android.
+ * `ios` - Generate typings for iOS.
+
+
+
+### Related Commands
+
+Command | Description
+----------|----------
+[appstore](../../publishing/appstore.html) | Lists applications registered in iTunes Connect.
+[appstore upload](../../publishing/appstore-upload.html) | Uploads project to iTunes Connect.
+[build android](build-android.html) | Builds the project for Android and produces an APK that you can manually deploy on device or in the native emulator.
+[build ios](build-ios.html) | Builds the project for iOS and produces an APP or IPA that you can manually deploy in the iOS Simulator or on device, respectively.
+[build](build.html) | Builds the project for the selected target platform and produces an application package that you can manually deploy on device or in the native emulator.
+[debug android](debug-android.html) | Debugs your project on a connected Android device or in a native emulator.
+[debug ios](debug-ios.html) | Debugs your project on a connected iOS device or in a native emulator.
+[debug](debug.html) | Debugs your project on a connected device or in a native emulator.
+[deploy](deploy.html) | Builds and deploys the project to a connected physical or virtual device.
+[run android](run-android.html) | Runs your project on a connected Android device or in a native Android emulator, if configured.
+[run ios](run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
+[test init](test-init.html) | Configures your project for unit testing with a selected framework.
+[test android](test-android.html) | Runs the tests in your project on Android devices or native emulators.
+[test ios](test-ios.html) | Runs the tests in your project on iOS devices or the iOS Simulator.
+<% } %>

package/docs/man_pages/publishing/apple-login.md

@@ -0,0 +1,35 @@
+<% if (isJekyll) { %>---
+title: ns apple-login
+position: 5
+---<% } %>
+
+# ns apple-login
+
+### Description
+
+Uses the provided Apple credentials to obtain Apple session which can be used when publishing to Apple AppStore.
+
+### Commands
+
+Usage | Synopsis
+---|---
+General | `$ ns apple-login [<Apple ID>] [<Password>]`
+
+### Arguments
+
+* `<Apple ID>` and `<Password>` are your credentials for logging into iTunes Connect.
+
+<% if(isHtml) { %>s
+
+### Related Commands
+
+Command | Description
+----------|----------
+[appstore](appstore.html) | Lists applications registered in iTunes Connect.
+[appstore upload](appstore-upload.html) | Uploads project to iTunes Connect.
+[build](../project/testing/build.html) | Builds the project for the selected target platform and produces an application package that you can manually deploy on device or in the native emulator.
+[build ios](../project/testing/build-ios.html) | Builds the project for iOS and produces an APP or IPA that you can manually deploy in the iOS Simulator or on device, respectively.
+[deploy](../project/testing/deploy.html) | Builds and deploys the project to a connected physical or virtual device.
+[run](../project/testing/run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[run ios](../project/testing/run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
+<% } %>

package/docs/man_pages/publishing/appstore-upload.md

@@ -0,0 +1,52 @@
+<% if (isJekyll) { %>---
+title: ns appstore upload
+position: 1
+---<% } %>
+
+# ns appstore upload
+
+### Description
+
+Uploads project to iTunes Connect. The command either issues a production build and uploads it to iTunes Connect, or uses an already built package to upload.
+The user will be prompted interactively for verification code when two-factor authentication enabled account is used. As on non-interactive console (CI), you will not be prompt for verification code. In this case, you need to generate a login session for your apple's account in advance using `ns apple-login` command. The generated value must be provided via the `--appleSessionBase64` option and is only valid for up to a month. Meaning you'll need to create a new session every month.
+
+<% if(isConsole && (isLinux || isWindows)) { %>WARNING: You can run this command only on macOS systems. To view the complete help for this command, run `$ ns help appstore upload`<% } %>
+<% if((isConsole && isMacOS) || isHtml) { %>
+
+### Commands
+
+Usage | Synopsis
+---|---
+Build and upload package | `$ ns appstore upload [<Apple ID> [<Password> [<Mobile Provisioning Profile Identifier> [<Code Sign Identity>]]]]]`
+Upload package | `$ ns appstore upload [<Apple ID> [<Password>]] --ipa <Ipa File Path>`
+
+### Options
+
+* `--ipa` - If set, will use provided .ipa file instead of building the project.
+* `--appleApplicationSpecificPassword` - Specifies the password for accessing the information you store in iTunes Transporter application.
+* `--appleSessionBase64` - The session that will be used instead of triggering a new login each time NativeScript CLI communicates with Apple's APIs.
+
+### Arguments
+
+* `<Apple ID>` and `<Password>` are your credentials for logging into iTunes Connect.
+* `<Mobile Provisioning Profile Identifier>` the identifier of the mobile provision(e.g. d5d40f61-b303-4fc8-aea3-fbb229a8171c) which will be used for building. This can easily be acquired through the iPhone Configuration Utility.
+* `<Code Sign Identity>` the code sign identity which will be used for building. You can set it to something generic like 'iPhone Distribution' to let the build automatically detect a code sign identity.
+
+<% if(isHtml) { %>
+
+### Command Limitations
+
+* You can run `$ ns appstore upload` only on macOS systems.
+
+### Related Commands
+
+Command | Description
+----------|----------
+[appstore](appstore.html) | Lists applications registered in iTunes Connect.
+[build](../project/testing/build.html) | Builds the project for the selected target platform and produces an application package that you can manually deploy on device or in the native emulator.
+[build ios](../project/testing/build-ios.html) | Builds the project for iOS and produces an APP or IPA that you can manually deploy in the iOS Simulator or on device, respectively.
+[deploy](../project/testing/deploy.html) | Builds and deploys the project to a connected physical or virtual device.
+[run](../project/testing/run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[run ios](../project/testing/run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
+<% } %>
+<% } %>

package/docs/man_pages/publishing/appstore.md

@@ -0,0 +1,42 @@
+<% if (isJekyll) { %>---
+title: ns appstore
+position: 2
+---<% } %>
+
+# ns appstore
+
+### Description
+
+Lists all application records in iTunes Connect. The list contains name, version and bundle ID for each application record.
+
+### Commands
+
+Usage | Synopsis
+---|---
+List applications | `$ ns appstore [<Apple ID> [<Password>]]`
+<% if((isConsole && isMacOS) || isHtml) { %>Upload | `$ ns appstore upload`<% } %>
+
+### Arguments
+
+<% if(isHtml) { %>
+`<Apple ID>` and `<Password>` are your credentials for logging in iTunes Connect. If you do not provide them when running the command, the NativeScript CLI will prompt you to provide them.
+
+### Options
+
+* `--team-id` - Specifies the team id for which Xcode will try to find distribution certificate and provisioning profile when exporting for AppStore submission.
+
+### Command Limitations
+
+* You can run `$ ns appstore upload` only on macOS systems.
+
+### Related Commands
+
+Command | Description
+----------|----------
+[appstore upload](appstore-upload.html) | Uploads project to iTunes Connect.
+[build](../project/testing/build.html) | Builds the project for the selected target platform and produces an application package that you can manually deploy on device or in the native emulator.
+[build ios](../project/testing/build-ios.html) | Builds the project for iOS and produces an APP or IPA that you can manually deploy in the iOS Simulator or on device, respectively.
+[deploy](../project/testing/deploy.html) | Builds and deploys the project to a connected physical or virtual device.
+[run](../project/testing/run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[run ios](../project/testing/run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
+<% } %>

package/docs/man_pages/publishing/publish-ios.md

@@ -0,0 +1,55 @@
+<% if (isJekyll) { %>---
+title: ns publish ios
+position: 3
+---<% } %>
+
+# ns publish ios
+
+### Description
+
+Uploads project to iTunes Connect. The command either issues a production build and uploads it to iTunes Connect, or uses an already built package to upload.
+The user will be prompted interactively for verification code when two-factor authentication enabled account is used. As on non-interactive console (CI), you will not be prompt for verification code. In this case, you need to generate a login session for your apple's account in advance using `ns apple-login` command. The generated value must be provided via the `--appleSessionBase64` option and is only valid for up to a month. Meaning you'll need to create a new session every month.
+
+<% if(isConsole && (isLinux || isWindows)) { %>WARNING: You can run this command only on macOS systems. To view the complete help for this command, run `$ ns help publish ios`<% } %>
+
+### Commands
+
+Usage | Synopsis
+---|---
+Build and upload package | `$ ns publish ios [<Apple ID> [<Password> [<Mobile Provisioning Profile Identifier> [<Code Sign Identity>]]]]]`
+Upload package | `$ ns publish ios [<Apple ID> [<Password>]] --ipa <Ipa File Path>`
+
+<% if((isConsole && isMacOS) || isHtml) { %>
+
+### Options
+
+* `--ipa` - If set, will use provided .ipa file instead of building the project.
+* `--team-id` - Specified the team id for which Xcode will try to find distribution certificate and provisioning profile when exporting for AppStore submission.
+* `--appleApplicationSpecificPassword` - Specifies the password for accessing the information you store in iTunes Transporter application.
+* `--appleSessionBase64` - The session that will be used instead of triggering a new login each time NativeScript CLI communicates with Apple's APIs.
+ 
+### Arguments
+
+* `<Apple ID>` and `<Password>` are your credentials for logging into iTunes Connect.
+* `<Mobile Provisioning Profile Identifier>` the identifier of the mobile provision(e.g. d5d40f61-b303-4fc8-aea3-fbb229a8171c) which will be used for building. This can easily be acquired through the iPhone Configuration Utility.
+* `<Code Sign Identity>` the code sign identity which will be used for building. You can set it to something generic like 'iPhone Distribution' to let the build automatically detect a code sign identity.
+
+<% if(isHtml) { %>
+
+### Command Limitations
+
+* You can run `$ ns publish ios` only on macOS systems.
+
+### Related Commands
+
+Command | Description
+----------|----------
+[appstore](appstore.html) | Lists applications registered in iTunes Connect.
+[appstore upload](appstore-upload.html) | Uploads project to iTunes Connect.
+[build](../project/testing/build.html) | Builds the project for the selected target platform and produces an application package that you can manually deploy on device or in the native emulator.
+[build ios](../project/testing/build-ios.html) | Builds the project for iOS and produces an APP or IPA that you can manually deploy in the iOS Simulator or on device, respectively.
+[deploy](../project/testing/deploy.html) | Builds and deploys the project to a connected physical or virtual device.
+[run](../project/testing/run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[run ios](../project/testing/run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
+<% } %>
+<% } %>

package/docs/man_pages/publishing/publish.md

@@ -0,0 +1,38 @@
+<% if (isJekyll) { %>---
+title: ns publish
+position: 4
+---<% } %>
+
+# ns publish
+
+### Description
+
+Uploads project to an application store.
+
+<% if(isConsole && (isLinux || isWindows)) { %>WARNING: You can run this command only on macOS systems. To view the complete help for this command, run `$ ns help publish ios`<% } %>
+
+### Commands
+
+Usage | Synopsis
+---|---
+General | `$ ns publish ios`
+
+<% if(isHtml) { %>
+
+### Command Limitations
+
+* You can run `$ ns publish` only on macOS systems.
+* Currently, you can use `$ ns publish` only to publish iOS applications.
+
+### Related Commands
+
+Command | Description
+----------|----------
+[appstore](appstore.html) | Lists applications registered in iTunes Connect.
+[appstore upload](appstore-upload.html) | Uploads project to iTunes Connect.
+[build](../project/testing/build.html) | Builds the project for the selected target platform and produces an application package that you can manually deploy on device or in the native emulator.
+[build ios](../project/testing/build-ios.html) | Builds the project for iOS and produces an APP or IPA that you can manually deploy in the iOS Simulator or on device, respectively.
+[deploy](../project/testing/deploy.html) | Builds and deploys the project to a connected physical or virtual device.
+[run](../project/testing/run.html) | Runs your project on a connected device or in the native emulator for the selected platform.
+[run ios](../project/testing/run-ios.html) | Runs your project on a connected iOS device or in the iOS Simulator, if configured.
+<% } %>

package/docs/man_pages/start.md

@@ -0,0 +1,81 @@
+<% if (isJekyll) { %>---
+title: NativeScript CLI
+position: 1
+---<% } %>
+
+# NativeScript CLI
+
+Usage | Synopsis
+------|-------
+General | `$ ns <Command> [Command Parameters] [--command <Options>]`
+Alias | `$ nativescript <Command> [Command Parameters] [--command <Options>]`
+Alias | `$ tns <Command> [Command Parameters] [--command <Options>]`
+
+## General Commands
+
+Command | Description
+-------|----------
+[help `<Command>`](general/help.html) | Shows additional information about the commands in this list in the browser.
+[autocomplete](general/autocomplete.html) | Configures your current command-line completion settings.
+[usage-reporting](general/usage-reporting.html) | Configures anonymous usage reporting for the NativeScript CLI.
+[error-reporting](general/error-reporting.html) | Configures anonymous error reporting for the NativeScript CLI.
+[doctor `<platform>`](general/doctor.html) | Checks your system for configuration problems which might prevent the NativeScript CLI from working properly for the specified platform, if configured.
+[info](general/info.html) | Displays version information about the NativeScript CLI, core modules, and runtimes.
+[proxy](general/proxy.html) | Displays proxy settings.
+[migrate](general/migrate.html) | Migrates the app dependencies to a form compatible with NativeScript 6.0.
+[update](general/update.html) | Updates the project with the latest versions of iOS/Android runtimes and cross-platform modules.
+[package-manager](general/package-manager.html) | Prints the value of the current package manager.
+
+## Project Development Commands
+Command | Description
+---|---
+[create](project/creation/create.html) | Creates a new project for native development with NativeScript.
+[clean](general/clean.html) | Cleans project artifacts.
+[platform add `<Platform>`](project/configuration/platform-add.html) | Configures the current project to target the selected platform.
+[platform list](project/configuration/platform.html) | Lists all platforms that the project currently targets.
+[platform remove `<Platform>`](project/configuration/platform-remove.html) | Removes the selected platform from the platforms that the project currently targets. This operation deletes all platform-specific files and subdirectories from your project.
+[platform update `<Platform>`](project/configuration/platform-update.html) | Updates the NativeScript runtime for the specified platform.
+[resources update](project/configuration/resources/resources-update.html) | Updates the App_Resources/<platform>'s internal folder structure to conform to that of an Android Studio project.
+[resources generate splashes](project/configuration/resources/resources-generate-splashes.html) | Generates all splashscreens for Android and iOS platforms and places the generated images in the correct directories under `App_Resources/<platform>` directory.
+[resources generate icons](project/configuration/resources/resources-generate-icons.html) | Generates all icons for Android and iOS platforms and places the generated images in the correct directories under `App_Resources/<platform>` directory.
+[prepare `<Platform>`](project/configuration/prepare.html) | Copies relevant content from the app directory to the subdirectory for the selected target platform to let you build the project.
+[build `<Platform>`](project/testing/build.html) | Builds the project for the selected target platform and produces an application package or an emulator package.
+[deploy `<Platform>`](project/testing/deploy.html) | Deploys the project to a connected physical or virtual device.
+[typings `<Platform>`](project/testing/typings.html) | Generate iOS & Android typings
+[run](project/testing/run.html) | Runs your project on a connected device or in the native emulator, if configured.
+[run `<Platform>`](project/testing/run.html) | Runs your project on a connected device or in the native emulator for the specified platform, if configured.
+[debug `<Platform>`](project/testing/debug.html) | Debugs your project on a connected physical or virtual device.
+[test init](project/testing/test-init.html) | Configures your project for unit testing with a selected framework.
+[test `<Platform>`](project/testing/test.html) | Runs the unit tests in your project on a connected physical or virtual device.
+[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.
+[open](project/configuration/open.md) | Opens the native project in Xcode/Android Studio.
+
+## Publishing Commands
+Command | Description
+---|---
+[appstore](publishing/appstore.html) | Lists applications registered in iTunes Connect.
+[appstore upload](publishing/appstore-upload.html) | Uploads project to iTunes Connect.
+
+## Device Commands
+Command | Description
+---|---
+[device](device/device.html) | Lists all recognized connected physical or virtual devices.
+[device log](device/device-log.html) | Opens the log stream for the selected device.
+[device run](device/device-run.html) | Runs the selected application on a connected device.
+[device list-applications](device/device-list-applications.html) | Lists the installed applications on all connected devices.
+
+## Environment Configuration Commands
+Command | Description
+---|---
+[setup](env-configuration/setup.html) | Run the setup script to try to automatically configure your environment for local builds.
+[setup cloud](cloud/cloud-setup.html) | Install the `nativescript-cloud extension` to configure your environment for cloud builds.
+
+## Global Options
+Option | Description
+-------|---------
+--help, -h, /? | Prints help about the selected command in the console.
+--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.
+--config | Specifies the name of the Nativescript configuration file to load (relative to the project directory). The default is `nativescript.config.ts` or `nativescript.config.js` (as a fallback).
+--version | Prints the client version.
+--log trace | Prints a detailed diagnostic log for the execution of the current command.