React Native CLI

Command line tools to interact with React Native projects.

Commands

CLI comes with a set of commands and flags you can pass to them.

bundle
dependencies
info
install
library
link
log-android
log-ios
ram-bundle
run-android
run-ios
start
uninstall
unlink
upgrade

Note: This document is still under development and doesn't represent the full API area.

`bundle`

`dependencies`

`info`

`install`

Usage:

react-native install <packageName>

Installs single package from npm and then links native dependencies. If install detects yarn.lock in your project, it will use Yarn as package manager. Otherwise npm will be used.

`library`

`link`

Usage:

react-native link [packageName]

Link native dependency or all native dependencies if no packageName passed.

Options

`--platforms [list]`

Pass comma-separated list of platforms to scope link to.

`log-android`

`log-ios`

`ram-bundle`

`run-android`

`run-ios`

Usage:

react-native run-ios [options]

Builds your app and starts it on iOS simulator.

Options

`--simulator [simulator_name]`

Explicitly set the simulator to use. Optionally include iOS version between parenthesis at the end to match an exact version, e.g. "iPhone 6 (10.0)".

Default: "iPhone X"

Notes: simulator_name must be a valid iOS simulator name. If in doubt, open your AwesomeApp/ios/AwesomeApp.xcodeproj folder on XCode and unroll the dropdown menu containing the simulator list. The dropdown menu is situated on the right hand side of the play button (top left corner).

Example: this will launch your projet directly onto the iPhone XS Max simulator:

react-native run-ios --simulator "iPhone XS Max"

`--configuration [string]`

Explicitly set the scheme configuration to use default: 'Debug'.

`--scheme [string]`

Explicitly set Xcode scheme to use.

`--project-path [string]`

Path relative to project root where the Xcode project (.xcodeproj) lives. default: 'ios'.

`--device [string]`

Explicitly set device to use by name. The value is not required if you have a single device connected.

`--udid [string]`

Explicitly set device to use by udid.

`--no-packager`

Do not launch packager while building.

`--verbose`

Do not use xcpretty even if installed.

`--port [number]`

Runs packager on specified port

Default: process.env.RCT_METRO_PORT || 8081

`start`

Usage:

react-native start [option]

Starts the server that communicates with connected devices

Options

`--port [number]`

Specify port to listen on

`--watchFolders [list]`

Specify any additional folders to be added to the watch list

`--assetExts [list]`

Specify any additional asset extensions to be used by the packager

`--sourceExts [list]`

Specify any additional source extensions to be used by the packager

`--platforms [list]`

Specify any additional platforms to be used by the packager

`--providesModuleNodeModules [list]`

Specify any npm packages that import dependencies with providesModule

`--max-workers [number]`

Specifies the maximum number of workers the worker-pool will spawn for transforming files. This defaults to the number of the cores available on your machine

`--skipflow`

Disable flow checks

`--nonPersistent`

Disable file watcher

`--transformer [string]`

Specify a custom transformer to be used

`--reset-cache, --resetCache`

Removes cached files

`--custom-log-reporter-path, --customLogReporterPath [string]`

Path to a JavaScript file that exports a log reporter as a replacement for TerminalReporter

`--verbose`

Enables logging

`--https`

Enables https connections to the server

`--key [path]`

Path to custom SSL key

`--cert [path]`

Path to custom SSL cert

`--config [string]`

Path to the CLI configuration file

`uninstall`

Usage:

react-native uninstall <packageName>

Unlinks single package native dependencies and then uninstalls it from package.json. If uninstall detects yarn.lock in your project, it will use Yarn as package manager. Otherwise npm will be used.

`unlink`

Usage:

react-native unlink <packageName>

Unlink native dependency linked with the link command.

`upgrade`

Usage:

react-native upgrade [npm-version]

Upgrade your app's template files to the specified or latest npm version using rn-diff-purge project. Only valid semver versions are allowed.

Using this command is a recommended way of upgrading relatively simple React Native apps with not too many native libraries linked. The more iOS and Android build files are modified, the higher chance for a conflicts. The command will guide you on how to continue upgrade process manually in case of failure.

Note: If you'd like to upgrade using this method from React Native version lower than 0.59.0, you may use a standalone version of this CLI: npx @react-native-community/cli upgrade.

