@react-native-community/cli
Advanced tools
The @react-native-community/cli package is a command-line tool that provides a set of tools to manage and automate tasks in React Native applications. It is designed to streamline the process of initializing, developing, and testing React Native apps. It offers functionalities such as starting a development server, linking native dependencies, and more.
Initializing a new React Native project
This command sets up a new React Native project named 'AwesomeProject'. It creates a directory with the project name, installs the necessary dependencies, and sets up a basic React Native project structure.
npx react-native init AwesomeProjectRunning the React Native application
These commands are used to compile and run your React Native app on Android and iOS devices or emulators. 'run-android' targets Android devices, while 'run-ios' targets iOS devices.
npx react-native run-android
npx react-native run-iosLinking native dependencies
This command automatically links native dependencies in your project. It scans the project for native modules and configures them for use with React Native, simplifying the manual linking process.
npx react-native linkExpo CLI is a command-line tool that provides a set of tools similar to @react-native-community/cli but focuses on projects using the Expo framework. It simplifies the process of developing, building, and deploying React Native apps without needing to open Xcode or Android Studio. Compared to @react-native-community/cli, Expo CLI offers a more managed environment, which can be advantageous for beginners or for projects that can benefit from Expo's additional services and APIs.
Ignite CLI is a React Native toolchain that helps in initializing and managing React Native projects with additional boilerplates, plugins, and more. It offers a more opinionated setup compared to @react-native-community/cli, including pre-configured boilerplates, plugins, and best practices out of the box. This can help speed up development and enforce consistency across projects.
Command line tools to interact with React Native projects.
CLI comes with a set of commands and flags you can pass to them.
bundledependenciesinfoinstalllibrarylinklog-androidlog-iosram-bundlerun-androidrun-iosserveruninstallunlinkupgradeNote: This document is still under development and doesn't represent the full API area.
bundledependenciesinfoinstallUsage:
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.
librarylinklog-androidlog-iosram-bundlerun-androidrun-iosUsage:
react-native run-ios [options]
Builds your app and starts it on iOS simulator.
--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-packagerDo not launch packager while building.
--verboseDo not use xcpretty even if installed.
--port [number]Runs packager on specified port
Default: process.env.RCT_METRO_PORT || 8081
serveruninstallUsage:
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.
unlinkupgradeFAQs
React Native CLI
The npm package @react-native-community/cli receives a total of 2,029,281 weekly downloads. As such, @react-native-community/cli popularity was classified as popular.
We found that @react-native-community/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket has been recognized for the second consecutive year on the Fortune Cyber 60 list, which identifies the most significant venture-backed cybersecurity startups.
Security News
Python becomes GitHub's top language in 2024, driven by AI and data science projects, while AI-powered security tools are gaining adoption.
Security News
Dutch National Police and FBI dismantle Redline and Meta infostealer malware-as-a-service operations in Operation Magnus, seizing servers and source code.