eas-cli

What is eas-cli?

The eas-cli package is a command-line tool for Expo Application Services (EAS), which helps developers build, submit, and manage their Expo and React Native apps. It provides functionalities for building apps, managing credentials, and submitting apps to app stores.

What are eas-cli's main functionalities?

Build

This command is used to build an iOS app using EAS Build. It allows developers to create production-ready builds for their applications.

eas build --platform ios

Submit

This command submits an Android app to the Google Play Store. It simplifies the process of app submission by handling various configurations and credentials.

eas submit --platform android

Credentials Management

This command manages credentials for both iOS and Android apps. It helps in setting up and managing the necessary credentials required for building and submitting apps.

eas credentials

Other packages similar to eas-cli

expo-cli

The expo-cli is a command-line tool for creating, building, and deploying Expo projects. While it shares some functionalities with eas-cli, such as building and managing Expo apps, eas-cli is more focused on advanced build and submission processes, particularly for production environments.

fastlane

Fastlane is a tool for automating app deployment and release processes. It offers a wide range of functionalities for building, testing, and releasing apps. Compared to eas-cli, fastlane is more general-purpose and can be used with various platforms and CI/CD pipelines, whereas eas-cli is specifically tailored for Expo and React Native apps.

README

eas-cli

EAS command line tool

• Installation
• Usage
• Commands

Installation

npm install -g eas-cli
# or
yarn global add eas-cli

Usage

eas COMMAND
# runs the command
eas (-v|--version|version)
# prints the version
eas --help COMMAND
# outputs help for specific command

Commands

• eas account:login
• eas account:logout
• eas account:view
• eas analytics [STATUS]
• eas build
• eas build:cancel [BUILD_ID]
• eas build:configure
• eas build:list
• eas build:view [BUILD_ID]
• eas config
• eas credentials
• eas device:create
• eas device:list
• eas device:view [UDID]
• eas diagnostics
• eas help [COMMAND]
• eas project:info
• eas project:init
• eas secret:create
• eas secret:delete
• eas secret:list
• eas submit
• eas webhook:create
• eas webhook:delete [ID]
• eas webhook:list
• eas webhook:update
• eas webhook:view ID

eas account:login

log in with your Expo account

USAGE
  $ eas account:login

ALIASES
  $ eas login

See code: src/commands/account/login.js

eas account:logout

log out

USAGE
  $ eas account:logout

ALIASES
  $ eas logout

See code: src/commands/account/logout.js

eas account:view

show the username you are logged in as

USAGE
  $ eas account:view

ALIASES
  $ eas whoami

See code: src/commands/account/view.js

eas analytics [STATUS]

view or change analytics settings

USAGE
  $ eas analytics [STATUS]

See code: src/commands/analytics.js

eas build

start a build

USAGE
  $ eas build

OPTIONS
  -p, --platform=(android|ios|all)

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

  --auto-submit-with-profile=PROFILE_NAME  Submit on build complete using the submit profile with provided name

  --clear-cache                            Clear cache before the build

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

  --local                                  Run build locally [experimental]

  --non-interactive                        Run command in non-interactive mode

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

  --skip-project-configuration             Skip project configuration

  --[no-]wait                              Wait for build(s) to complete

See code: src/commands/build/index.js

eas build:cancel [BUILD_ID]

Cancel a build.

USAGE
  $ eas build:cancel [BUILD_ID]

See code: src/commands/build/cancel.js

eas build:configure

Configure the project to support EAS Build.

USAGE
  $ eas build:configure

OPTIONS
  -p, --platform=(android|ios|all)  Platform to configure

See code: src/commands/build/configure.js

eas build:list

list all builds for your project

USAGE
  $ eas build:list

OPTIONS
  --appBuildVersion=appBuildVersion
  --appIdentifier=appIdentifier
  --appVersion=appVersion
  --buildProfile=buildProfile
  --channel=channel
  --distribution=(store|internal|simulator)
  --gitCommitHash=gitCommitHash

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

  --limit=limit

  --platform=(all|android|ios)

  --runtimeVersion=runtimeVersion

  --sdkVersion=sdkVersion

  --status=(new|in-queue|in-progress|errored|finished|canceled)

