The Expo Plugin for Nx contains executors and generators for managing and developing an expo application within your workspace. For example, you can directly build for different target platforms as well as generate projects and publish your code.

Start an EAS update for your expo project

update

Use the current git branch and commit message for the EAS branch and update message

Enable JSON output, non-JSON messages will be printed to stderr

The platform to build the app, example values: ios, android, all.

File containing the PEM-encoded private key corresponding to the certificate in expo-updates' configuration. Defaults to a file named "private-key.pem" in the certificate's directory.

Skip running Expo CLI to bundle the app before publishing

Expo EAS Update executor

build

Submit on build complete using the submit profile with the same name as the build profile

Submit on build complete using the submit profile with provided name

Name of the build profile from eas.json. Defaults to "production" if defined in eas.json.

Expo EAS Build executor

List all EAS builds for your Expo project

build-list

Expo EAS Build List executor

download

Download EAS Build executor

Build and sign a standalone IPA for the Apple App Store

build-ios

Apple ID username (please also set the Apple ID password as EXPO_APPLE_PASSWORD environment variable).

Clear all credentials stored on Expo servers.

Remove Distribution Certificate stored on Expo servers.

Remove Provisioning Profile stored on Expo servers.

Remove Push Notifications Certificate stored on Expo servers. Use of Push Notifications Certificates is deprecated.

Remove Push Notifications Key stored on Expo servers.

Path to your Distribution Certificate P12 (set password as EXPO_IOS_DIST_P12_PASSWORD environment variable).

Disable automatic publishing before building.

The URL of an externally hosted manifest (for self-hosted apps).

Revoke credentials on developer.apple.com, select appropriate using --clear-* options.

Skip warning about build service bare workflow limitations.

Syncs npm dependencies to package.json (for React Native autolink). Always true when --install is used.

Expo iOS Build executor

Build and sign a standalone APK or App Bundle for the Google Play Store

build-android

Expo Android Build executor

build-web

Prevent webpack from generating the manifest.json and injecting meta into the index.html head.

Expo web Build executor

Get the status of the latest build for the project

build-status

publish

Maximum number of tasks to allow Metro to spawn

Suppress verbose output from the Metro bundler

The release channel to publish to. Default is 'default'.

A phone number or email address to send a link to

Target environment for which this publish is intended. Options are managed or bare.

Publish for Expo

Specify the channel to serve a published release

publish-set

The id of the published release to serve from the channel.

Set Publish Channel for Expo

rollback

Rollback Publish Command for Expo

Run the Android app binary locally or run the iOS app binary locally

Whether to skip starting the Metro bundler. True to start it, false to skip it.

Device name or UDID to build the app on. The value is not required if you have a single device connected.

(iOS) Explicitly set the Xcode scheme to use

(Android) Specify your app's build variant (e.g. debug, release).

(iOS) Xcode configuration to use. Debug or Release

Run iOS or Android application

Start a local dev server for the app or start a Webpack dev server for the web app

start

Opens your app in Expo Go on a connected Android device

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

lan (default), tunnel, localhost. Type of host to use. "tunnel" allows you to view your link on other networks

To start webpack with https or http protocol

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

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

Custom URI protocol to use with a development build

Start a Webpack dev server for the web app.

Packager Server for Expo

Syncs dependencies to package.json (required for autolinking).

sync-deps

Updates package.json with project dependencies

A comma-separated list of additional npm packages to include. e.g. 'nx sync-deps --include=react-native-gesture-handler,react-native-safe-area-context'

Sync Deps for Expo

Ensure workspace node_modules is symlink under app's node_modules folder.

ensure-symlink

Ensure Symlink for Expo

Create native iOS and Android project files.

eject

Create native iOS and Android project files

Expo Eject

init

Add Nx Expo Schematics

application

Use class components instead of functional components

The display name to show in the application. Defaults to name.

Generate JavaScript files rather than TypeScript files

Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.

Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.

Create an Expo Application for Nx

library

When true, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is '*.css' rather than '*.module.css').

The library name used to import it, like @myorg/my-awesome-lib

Generate JavaScript files rather than TypeScript files.

Use pascal case component file name (e.g. App.tsx).

Do not update tsconfig.json for development experience.

Whether to enable tsconfig strict mode or not.

Create a Expo Library for Nx

component

Generate a component in the mylib library

Generate a class component in the mylib library

Use class components instead of functional component.

Create the component under this directory (can be nested).

When true, the component is exported from the project index.ts (if it exists).

Create component at the source root rather than its own directory.

When true, does not create "spec.ts" test files for the new component.

@nrwl/expo:sync-deps

Options playground

Options

include