# no-npx-rn-cli

> Command line tools that ship with [`react-native`](https://github.com/facebook/react-native) in form of the `@react-native-community/cli` package.

Latest version **1.0.0** (published 2019-12-12) · ISC license · 0 weekly downloads

## Install

```sh
npm install no-npx-rn-cli
pnpm add no-npx-rn-cli
yarn add no-npx-rn-cli
bun add no-npx-rn-cli
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-12-12 |
| First published | 2019-12-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 25 |
| Unpacked size | 633.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | yes |
| GitHub stars | 0 |
| Maintainers | mahamatali |

## Links

- npm: https://www.npmjs.com/package/no-npx-rn-cli
- Repository: https://github.com/mahyali/cli
- Homepage: https://github.com/mahyali/cli#readme
- Issues: https://github.com/mahyali/cli/issues
- npm.io page: https://npm.io/package/no-npx-rn-cli

## Dependencies (25)

- [glob](https://npm.io/package/glob.md) ^7.1.3
- [jest](https://npm.io/package/jest.md) ^24.6.0
- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [execa](https://npm.io/package/execa.md) ^1.0.0
- [lerna](https://npm.io/package/lerna.md) ^3.18.4
- [eslint](https://npm.io/package/eslint.md) ^5.10.0
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [babel-jest](https://npm.io/package/babel-jest.md) ^24.6.0
- [micromatch](https://npm.io/package/micromatch.md) ^3.1.10
- [typescript](https://npm.io/package/typescript.md) ^3.7.0
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.0.0
- [@types/jest](https://npm.io/package/@types/jest.md) ^24.0.11
- [@types/node](https://npm.io/package/@types/node.md) 8
- [string-length](https://npm.io/package/string-length.md) ^2.0.0
- [metro-memory-fs](https://npm.io/package/metro-memory-fs.md) ^0.56.0
- [@babel/preset-env](https://npm.io/package/@babel/preset-env.md) ^7.0.0
- [@types/node-fetch](https://npm.io/package/@types/node-fetch.md) ^2.3.7
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.17.0
- [@babel/preset-typescript](https://npm.io/package/@babel/preset-typescript.md) ^7.3.3
- [babel-plugin-module-resolver](https://npm.io/package/babel-plugin-module-resolver.md) ^3.2.0
- [eslint-import-resolver-alias](https://npm.io/package/eslint-import-resolver-alias.md) ^1.1.2
- [eslint-import-resolver-typescript](https://npm.io/package/eslint-import-resolver-typescript.md) ^1.1.1
- [@babel/plugin-transform-strict-mode](https://npm.io/package/@babel/plugin-transform-strict-mode.md) ^7.0.0
- [@react-native-community/eslint-config](https://npm.io/package/@react-native-community/eslint-config.md) ^0.0.5
- [@babel/plugin-transform-modules-commonjs](https://npm.io/package/@babel/plugin-transform-modules-commonjs.md) ^7.2.0

## Recent versions

- 1.0.0 (latest) — 2019-12-12

## README

# React Native CLI

Command line tools that ship with [`react-native`](https://github.com/facebook/react-native) in form of the `@react-native-community/cli` package.

> It exposes `react-native` binary, so you can call `yarn react-native` or `npx react-native` directly from your project.

[![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://blog.callstack.io/the-react-native-cli-has-a-new-home-79b63838f0e6) for more details._

## Contents

- [Compatibility](#compatibility)
- [Documentation](#documentation)
- [About](#about)
- [Creating a new React Native project](#creating-a-new-react-native-project)
  - [Using `npx` (_recommended_)](#using-npx-recommended)
  - [Using global CLI (_legacy_)](#using-global-cli-legacy)
- [Usage in an existing React Native project](#usage-in-an-existing-react-native-project)
- [Updating the CLI](#updating-the-cli)
- [Contributing](./CONTRIBUTING.md)
- [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`   |
| ---------------------------------------------------------------- | ---------------- |
| ^4.0.0 (`next`)                                                  | ^0.63.0          |
| ^3.0.0                                                           | ^0.61.0, ^0.62.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 repository contains tools and helpers for React Native projects in form of a command line tool. There's been quite some confusion around that since the extraction from React Native core. Let's clear them up:

- There are currently two CLIs:
  - [`@react-native-community/cli`](./packages/cli) – **the one used directly by `react-native`**. That makes it a transitive dependency of your project.
  - [`react-native-cli`](./packages/global-cli) – an optional global convenience package, which is a proxy to [`@react-native-community/cli`](./packages/cli) and global installation helper. **Please consider it legacy, because it's not necessary anymore**.
- When we say "the CLI" we mean `@react-native-community/cli`.
- We update the CLI independently of React Native itself. Please see [how to use the latest version](#updating-the-cli).
- This is a monorepo to keep stuff organized.

We're actively working to make any indirections gone.

## Creating a new React Native project

There are two ways to start a React Native project.

### Using `npx` (_recommended_)

> Available since `react-native@0.60`

This method is preferred if you don't want to install global packages.

```sh
npx react-native init MyApp
```

### Using global CLI (_legacy_)

You'll need to install a global module [`react-native-cli`](./packages/global-cli) and follow instructions there.

> We strongly encourage you to **only use global `react-native-cli` for bootstrapping new projects**. Use local version for everything else.

You can find out more about init command from the [documentation](./docs/init.md)

## Usage in an existing React Native project

Once you're inside an existing project, a local `react-native` binary will be available for you to use. Feel free to use Yarn to call it directly.

Example running `start` command in terminal:

```sh
yarn react-native start
# or:
npx react-native start
# or
node ./node_modules/.bin/react-native start
```

You can also add npm scripts to call it with whichever package manager you use:

```json
{
  "scripts": {
    "start": "react-native start"
  }
}
```

## Updating the CLI

Because we release independently of `react-native`, it happens that you may be locked on a version without fixes for bugs that affect you. Here's how to get it sorted:

1. If you use lock files (`yarn.lock` or `package-lock.json`) - find the `@react-native-community/cli` entry, remove it, run `yarn install` / `npm install` once again.
2. If you don't use lock files – remove `node_modules` and run `yarn install` / `npm install` again.
3. Run `yarn list @react-native-community/cli` or `npm list @react-native-community/cli` and verify you're on the latest version.

After performing these steps you should be on the latest CLI version. Feel free to do it once in a while, because we release often.

## Maintainers

- Michał Pierzchała ([**@thymikee**](https://github.com/thymikee)) - [Callstack](https://callstack.com)
- Mike Grabowski ([**@grabbou**](https://github.com/grabbou)) - [Callstack](https://callstack.com)
- Kacper Wiszczuk ([**@esemesek**](https://github.com/esemesek)) - [Callstack](https://callstack.com)

## License

Everything inside this repository is [MIT licensed](./LICENSE).

<!-- badges -->

[build-badge]: https://img.shields.io/circleci/project/github/react-native-community/cli/master.svg?style=flat-square
[build]: https://circleci.com/gh/react-native-community/cli/tree/master
[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

---
_Source: https://npm.io/package/no-npx-rn-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._