See code: src/commands/build/list.js

eas build:view [BUILD_ID]

view a build for your project

USAGE
  $ eas build:view [BUILD_ID]

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

See code: src/commands/build/view.js

eas config

show the eas.json config

USAGE
  $ eas config

OPTIONS
  -p, --platform=(android|ios)
  --profile=profile

See code: src/commands/config.js

eas credentials

manage your credentials

USAGE
  $ eas credentials

See code: src/commands/credentials.js

eas device:create

register new Apple Devices to use for internal distribution

USAGE
  $ eas device:create

See code: src/commands/device/create.js

eas device:list

list all registered devices for your account

USAGE
  $ eas device:list

OPTIONS
  --apple-team-id=apple-team-id

See code: src/commands/device/list.js

eas device:view [UDID]

view a device for your project

USAGE
  $ eas device:view [UDID]

See code: src/commands/device/view.js

eas diagnostics

log environment info to the console

USAGE
  $ eas diagnostics

See code: src/commands/diagnostics.js

eas help [COMMAND]

display help for eas

USAGE
  $ eas help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

eas project:info

information about the current project

USAGE
  $ eas project:info

See code: src/commands/project/info.js

eas project:init

create or link an EAS project

USAGE
  $ eas project:init

ALIASES
  $ eas init

See code: src/commands/project/init.js

eas secret:create

Create an environment secret on the current project or owner account.

USAGE
  $ eas secret:create

OPTIONS
  --force                    Delete and recreate existing secrets
  --name=name                Name of the secret
  --scope=(account|project)  [default: project] Scope for the secret
  --value=value              Value of the secret

See code: src/commands/secret/create.js

eas secret:delete

Delete an environment secret by ID.

USAGE
  $ eas secret:delete

OPTIONS
  --id=id  ID of the secret to delete

DESCRIPTION
  Unsure where to find the secret's ID? Run eas secret:list

See code: src/commands/secret/delete.js

eas secret:list

Lists environment secrets available for your current app

USAGE
  $ eas secret:list

See code: src/commands/secret/list.js

eas submit

submit build archive to app store

USAGE
  $ eas submit

OPTIONS
  -p, --platform=(android|ios|all)
  --id=id                           ID of the build to submit
  --latest                          Submit the latest build for specified platform
  --non-interactive                 Run command in non-interactive mode
  --path=path                       Path to the .apk/.aab/.ipa file

  --profile=profile                 Name of the submit profile from eas.json. Defaults to "production" if defined in
                                    eas.json.

  --url=url                         App archive url

  --verbose                         Always print logs from Submission Service

  --[no-]wait                       Wait for submission to complete

DESCRIPTION
  See how to configure submits with eas.json: https://docs.expo.dev/submit/eas-json/

ALIASES
  $ eas build:submit

See code: src/commands/submit.js

eas webhook:create

Create a webhook on the current project.

USAGE
  $ eas webhook:create

OPTIONS
  --event=(BUILD)  [default: BUILD] Event type that triggers the webhook

  --secret=secret  Secret used to create a hash signature of the request payload, provided in the 'Expo-Signature'
                   header.

  --url=url        Webhook URL

See code: src/commands/webhook/create.js

eas webhook:delete [ID]

Delete a webhook on the current project.

USAGE
  $ eas webhook:delete [ID]

ARGUMENTS
  ID  ID of the webhook to delete

See code: src/commands/webhook/delete.js

eas webhook:list

List webhooks on the current project.

USAGE
  $ eas webhook:list

OPTIONS
  --event=(BUILD)  Event type that triggers the webhook

See code: src/commands/webhook/list.js

eas webhook:update

Create a webhook on the current project.

USAGE
  $ eas webhook:update

OPTIONS
  --event=(BUILD)  [default: BUILD] Event type that triggers the webhook
  --id=id          (required) Webhook ID

  --secret=secret  Secret used to create a hash signature of the request payload, provided in the 'Expo-Signature'
                   header.

  --url=url        Webhook URL

See code: src/commands/webhook/update.js

eas webhook:view ID

View a webhook on the current project.

USAGE
  $ eas webhook:view ID

ARGUMENTS
  ID  ID of the webhook to view

See code: src/commands/webhook/view.js