xref: /expo/docs/pages/bare/using-expo-cli.mdx (revision 7faebecd)
1---
2title: Use Expo CLI
3description: Learn how and why you can use Expo CLI instead of @react-native-community/cli in any React Native project.
4---
5
6import { Terminal } from '~/ui/components/Snippet';
7import { Collapsible } from '~/ui/components/Collapsible';
8import { BoxLink } from '~/ui/components/BoxLink';
9import { DEMI } from '~/ui/components/Text';
10
11To use Expo CLI in a project created with `npx react-native init`, you will first need to install the `expo` package.
12This package includes the Expo Modules API and Expo CLI. For a complete explanation of how to install this, see the [Install Expo modules](/bare/installing-expo-modules.mdx) guide.
13For most apps, it's as simple as running the following command in your project directory:
14
15<Terminal cmd={['npx install-expo-modules@latest']} />
16
17## Why Expo CLI instead of `npx react-native`
18
19Expo CLI commands provide a number of benefits over the similar commands in `@react-native-community/cli`, including:
20
21- You can open up the Hermes debugger in one keystroke: <kbd>J</kbd>.
22- The debugger ships with React Developer Tools (`react-devtools`) already installed.
23- Support for [Continuous Native Generation](/workflow/prebuild.mdx) (CNG) with `npx expo prebuild` for easy upgrades, white-labeling, simple third-party package setup,
24  and improved maintainability of your codebase (by reducing the surface area).
25- Support for file-based routing with [`expo-router`](https://expo.github.io/router/docs).
26- View native logs directly in the terminal alongside your JavaScript logs.
27- Improved native build log formatting by using Expo CLI's own `xcpretty`-style tool that is built specifically for React Native apps.
28  For example, when compiling a Pod you can see which Node module included it.
29- [Automatic TypeScript support](/guides/typescript.mdx).
30- [Automatic web support](/guides/customizing-metro.mdx#adding-web-support-to-metro) with Metro.
31- Out of the box [support for monorepos](/guides/monorepos.mdx).
32- Support for Expo tooling such as [expo-dev-client](/develop/development-builds/introduction.mdx), the [Expo Updates protocol](/technical-specs/expo-updates-1.mdx)
33  and [EAS Update](/eas-update/introduction.mdx).
34- `npx expo run:ios` will invoke `pod install` automatically when needed.
35- `npx expo install` picks known compatible versions of dependencies for well-known packages.
36- `npx expo run:[android|ios]` and `npx expo start` automatically detect if an app is running on the default port and suggests another.
37- Select an Android or iOS device to launch into using <kbd>Shift</kbd> + <kbd>I</kbd> or <kbd>Shift</kbd> + <kbd>A</kbd> from the interactive prompt.
38- Built-in support for serving your app over an [ngrok tunnel](/develop/development-builds/development-workflows.mdx#tunnel-urls),
39  which is useful for testing on physical devices on restricted networks.
40
41We recommend Expo CLI for most React Native projects that target Android, iOS, and/or web. It does not yet have built-in support for the most popular out-of-tree platforms,
42macOS and Windows — if you are building for those platforms, you can use Expo CLI for the supported platforms and `@react-native-community/cli` for the others.
43
44## Compiling and running your app
45
46Once you have the `expo` package installed, you can use the `npx expo run:android` and `npx expo run:ios` commands as alternatives to `npx react-native run-android`
47and `npx react-native run-ios`. You can pass in the `--device` flag to select a device/simulator to build for — this also works for any connected iOS device.
48
49## Starting the bundler
50
51`npx expo run:[android|ios]` will start the bundler/development server. You can skip that by passing in `--no-bundler` flag.
52Start the development server independently with `npx expo start --dev-client`.
53
54## Common questions
55
56<Collapsible summary="Can I use Expo CLI without installing the Expo Modules API?">
57
58When you install the `expo` package with `npx install-expo-modules`, you will also install the Expo Modules API. If you just want to try out Expo CLI for now,
59you can install the `expo` package with `npm install` and then configure your **react-native.config.js** to exclude the package from autolinking:
60
61```js
62module.exports = {
63  dependencies: {
64    expo: {
65      platforms: {
66        android: null,
67        ios: null,
68        macos: null,
69      },
70    },
71  },
72};
73```
74
75> **Note**: Not all features will work without the Expo Modules API installed. For example, you will not be able to use the `expo-dev-client` package or `expo-router`.
76
77</Collapsible>
78
79<Collapsible summary="Can I use prebuild for out-of-tree platforms, such as macOS or Windows?">
80
81Yes! Refer to the [Customized Prebuild Example repository](https://github.com/byCedric/custom-prebuild-example) for more information.
82
83</Collapsible>
84
85## Learn more
86
87With the `expo` package installed and configured in your project, you can start using all features from Expo CLI and SDK.
88
89<BoxLink
90  title="Expo CLI Reference"
91  description="Learn more about the commands and flags available in Expo CLI."
92  href="/more/expo-cli"
93/>
94<BoxLink
95  title="Adopting Prebuild"
96  description={
97    <>
98      Automate your native directories using the <DEMI>app.json</DEMI>.
99    </>
100  }
101  href="/guides/adopting-prebuild"
102/>
103<BoxLink
104  title="Using the Expo SDK"
105  description="Try out modules from the Expo SDK in your app"
106  href="/versions/"
107/>
108<BoxLink
109  title="Try Expo Router"
110  description="Expo Router brings the best routing concepts from the web to native Android and iOS apps."
111  href="https://expo.github.io/router/docs/"
112/>
113