NOTE! You are browsing legacy documentation. For latest visit docs.nativescript.org.

NativeScript Core

tns run android

Description

Runs your project on a connected Android device or Android emulator, if configured. This is shorthand for prepare, build and deploy. While your app is running, prints the output from the application in the console and watches for changes in your code. Once a change is detected, it synchronizes the change with all selected devices and restarts/refreshes the application.

When running this command without passing --release flag, the HMR (Hot Module Replacement) is enabled by default. In case you want to disable HMR, you can pass --no-hmr flag. When --release is passed, CLI disables HMR.

Commands

Usage Synopsis
Run on all connected devices and running emulators $ tns run android [--key-store-path <File Path> --key-store-password <Password> --key-store-alias <Name> --key-store-alias-password <Password>] [--release] [--justlaunch] [--env.*]] [--aab]
Run on a selected connected device or running emulator. Will start emulator with specified Device Identifier, if not already running. $ tns run android --device <Device ID> [--key-store-path <File Path> --key-store-password <Password> --key-store-alias <Name> --key-store-alias-password <Password>] [--release] [--justlaunch] [--env.*]] [--aab]
Start a default emulator if none are running, or run application on all connected emulators. $ tns run android --emulator [--key-store-path <File Path> --key-store-password <Password> --key-store-alias <Name> --key-store-alias-password <Password>] [--release] [--justlaunch] [--env.*]] [--aab]

Options

  • --device - Specifies a connected device or emulator to start and run the app. <Device ID> is the index or Device Identifier of the target device as listed by the $ tns device android --available-devices command.
  • --emulator - If set, runs the app in all available and configured Android emulators. It will start an emulator if none are already running.
  • --justlaunch - If set, does not print the application output in the console.
  • --clean - If set, forces the complete rebuild of the native application.
  • --no-watch - If set, changes in your code will not be reflected during the execution of this command.
  • --release - If set, produces a release build by running webpack in production mode and native build in release mode. Otherwise, produces a debug build. When set, you must also specify the --key-store-* options.
  • --key-store-path - Specifies the file path to the keystore file (P12) which you want to use to code sign your APK. You can use the --key-store-* options along with --release to produce a signed release build. You need to specify all --key-store-* options.
  • --key-store-password - Provides the password for the keystore file specified with --key-store-path. You can use the --key-store-* options along with --release to produce a signed release build. You need to specify all --key-store-* options.
  • --key-store-alias - Provides the alias for the keystore file specified with --key-store-path. You can use the --key-store-* options along with --release to produce a signed release build. You need to specify all --key-store-* options.
  • --key-store-alias-password - Provides the password for the alias specified with --key-store-alias-password. You can use the --key-store-* options along with --release to produce a signed release build. You need to specify all --key-store-* options.
  • --no-hmr - Disables Hot Module Replacement (HMR). In this case, when a change in the code is applied, CLI will transfer the modified files and restart the application.
  • --env.* - Specifies additional flags that the bundler may process. Can be passed multiple times.
    • --env.aot - creates Ahead-Of-Time build (Angular only).
    • --env.snapshot- creates a V8 Snapshot decreasing the app start time (only for release builds for Android).
    • --env.compileSnapshot- compiles the static assets produced by --env.snapshot into .so files allowing the native build to split them per architecture. This will reduce the app size when using the --aab option.
    • --env.uglify - provides basic obfuscation and smaller app size.
    • --env.report - creates a Webpack report inside a report folder in the root folder.
    • --env.sourceMap - creates inline source maps.
    • --env.hiddenSourceMap - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
  • --aab - Specifies that the command will produce and deploy an Android App Bundle.
  • --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 tns migrate.

Prerequisites

Before running your app in the Android emulator from the Android SDK, verify that your system meets the following requirements.

  • Verify that you have installed the Android SDK.
  • Verify that you have added the following Android SDK directories to the PATH environment variable:
    • platform-tools
    • tools

Command Limitations

  • You cannot use the --device and --emulator options simultaneously.
  • When the --release flag is set, you must also specify all --key-store-* options.
Command Description
build android Builds the project for Android and produces an APK that you can manually deploy on device or in the native emulator.
build ios 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 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 Debugs your project on a connected Android device or in a native emulator.
debug ios Debugs your project on a connected iOS device or in a native emulator.
debug Debugs your project on a connected device or in a native emulator.
deploy Builds and deploys the project to a connected physical or virtual device.
run ios Runs your project on a connected iOS device or in the iOS Simulator, if configured.
run Runs your project on a connected device or in the native emulator for the selected platform.
test init Configures your project for unit testing with a selected framework.
test android Runs the tests in your project on Android devices or native emulators.
test ios Runs the tests in your project on iOS devices or the iOS Simulator.
Ask the community