Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/react-native-community/cli
The React Native Community CLI - command line tools to help you build RN apps
https://github.com/react-native-community/cli
android cli hacktoberfest ios javascript npm react-native typescript yarn
Last synced: 6 days ago
JSON representation
The React Native Community CLI - command line tools to help you build RN apps
- Host: GitHub
- URL: https://github.com/react-native-community/cli
- Owner: react-native-community
- License: mit
- Created: 2018-09-25T21:15:26.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T17:35:39.000Z (3 months ago)
- Last Synced: 2024-10-29T09:29:13.990Z (3 months ago)
- Topics: android, cli, hacktoberfest, ios, javascript, npm, react-native, typescript, yarn
- Language: TypeScript
- Homepage:
- Size: 13.3 MB
- Stars: 2,375
- Watchers: 46
- Forks: 902
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome - react-native-community/cli - The React Native Community CLI - command line tools to help you build RN apps (TypeScript)
- jimsghstars - react-native-community/cli - The React Native Community CLI - command line tools to help you build RN apps (TypeScript)
README
# React Native Community CLI
Command line tools that help you build apps with [`react-native`](https://github.com/facebook/react-native), shipped as the `@react-native-community/cli` NPM package.
[![Build Status][build-badge]][build] [![Version][version-badge]][package] [![MIT License][license-badge]][license] [![PRs Welcome][prs-welcome-badge]][prs-welcome] [![Lean Core Extracted][lean-core-badge]][lean-core]
_Note: CLI has been extracted from core `react-native` as a part of "[Lean Core](https://github.com/facebook/react-native/issues/23313)" effort. Please read [this blog post](https://www.callstack.com/blog/the-react-native-cli-has-a-new-home) for more details._
## Contents
- [Compatibility](#compatibility)
- [Documentation](#documentation)
- [About](#about)
- [Creating a new React Native project](#creating-a-new-react-native-project)
- [Usage in an existing React Native project](#usage-in-an-existing-react-native-project)
- [Updating the CLI](#updating-the-cli)
- [Maintainers](#maintainers)
- [License](#license)
## Compatibility
Our release cycle is independent of `react-native`. We follow semver and here is the compatibility table:
| `@react-native-community/cli` | `react-native` |
| ------------------------------------------------------------------ | ----------------------- |
| [^16.0.0](https://github.com/react-native-community/cli/tree/main) | ^0.77.0 |
| [^15.0.0](https://github.com/react-native-community/cli/tree/15.x) | ^0.76.0 |
| [^14.0.0](https://github.com/react-native-community/cli/tree/14.x) | ^0.75.0 |
| [^13.0.0](https://github.com/react-native-community/cli/tree/13.x) | ^0.74.0 |
| [^12.0.0](https://github.com/react-native-community/cli/tree/12.x) | ^0.73.0 |
| [^11.0.0](https://github.com/react-native-community/cli/tree/11.x) | ^0.72.0 |
| [^10.0.0](https://github.com/react-native-community/cli/tree/10.x) | ^0.71.0 |
| [^9.0.0](https://github.com/react-native-community/cli/tree/9.x) | ^0.70.0 |
| [^8.0.0](https://github.com/react-native-community/cli/tree/8.x) | ^0.69.0 |
| [^7.0.0](https://github.com/react-native-community/cli/tree/7.x) | ^0.68.0 |
| [^6.0.0](https://github.com/react-native-community/cli/tree/6.x) | ^0.65.0,^0.66.0,^0.67.0 |
| [^5.0.0](https://github.com/react-native-community/cli/tree/5.x) | ^0.64.0 |
| [^4.0.0](https://github.com/react-native-community/cli/tree/4.x) | ^0.62.0,^0.63.0 |
| [^3.0.0](https://github.com/react-native-community/cli/tree/3.x) | ^0.61.0 |
| [^2.0.0](https://github.com/react-native-community/cli/tree/2.x) | ^0.60.0 |
| [^1.0.0](https://github.com/react-native-community/cli/tree/1.x) | ^0.59.0 |
## Documentation
- [configuration](./docs/configuration.md)
- [commands](./docs/commands.md)
- [plugins](./docs/plugins.md)
- [init](./docs/init.md)
- [autolinking](./docs/autolinking.md)
## About
This monorepository contains tools and helpers for React Native projects in form of a Command Line Tool (or CLI). This CLI is used directly by the `react-native` package and is not intended for use directly. We update it independently of React Native itself.
## Creating a new React Native project
Run the following command in your terminal prompt:
```sh
npx @react-native-community/cli@latest init MyApp
```
## Usage in an existing React Native project
Once you're inside an existing project, you can run a series of commands to interact with your projects by using the `rnc-cli` binary.
Example running `start` command in terminal:
```sh
yarn rnc-cli start
```
You can also add npm scripts to call it with whichever package manager you use:
```json
{
"scripts": {
"start": "rnc-cli start"
}
}
```
to call it as
```sh
yarn start
```
## Updating the CLI
> [!WARNING]
> Please do it only if you need to. We don't recommend updating CLI independently of `react-native` as it may cause unexpected issues.
React Native CLI is a dependency of `react-native`, which makes it a transitive dependency of your project. You can overwrite the version independently of `react-native` by using `resolutions` field in your `package.json`:
```json
{
"resolutions": {
"@react-native-community/cli": "VERSION",
"@react-native-community/cli-clean": "VERSION",
"@react-native-community/cli-config": "VERSION",
"@react-native-community/cli-debugger-ui": "VERSION",
"@react-native-community/cli-doctor": "VERSION",
"@react-native-community/cli-link-assets": "VERSION",
"@react-native-community/cli-platform-android": "VERSION",
"@react-native-community/cli-platform-ios": "VERSION",
"@react-native-community/cli-server-api": "VERSION",
"@react-native-community/cli-tools": "VERSION",
"@react-native-community/cli-types": "VERSION"
}
}
```
## Maintainers
- Adam Trzciński ([**@adamTrz**](https://github.com/adamTrz)) - [Callstack](https://callstack.com)
- Michał Pierzchała ([**@thymikee**](https://github.com/thymikee)) - [Callstack](https://callstack.com)
Previously:
- Mike Grabowski ([**@grabbou**](https://github.com/grabbou)) - [Callstack](https://callstack.com)
- Kacper Wiszczuk ([**@esemesek**](https://github.com/esemesek))
## License
Everything inside this repository is [MIT licensed](./LICENSE).
[build-badge]: https://img.shields.io/github/actions/workflow/status/react-native-community/cli/test.yml?branch=main&style=flat-square
[build]: https://github.com/react-native-community/cli/actions/workflows/test.yml
[version-badge]: https://img.shields.io/npm/v/@react-native-community/cli.svg?style=flat-square
[package]: https://www.npmjs.com/package/@react-native-community/cli
[license-badge]: https://img.shields.io/npm/l/@react-native-community/cli.svg?style=flat-square
[license]: https://opensource.org/licenses/MIT
[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs-welcome]: http://makeapullrequest.com
[lean-core-badge]: https://img.shields.io/badge/Lean%20Core-Extracted-brightgreen.svg?style=flat-square
[lean-core]: https://github.com/facebook/react-native/issues/23313