Current Tags

301 Versions

14.1.1 ... 2 months ago
15.0.0-alpha.2 ... 2 months ago
15.0.0-alpha.0 ... 2 months ago
14.1.0 ... 2 months ago
14.0.1 ... 3 months ago
14.0.0 ... 4 months ago
14.0.0-alpha.11 ... 5 months ago
14.0.0-alpha.10 ... 5 months ago
14.0.0-alpha.9 ... 5 months ago
14.0.0-alpha.8 ... 5 months ago
14.0.0-alpha.7 ... 5 months ago
14.0.0-alpha.6 ... 5 months ago
12.3.7 ... 5 months ago
13.6.9 ... 5 months ago
13.6.8 ... 5 months ago
13.6.7 ... 5 months ago
14.0.0-alpha.5 ... 6 months ago
13.6.6 ... 7 months ago
14.0.0-alpha.4 ... 7 months ago
13.6.5 ... 7 months ago
14.0.0-alpha.3 ... 7 months ago
13.6.4 ... 8 months ago
14.0.0-alpha.2 ... 8 months ago
13.6.3 ... 8 months ago
14.0.0-alpha.1 ... 8 months ago
14.0.0-alpha.0 ... 8 months ago
13.6.2 ... 8 months ago
13.6.1 ... 9 months ago
10.2.7 ... 9 months ago
11.4.1 ... 9 months ago
12.3.6 ... 9 months ago
13.6.0 ... 9 months ago
11.4.0 ... 9 months ago
12.3.5 ... 9 months ago
13.5.2 ... 9 months ago
12.3.4 ... 9 months ago
13.5.1 ... 10 months ago
12.3.3 ... 10 months ago
13.5.1-alpha.0 ... 10 months ago
12.3.2 ... 10 months ago
13.5.0 ... 10 months ago
12.3.1 ... 10 months ago
13.4.0 ... 10 months ago
13.3.0 ... 10 months ago
13.2.0 ... a year ago
12.3.0 ... a year ago
13.1.0 ... a year ago
12.2.1 ... a year ago
13.0.1 ... a year ago
13.0.0 ... a year ago
12.2.0 ... a year ago
12.1.1 ... a year ago
12.1.0 ... a year ago
9.3.5 ... a year ago
10.2.6 ... a year ago
11.3.10 ... a year ago
12.0.0 ... a year ago
11.3.9 ... a year ago
12.0.0-alpha.18 ... a year ago
12.0.0-alpha.17 ... a year ago
12.0.0-alpha.16 ... a year ago
12.0.0-alpha.15 ... a year ago
12.0.0-alpha.14 ... a year ago
12.0.0-alpha.13 ... a year ago
11.3.8 ... a year ago
12.0.0-alpha.12 ... a year ago
12.0.0-alpha.11 ... a year ago
12.0.0-alpha.10 ... a year ago
12.0.0-alpha.9 ... a year ago
12.0.0-alpha.8 ... a year ago
11.3.7 ... a year ago
9.3.4 ... a year ago
11.3.6 ... a year ago
12.0.0-alpha.7 ... a year ago
12.0.0-alpha.6 ... a year ago
11.3.5 ... a year ago
11.3.4 ... a year ago
11.3.3 ... a year ago
12.0.0-alpha.5 ... a year ago
10.2.5 ... a year ago
12.0.0-alpha.4 ... a year ago
11.3.2 ... a year ago
10.2.4 ... a year ago
10.2.3 ... a year ago
9.3.3 ... a year ago
8.0.7 ... a year ago
11.3.1 ... a year ago
11.3.0 ... a year ago
11.2.3 ... 2 years ago
11.2.2 ... 2 years ago
11.2.1 ... 2 years ago
11.2.0 ... 2 years ago
12.0.0-alpha.3 ... 2 years ago
11.1.3 ... 2 years ago
12.0.0-alpha.2 ... 2 years ago
11.1.2 ... 2 years ago
12.0.0-alpha.1 ... 2 years ago
12.0.0-alpha.0 ... 2 years ago
11.1.1 ... 2 years ago
11.0.2 ... 2 years ago
11.0.1 ... 2 years ago
11.0.0 ... 2 years ago
10.2.2 ... 2 years ago
10.2.1 ... 2 years ago
11.0.0-alpha.2 ... 2 years ago
11.0.0-alpha.0 ... 2 years ago
10.2.0 ... 2 years ago
10.1.3 ... 2 years ago
10.1.2 ... 2 years ago
10.1.1 ... 2 years ago
10.1.0 ... 2 years ago
10.0.0 ... 2 years ago
9.3.2 ... 2 years ago
10.0.0-alpha.5 ... 2 years ago
10.0.0-alpha.4 ... 2 years ago
9.3.1 ... 2 years ago
9.3.0 ... 2 years ago
10.0.0-alpha.3 ... 2 years ago
10.0.0-alpha.2 ... 2 years ago
10.0.0-alpha.1 ... 2 years ago
10.0.0-alpha.0 ... 2 years ago
9.2.1 ... 2 years ago
9.2.0 ... 2 years ago
9.1.3 ... 2 years ago
9.1.2 ... 2 years ago
9.1.1 ... 2 years ago
9.1.0 ... 2 years ago
9.0.1 ... 2 years ago
9.0.0 ... 2 years ago
8.0.6 ... 2 years ago
9.0.0-alpha.12 ... 2 years ago
9.0.0-alpha.11 ... 2 years ago
9.0.0-alpha.10 ... 2 years ago
9.0.0-alpha.9 ... 2 years ago
9.0.0-alpha.8 ... 2 years ago
9.0.0-alpha.7 ... 2 years ago
9.0.0-alpha.6 ... 2 years ago
8.0.5 ... 2 years ago
8.0.4 ... 2 years ago
9.0.0-alpha.5 ... 2 years ago
7.0.4 ... 2 years ago
9.0.0-alpha.4 ... 2 years ago
8.0.3 ... 2 years ago
9.0.0-alpha.3 ... 2 years ago
8.0.2 ... 2 years ago
9.0.0-alpha.2 ... 2 years ago
9.0.0-alpha.1 ... 2 years ago
8.0.1 ... 2 years ago
9.0.0-alpha.0 ... 2 years ago
8.0.0 ... 2 years ago
8.0.0-alpha.6 ... 3 years ago
8.0.0-alpha.5 ... 3 years ago
8.0.0-alpha.4 ... 3 years ago
8.0.0-alpha.0 ... 3 years ago
7.0.3 ... 3 years ago
7.0.2 ... 3 years ago
7.0.1 ... 3 years ago
6.4.0 ... 3 years ago
6.3.1 ... 3 years ago
6.3.0 ... 3 years ago
6.2.0 ... 3 years ago
6.1.0 ... 3 years ago
6.0.1 ... 3 years ago
6.0.0 ... 3 years ago
5.0.1 ... 3 years ago
6.0.0-rc.0 ... 3 years ago
5.0.1-alpha.2 ... 4 years ago
4.14.0 ... 4 years ago
5.0.1-alpha.1 ... 4 years ago
4.13.1 ... 4 years ago
5.0.1-alpha.0 ... 4 years ago
5.0.0-alpha.0 ... 4 years ago
4.13.0 ... 4 years ago
4.12.0 ... 4 years ago
4.11.0 ... 4 years ago
4.10.1 ... 4 years ago
4.10.0 ... 4 years ago
4.9.0 ... 4 years ago
4.8.0 ... 5 years ago
4.7.0 ... 5 years ago
4.6.3 ... 5 years ago
4.6.2 ... 5 years ago
4.6.0 ... 5 years ago
4.5.1 ... 5 years ago
4.5.0 ... 5 years ago
4.4.0 ... 5 years ago
4.3.0 ... 5 years ago
4.2.4 ... 5 years ago
4.2.3 ... 5 years ago
3.2.1 ... 5 years ago
4.2.2 ... 5 years ago
4.2.1 ... 5 years ago
4.2.0 ... 5 years ago
4.1.1 ... 5 years ago
3.2.0 ... 5 years ago
4.1.0 ... 5 years ago
4.0.1 ... 5 years ago
3.1.0 ... 5 years ago
3.0.5-alpha.1 ... 5 years ago
4.0.0 ... 5 years ago
3.0.5-alpha.0 ... 5 years ago
3.0.4 ... 5 years ago
1.12.0 ... 5 years ago
2.10.0 ... 5 years ago
3.0.1 ... 5 years ago
3.0.0 ... 5 years ago
3.0.0-alpha.7 ... 5 years ago
3.0.0-alpha.6 ... 5 years ago
3.0.0-alpha.2 ... 5 years ago
2.9.0 ... 5 years ago
3.0.0-alpha.1 ... 5 years ago
2.8.3 ... 5 years ago
2.8.2 ... 5 years ago
2.8.1 ... 5 years ago
1.11.2 ... 5 years ago
1.11.1 ... 5 years ago
1.11.0 ... 5 years ago
2.8.0 ... 5 years ago
2.7.1 ... 5 years ago
2.7.0 ... 5 years ago
2.6.2 ... 5 years ago
2.6.1 ... 5 years ago
2.6.0 ... 5 years ago
2.5.0 ... 5 years ago
2.4.3 ... 5 years ago
2.4.2 ... 5 years ago
2.4.1 ... 5 years ago
2.4.0 ... 5 years ago
2.3.0 ... 5 years ago
2.2.0 ... 5 years ago
2.1.2 ... 5 years ago
2.1.1 ... 5 years ago
2.1.0 ... 5 years ago
2.0.2 ... 5 years ago
2.0.1 ... 5 years ago
1.10.0 ... 5 years ago
2.0.0-rc.5 ... 5 years ago
2.0.0-rc.4 ... 5 years ago
1.9.12 ... 5 years ago
2.0.0-rc.3 ... 5 years ago
1.9.11 ... 5 years ago
1.9.10 ... 5 years ago
1.9.9 ... 5 years ago
2.0.0-rc.2 ... 5 years ago
2.0.0-rc.1 ... 5 years ago
1.9.8 ... 5 years ago
2.0.0-rc.0 ... 5 years ago
2.0.0-alpha.23 ... 5 years ago
1.9.7 ... 5 years ago
1.9.6 ... 5 years ago
1.9.5 ... 5 years ago
2.0.0-alpha.22 ... 5 years ago
2.0.0-alpha.21 ... 5 years ago
2.0.0-alpha.20 ... 6 years ago
2.0.0-alpha.19 ... 6 years ago
2.0.0-alpha.18 ... 6 years ago
1.9.4 ... 6 years ago
1.9.3 ... 6 years ago
2.0.0-alpha.17 ... 6 years ago
2.0.0-alpha.16 ... 6 years ago
2.0.0-alpha.15 ... 6 years ago
2.0.0-alpha.14 ... 6 years ago
2.0.0-alpha.13 ... 6 years ago
1.9.2 ... 6 years ago
2.0.0-alpha.12 ... 6 years ago
2.0.0-alpha.11 ... 6 years ago
2.0.0-alpha.10 ... 6 years ago
2.0.0-alpha.9 ... 6 years ago
2.0.0-alpha.8 ... 6 years ago
2.0.0-alpha.7 ... 6 years ago
1.9.1 ... 6 years ago
1.9.0 ... 6 years ago
1.8.0 ... 6 years ago
2.0.0-alpha.6 ... 6 years ago
1.7.0 ... 6 years ago
2.0.0-alpha.5 ... 6 years ago
2.0.0-alpha.4 ... 6 years ago
1.6.0 ... 6 years ago
2.0.0-alpha.3 ... 6 years ago
2.0.0-alpha.1 ... 6 years ago
1.5.2 ... 6 years ago
1.5.1 ... 6 years ago
1.5.0 ... 6 years ago
1.4.6 ... 6 years ago
2.0.0 [deprecated] ... 6 years ago
1.4.5 ... 6 years ago
1.4.4 ... 6 years ago
1.4.2 ... 6 years ago
1.4.1 ... 6 years ago
1.4.0 ... 6 years ago
1.3.2 ... 6 years ago
1.3.1 ... 6 years ago
1.3.0 ... 6 years ago
1.2.4 ... 6 years ago
1.2.3 ... 6 years ago
1.2.2 ... 6 years ago
1.2.1 ... 6 years ago
1.2.0 ... 6 years ago
1.1.0 ... 6 years ago
1.0.1 ... 6 years ago
1.0.0 ... 6 years ago