Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

native-run

ionic-team1.6mMIT2.0.1

A CLI for running apps on iOS/Android devices and simulators/emulators

android, ios, cli, mobile, app, hybrid, native

readme

github-actions semantic-release npm

native-run

native-run is a cross-platform command-line utility for running native app binaries (.ipa and .apk files) on iOS and Android devices. It can be used for both hardware and virtual devices.

This tool is used by the Ionic CLI, but it can be used standalone as part of a development or testing pipeline for launching apps. It doesn't matter whether the .apk or .ipa is created with Cordova or native IDEs, native-run will be able to deploy it.

Install

native-run is written entirely in TypeScript/NodeJS, so there are no native dependencies.

To install, run:

npm install -g native-run

:memo: Requires NodeJS 16+

Usage

native-run <platform> [options]

See the help documentation with the --help flag.

native-run --help
native-run ios --help
native-run android --help

Troubleshooting

Much more information can be printed to the screen with the --verbose flag.

changelog

2.0.1 (2024-01-25)

Bug Fixes

  • paths contain non-ascii characters cause error (#381) (77b0481)

2.0.0 (2023-10-26)

Bug Fixes

  • chore!: support only node 16+ (#354) (eb20983), closes #354
  • feat(android)!: Remove AVD creation on list (#349) (2a310ff), closes #349

BREAKING CHANGES

  • drop node 10-14 support
  • removal of AVD creation feature

1.7.4 (2023-10-24)

Bug Fixes

1.7.3 (2023-09-21)

Bug Fixes

  • Pin @types/babel__traverse version to fix build (#342) (8492b24)
  • use devicectl for iOS 17 if Xcode 15 is available (#341) (5c56d71)

1.7.2 (2023-03-02)

Bug Fixes

1.7.1 (2022-09-23)

Bug Fixes

  • android: Use arm64 architecture on emulator creation from M1 (#258) (a6501c4)

1.7.0 (2022-09-01)

Features

1.6.0 (2022-05-16)

Features

1.5.0 (2021-10-11)

Bug Fixes

Features

1.4.1 (2021-09-03)

Bug Fixes

  • throw iOS errors that are not DeviceLocked (#200) (3ac6914)

1.4.0 (2021-06-08)

Features

1.3.1 (2021-06-04)

Bug Fixes

  • don't print retry message for --json (#184) (4fb0563)

1.3.0 (2020-12-07)

Features

  • iOS: Add 5 second retry on DeviceLocked for iOS (#167) (f451e46)

1.2.2 (2020-10-16)

Bug Fixes

  • android: don't print ADB unresponsive error to stdout (#163) (2cd894b)

1.2.1 (2020-09-29)

Bug Fixes

1.2.0 (2020-09-28)

Bug Fixes

Features

  • android: gracefully handle when device is offline (aa6688d)
  • android: gracefully handle when device is out of space (9da9f59)
  • android: handle INSTALL_FAILED_INSUFFICIENT_STORAGE adb error (bcf2369)
  • android: kill unresponsive adb server after 5s and retry (9e1bbc7)
  • list: show model, then ID if no name (d56415d)
  • columnize --list output (5b7da72)

1.1.0 (2020-09-10)

Bug Fixes

  • ios: do not falsely link to Android Wiki for iOS errors (18371f2)

Features

  • android: create AVD home if not found (1cec3c2)

1.0.0 (2020-04-02)

chore

Features

  • android: handle adb error re: improper signing (829585f)
  • android: show link to online help docs for errors (0bc4487)

BREAKING CHANGES

  • A minimum of Node.js 10.3.0 is required.

0.3.0 (2019-12-04)

Features

  • android: handle INSTALL_FAILED_OLDER_SDK adb error (#92) (6616f37)
  • android: support API 29 (2282b3a)

0.2.9 (2019-10-15)

Bug Fixes

  • ios: added support for iOS 13 (c27675f)

0.2.8 (2019-07-12)

Bug Fixes

  • list: include errors in standard output (9ceb343)

0.2.7 (2019-06-25)

Bug Fixes

  • android: more accurate device/emulator detection (5ec454b)
  • list: handle errors with devices/virtual devices (9c2375d)

0.2.6 (2019-06-17)

Bug Fixes

  • ios: support old simctl runtime output format (aa73578)

0.2.5 (2019-06-10)

Bug Fixes

  • android: fix path issue for windows (9b87583)

0.2.4 (2019-06-07)

Bug Fixes

  • android: log errors during sdk walk, don't throw (ea2e0c5)

0.2.3 (2019-06-05)

Bug Fixes

  • ios: fix getSimulators for Xcode 10+ tooling (605164a)
  • ios: improve getSimulators error messaging (86205d6)

0.2.2 (2019-05-31)

Bug Fixes

  • android: handle devices connected over tcp/ip (4869f4a)

0.2.1 (2019-05-30)

Bug Fixes

  • android: handle \r\n for adb output on Windows during --list (50bfa73)

0.2.0 (2019-05-30)

Bug Fixes

  • ios: log iOS --list errors, but still print (e516a83)
  • ios: print more helpful error if app path doesn't exist (49819b0)

Features

  • android: better error messaging (0cfa51a)
  • android: have --forward accept multiple values (#26) (7844ea4)

0.1.2 (2019-05-29)

Bug Fixes

  • android: catch api issues for --list (9453f2c)

0.1.1 (2019-05-29)

Bug Fixes

  • list: add heading for each platform (203d7b6)