@nx/expo:start

Packager Server target options.

Options can be configured in project.json when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/reference/project-configuration#targets.

project.json:

{
  "name": "mobile",
  //...
  "targets": {
    //...
    "start": {
      "executor": "@nx/expo:start",
      "options": {
        "port": 8081
      }
    }
    //...
  }
}
Nx 15 and lower use @nrwl/ instead of @nx/

❯

nx run mobile:start

Examples

The ios, android and web option allows you to start the server on different platforms.

Opens your app in Expo Go in a currently running iOS simulator on your computer:

    "start": {
      "executor": "@nx/expo:start",
      "options": {
        "port": 8081,
        "ios": true
      }
    }
Nx 15 and lower use @nrwl/ instead of @nx/

or run command nx start <your app name> --ios.

Opens your app in Expo Go on a connected Android device

    "start": {
      "executor": "@nx/expo:start",
      "options": {
        "port": 8081,
        "android": true
      }
    }
Nx 15 and lower use @nrwl/ instead of @nx/

or run command nx start <your app name> --android.

Opens your app in a web browser:

    "start": {
      "executor": "@nx/expo:start",
      "options": {
        "port": 8081,
        "web": true
      }
    }
Nx 15 and lower use @nrwl/ instead of @nx/

or run command nx start <your app name> --web.

Options playground

Try out this interactive editor of the configuration object. Values are validated as you type and hovering over labels will give you more information.

Options

android

boolean

Opens your app in Expo Go on a connected Android device

clear

boolean

Clear the Metro bundler cache

dev

boolean

Turn development mode on or off

devClient

boolean

Experimental: Starts the bundler for use with the expo-development-client

forceManifestType

string

Accepted values: expo-updates, classic

Override auto detection of manifest type.

https

boolean

To start webpack with https or http protocol

host

string

Accepted values: localhost, lan, tunnel

lan (default), tunnel, localhost. Type of host to use. lan uses the local network; tunnel ues any network by tunnel through ngrok; localhost connects to the dev server over localhost.

ios

boolean

Opens your app in Expo Go in a currently running iOS simulator on your computer

lan

boolean

Same as --host lan

localhost

boolean

Same as --host localhost

maxWorkers

number

Maximum number of tasks to allow Metro to spawn

minify

boolean

Whether or not to minify code

offline

boolean

Allows this command to run while offline

privateKeyPath

string

Path to private key for code signing. Default: 'private-key.pem' in the same directory as the certificate specified by the expo-updates configuration in app.json.

port

number

Default: 19000

Port to start the native Metro bundler on (does not apply to web or tunnel)

scheme

string

Custom URI protocol to use with a development build

tunnel

boolean

Same as --host tunnel

web

boolean

Opens your app in a web browser