Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions specs/nativescript/add_platform.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Configure your current NativeScript project to target the selected platform.
command: "ns platform add {{platform}}"
tags:
- ns
- tns
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @erodriguezh! Thanks so much for your contribution. One thing i'm noticing is that we have duplicated tags for ns, tns, and nativescript here. Would it be possible to consolidate and just have the nativescript tag instead?

- nativescript
description: "Configures the current NativeScript project to target the selected platform. 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."
arguments:
- name: platform
description: The name of the platform. E.g. ios, android, etc.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/project/configuration/platform-add.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/build_the_project.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Build your NativeScript project for Android or iOS.
command: "ns build {{platform}}"
tags:
- ns
- tns
- nativescript
description: "Builds your NativeScript project for Android or iOS and produces an application package that you can manually deploy on a device or native emulator."
arguments:
- name: platform
description: The name of the platform. E.g. ios, android, etc.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/project/testing/build.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/check_nativescript_system_configuration.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Check Nativescript system's configuration.
command: "ns doctor {{platform}}"
tags:
- ns
- tns
- nativescript
description: "Checks your system for configuration problems which might prevent the NativeScript CLI from working properly for the specified platform, if configured."
arguments:
- name: platform
description: The name of the platform. E.g. ios, android, etc.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/general/doctor.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
11 changes: 11 additions & 0 deletions specs/nativescript/clean_project_artifacts.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Clean your NativeScript project artifacts.
command: "ns clean"
tags:
- ns
- tns
- nativescript
description: "Cleans your NativeScript project artifacts."
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/general/clean.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
11 changes: 11 additions & 0 deletions specs/nativescript/configure_error_reporting.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Configure NativeScript CLI error reporting.
command: "ns error-reporting"
tags:
- ns
- tns
- nativescript
description: "Configures anonymous error reporting for the NativeScript CLI."
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/general/error-reporting.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/configure_shell_autocompletion.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Configure NativeScript command-line autocompletion.
command: "ns autocomplete {{command}}"
tags:
- ns
- tns
- nativescript
description: "Prints your current NativeScript command-line completion settings. If disabled, prompts you to enable it."
arguments:
- name: command
description: options are status, enable, disable.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/general/autocomplete.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/configure_unit_testing_framework.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Configures your NativeScript project for unit testing with a selected framework.
command: "ns test init {{framework}}"
tags:
- ns
- tns
- nativescript
description: "Configures your NativeScript project for unit testing with a selected framework. This operation installs the @nativescript/unit-test-runner npm module and its dependencies and creates a tests folder in the app directory."
arguments:
- name: framework
description: The following frameworks are available - mocha, jasmine and qunit.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/project/testing/test-init.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
11 changes: 11 additions & 0 deletions specs/nativescript/configure_usage_reporting.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Configure NativeScript CLI usage reporting.
command: "ns usage-reporting"
tags:
- ns
- tns
- nativescript
description: "Configures anonymous usage reporting for the NativeScript CLI."
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/general/usage-reporting.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/create_nativecript_app.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Create a NativeScript app.
command: "ns create {{app_name}}"
tags:
- ns
- tns
- nativescript
description: "Interactively creates a new NativeScript app based on a predefined template."
arguments:
- name: app_name
description: The name of project and must meet the requirements of each platform that you want to target.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/project/creation/create.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/debug_the_project.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Initiate a debugging session for your NativeScript project.
command: "ns debug {{platform}}"
tags:
- ns
- tns
- nativescript
description: "Initiates a debugging session for your NativeScript project on a connected device or native emulator. The command will prepare, build, deploy and launch the app before starting the debug session."
arguments:
- name: platform
description: The name of the platform. E.g. ios, android, etc.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/project/testing/debug.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/deploy_the_project.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Prepare, build and deploy your NativeScript project to a connected device or native emulator.
command: "ns deploy {{platform}}"
tags:
- ns
- tns
- nativescript
description: "Prepares, builds and deploys your NativeScript project to a connected device or native emulator. It will deploy the app on all connected devices targeting the selected platform."
arguments:
- name: platform
description: The name of the platform. E.g. ios, android, etc.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/project/testing/deploy.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
11 changes: 11 additions & 0 deletions specs/nativescript/display_nativescript_proxy_settings.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Display proxy settings of the NativeScript CLI.
command: "ns proxy"
tags:
- ns
- tns
- nativescript
description: "Displays the current proxy settings of the NativeScript CLI."
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/general/proxy.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Display version information about NativeScript.
command: "ns info"
tags:
- ns
- tns
- nativescript
description: "Displays version information about the NativeScript CLI, core modules, and runtimes."
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/general/info.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/generate_icons_resource.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Generate all icons for Android and iOS platforms for your NativeScript project.
command: "ns resources generate icons {{path_to_image}}"
tags:
- ns
- tns
- nativescript
description: "Generates all icons for Android and iOS platforms for your NativeScript. It places the generated images in the correct directories under App_Resources/<platform> directory."
arguments:
- name: path_to_image
description: It is a valid path to an image that will be used to generate all icons.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/project/configuration/resources/resources-generate-icons.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/generate_platform_typings.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Generate platform's (iOS and/or Android) typings for your NativeScript project.
command: "ns typings {{platform}}"
tags:
- ns
- tns
- nativescript
description: "Generate iOS & Android typings for your NativeScript project. By default respecting platform support, so no iOS typings generated on Windows/Linux machines."
arguments:
- name: platform
description: The name of the platform. E.g. ios, android, etc.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/project/testing/typings.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/generate_splashscreens_resource.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Generate all splashscreens for Android and iOS platforms for your NativeScript project.
command: "ns resources generate splashes {{path_to_image}}"
tags:
- ns
- tns
- nativescript
description: "Generates all splashscreens for Android and iOS platforms for your NativeScript project. It places the generated images in the correct directories under App_Resources/<platform> directory."
arguments:
- name: path_to_image
description: It is a valid path to an image that will be used to generate all splashscreens.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/project/configuration/resources/resources-generate-splashes.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/install_dependencies.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Install dependencies for your NativeScript project.
command: "ns install {{module}}"
tags:
- ns
- tns
- nativescript
description: "Installs all dependencies described in a valid package.json or installs a selected NativeScript development module as a dev dependency."
arguments:
- name: module
description: Specifies a NativeScript development module by path to a local directory containing a valid npm module or by name in the npm registry.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/project/configuration/install.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
11 changes: 11 additions & 0 deletions specs/nativescript/list_applications_installed_on_a_device.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: List applications installed on a device using NativeScript CLI.
command: "ns device list-applications"
tags:
- ns
- tns
- nativescript
description: "NativeScript lists the installed applications on all connected Android and iOS devices."
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/device/device-list-applications.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: List all application records in iTunes Connect using NativeScript CLI.
command: "ns appstore {{apple_id}} {{password}}"
tags:
- ns
- tns
- nativescript
description: "NativeScript lists all application records in iTunes Connect. The list contains name, version and bundle ID for each application record."
arguments:
- name: apple_id
description: iTunes connect id
- name: password
description: Itunes connect password
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/publishing/appstore.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/list_connected_devices.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: List all recognized connected devices using NativeScript CLI.
command: "ns device {{platform}}"
tags:
- ns
- tns
- nativescript
description: "NativeScript lists all recognized connected Android or iOS devices with serial number and index, grouped by platform."
arguments:
- name: platform
description: (Optional) The name of the platform. E.g.. ios, android, etc.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/device/device.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
11 changes: 11 additions & 0 deletions specs/nativescript/list_platforms.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Lists all platforms that your NativeScript project currently targets.
command: "ns platform list"
tags:
- ns
- tns
- nativescript
description: "Lists all platforms that your NativeScript project currently targets. You can build and deploy your project only for these target platforms."
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/project/configuration/platform.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/manage_plugins.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Manage Plugins in your NativeScript project.
command: "ns plugin {{command}}"
tags:
- ns
- tns
- nativescript
description: "Lets you manage the plugins for your NativeScript project."
arguments:
- name: command
description: Extends the plugin command. Options - add, remove, update, build, create
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/lib-management/plugin.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Migrate Nativescript dependencies to the latest version.
command: "ns migrate"
tags:
- ns
- tns
- nativescript
description: "Migrates the app dependencies to a form compatible with the latest NativeScript. Running this command will not affect the codebase of the application and you might need to do additional changes manually."
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/general/migrate.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
11 changes: 11 additions & 0 deletions specs/nativescript/open_device_log_stream.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Open the device log stream using NativeScript CLI.
command: "ns device log"
tags:
- ns
- tns
- nativescript
description: "NativeScript opens the device log stream for a selected connected Android or iOS device."
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/device/device-log.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/prepare_resources_and_platforms.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Prepare the app's App_Resources and the plugins platforms directories in your NativeScript project.
command: "ns prepare {{platform}}"
tags:
- ns
- tns
- nativescript
description: "Starts a Webpack compilation and prepares the app's App_Resources and the plugins platforms directories in your NativeScript project. 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."
arguments:
- name: platform
description: The name of the platform. E.g. ios, android, etc.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/project/configuration/prepare.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/remove_platform.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Remove the selected platform from your NativeScript project.
command: "ns platform remove {{platform}}"
tags:
- ns
- tns
- nativescript
description: "Removes the selected platform from the platforms that your NativeScript project currently targets. After removing the target platform, you can no longer build and deploy your app on devices which run on the platform."
arguments:
- name: platform
description: The name of the platform. E.g. ios, android, etc.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/project/configuration/platform-remove.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/run_project_on_device.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Run the selected NativeScript application on a connected device.
command: "ns run {{application_id}}"
tags:
- ns
- tns
- nativescript
description: "Runs the selected NativeScript application on a connected Android or iOS device."
arguments:
- name: application_id
description: (Optional) It is the application identifier as listed by $ ns device list-applications.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/device/device-run.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
14 changes: 14 additions & 0 deletions specs/nativescript/run_the_project.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Run the NativeScript project for Android or iOS.
command: "ns run {{platform}}"
tags:
- ns
- tns
- nativescript
description: "Runs your NativeScript project on all connected devices or in native emulators for the selected platform. The command will work with all currently running Android devices and emulators. The command will prepare, build and deploy the app when necessary. By default listens for changes in your code, synchronizes those changes and refreshes all selected devices."
arguments:
- name: platform
description: The name of the platform. E.g. ios, android, etc.
source_url: "https://github.com/NativeScript/nativescript-cli/blob/master/docs/man_pages/project/testing/run.md"
author: erodriguezh
author_url: "https://github.com/erodriguezh"
shells: []
Loading