eas-cli

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 branch:create [NAME]
• eas branch:delete [NAME]
• eas branch:list
• eas branch:rename
• eas branch:view [NAME]
• eas build
• eas build:cancel [BUILD_ID]
• eas build:configure
• eas build:inspect
• eas build:list
• eas build:view [BUILD_ID]
• eas channel:create [NAME]
• eas channel:edit [NAME]
• eas channel:list
• eas channel:view [NAME]
• 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 update
• eas update:configure
• eas update:delete GROUPID
• eas update:view GROUPID
• 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

DESCRIPTION
  log in with your Expo account

ALIASES
  $ eas login

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

eas account:logout

log out

USAGE
  $ eas account:logout

DESCRIPTION
  log out

ALIASES
  $ eas logout

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

eas account:view

show the username you are logged in as

USAGE
  $ eas account:view

DESCRIPTION
  show the username you are logged in as

ALIASES
  $ eas whoami

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

eas analytics [STATUS]

view or change analytics settings

USAGE
  $ eas analytics [STATUS]

DESCRIPTION
  view or change analytics settings

See code: src/commands/analytics.ts

eas branch:create [NAME]

Create a branch on the current project.

USAGE
  $ eas branch:create [NAME] [--json]

ARGUMENTS
  NAME  Name of the branch to create

FLAGS
  --json  return a json with the new branch ID and name.

DESCRIPTION
  Create a branch on the current project.

See code: src/commands/branch/create.ts

eas branch:delete [NAME]

Delete a branch on the current project

USAGE
  $ eas branch:delete [NAME] [--json]

ARGUMENTS
  NAME  Name of the branch to delete

FLAGS
  --json  return JSON with the edited branch's ID and name.

DESCRIPTION
  Delete a branch on the current project

See code: src/commands/branch/delete.ts

eas branch:list

List all branches on this project.

USAGE
  $ eas branch:list [--json]

FLAGS
  --json  return output as JSON

DESCRIPTION
  List all branches on this project.

See code: src/commands/branch/list.ts

eas branch:rename

Rename a branch.

USAGE
  $ eas branch:rename [--from <value>] [--to <value>] [--json]

FLAGS
  --from=<value>  current name of the branch.
  --json          return a json with the edited branch's ID and name.
  --to=<value>    new name of the branch.

DESCRIPTION
  Rename a branch.

See code: src/commands/branch/rename.ts

eas branch:view [NAME]

View a branch.

USAGE
  $ eas branch:view [NAME] [--json]

ARGUMENTS
  NAME  Name of the branch to view

FLAGS
  --json  return a json with the branch's ID name and recent update groups.

DESCRIPTION
  View a branch.

See code: src/commands/branch/view.ts

eas build

Start a build

USAGE
  $ eas build [-p android|ios|all] [--json] [--skip-project-configuration] [--profile <value>]
    [--non-interactive] [--local] [--wait] [--clear-cache] [--auto-submit | --auto-submit-with-profile <value>]

FLAGS
  -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

DESCRIPTION
  Start a build

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

eas build:cancel [BUILD_ID]

Cancel a build.

USAGE
  $ eas build:cancel [BUILD_ID]

DESCRIPTION
  Cancel a build.

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

eas build:configure

Configure the project to support EAS Build.

USAGE
  $ eas build:configure [-p android|ios|all]

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

DESCRIPTION
  Configure the project to support EAS Build.

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

eas build:inspect

Inspect the state of the project at specific build stages. Useful for troubleshooting.

USAGE
  $ eas build:inspect -p android|ios -s archive|pre-build|post-build --output <value> [--profile <value>] [--force]
    [--verbose]

FLAGS
  -p, --platform=(android|ios)
      (required)

  -s, --stage=(archive|pre-build|post-build)
      (required) Stage of the build you want to inspect.
      archive - builds the project archive that would be uploaded to EAS when building
      pre-build - prepares the project to be built with Gradle/Xcode. Does not run the native build.
      post-build - builds the native project and leaves the output directory for inspection

  --force
      Delete OUTPUT_DIRECTORY if it already exists.

  --output=OUTPUT_DIRECTORY
      (required) Output directory.

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

  --verbose

DESCRIPTION
  Inspect the state of the project at specific build stages. Useful for troubleshooting.

See code: src/commands/build/inspect.ts

eas build:list

list all builds for your project

USAGE
  $ eas build:list [--platform all|android|ios] [--json] [--status
    new|in-queue|in-progress|errored|finished|canceled] [--distribution store|internal|simulator] [--channel <value>]
    [--appVersion <value>] [--appBuildVersion <value>] [--sdkVersion <value>] [--runtimeVersion <value>]
    [--appIdentifier <value>] [--buildProfile <value>] [--gitCommitHash <value>] [--limit <value>]

FLAGS
  --appBuildVersion=<value>
  --appIdentifier=<value>
  --appVersion=<value>
  --buildProfile=<value>
  --channel=<value>
  --distribution=(store|internal|simulator)
  --gitCommitHash=<value>
  --json                                                         Enable JSON output, non-JSON messages will be printed
                                                                 to stderr
  --limit=<value>
  --platform=(all|android|ios)
  --runtimeVersion=<value>
  --sdkVersion=<value>
  --status=(new|in-queue|in-progress|errored|finished|canceled)

DESCRIPTION
  list all builds for your project

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

eas build:view [BUILD_ID]

view a build for your project

USAGE
  $ eas build:view [BUILD_ID] [--json]

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

DESCRIPTION
  view a build for your project

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

eas channel:create [NAME]

Create a channel on the current project.

USAGE
  $ eas channel:create [NAME] [--json]

ARGUMENTS
  NAME  Name of the channel to create

FLAGS
  --json  print output as a JSON object with the new channel ID, name and branch mapping.

DESCRIPTION
  Create a channel on the current project.

See code: src/commands/channel/create.ts

eas channel:edit [NAME]

Point a channel at a new branch.

USAGE
  $ eas channel:edit [NAME] [--branch <value>] [--json]

ARGUMENTS
  NAME  Name of the channel to edit

FLAGS
  --branch=<value>  Name of the branch to point to
  --json            print output as a JSON object with the channel ID, name and branch mapping.

DESCRIPTION
  Point a channel at a new branch.

See code: src/commands/channel/edit.ts

eas channel:list

List all channels on the current project.

USAGE
  $ eas channel:list [--json]

FLAGS
  --json  print output as a JSON object with the channel ID, name and branch mapping.

DESCRIPTION
  List all channels on the current project.

See code: src/commands/channel/list.ts

eas channel:view [NAME]

View a channel on the current project.

USAGE
  $ eas channel:view [NAME] [--json]

ARGUMENTS
  NAME  Name of the channel to view

FLAGS
  --json  print output as a JSON object with the channel ID, name and branch mapping.

DESCRIPTION
  View a channel on the current project.

See code: src/commands/channel/view.ts

eas config

show the eas.json config

USAGE
  $ eas config [-p android|ios] [--profile <value>]

FLAGS
  -p, --platform=(android|ios)
  --profile=<value>

DESCRIPTION
  show the eas.json config

See code: src/commands/config.ts

eas credentials

manage your credentials

USAGE
  $ eas credentials

DESCRIPTION
  manage your credentials

See code: src/commands/credentials.ts

eas device:create

register new Apple Devices to use for internal distribution

USAGE
  $ eas device:create

DESCRIPTION
  register new Apple Devices to use for internal distribution

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

eas device:list

list all registered devices for your account

USAGE
  $ eas device:list [--apple-team-id <value>]

FLAGS
  --apple-team-id=<value>

DESCRIPTION
  list all registered devices for your account

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

eas device:view [UDID]

view a device for your project

USAGE
  $ eas device:view [UDID]

DESCRIPTION
  view a device for your project

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

eas diagnostics

log environment info to the console

USAGE
  $ eas diagnostics

DESCRIPTION
  log environment info to the console

See code: src/commands/diagnostics.ts

eas help [COMMAND]

Display help for eas.

USAGE
  $ eas help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for eas.

See code: @oclif/plugin-help

eas project:info

information about the current project

USAGE
  $ eas project:info

DESCRIPTION
  information about the current project

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

eas project:init

create or link an EAS project

USAGE
  $ eas project:init

DESCRIPTION
  create or link an EAS project

ALIASES
  $ eas init

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

eas secret:create

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

USAGE
  $ eas secret:create [--scope account|project] [--name <value>] [--value <value>] [--force]

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

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

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

eas secret:delete

Delete an environment secret by ID.

USAGE
  $ eas secret:delete [--id <value>]

FLAGS
  --id=<value>  ID of the secret to delete

DESCRIPTION
  Delete an environment secret by ID.

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

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

eas secret:list

Lists environment secrets available for your current app

USAGE
  $ eas secret:list

DESCRIPTION
  Lists environment secrets available for your current app

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

eas submit

Submit build archive to App Store Connect

USAGE
  $ eas submit [-p android|ios|all] [--profile <value>] [--latest | --id <value> | --path <value> | --url
    <value>] [--verbose] [--wait] [--non-interactive]

FLAGS
  -p, --platform=(android|ios|all)
  --id=<value>                      ID of the build to submit
  --latest                          Submit the latest build for specified platform
  --non-interactive                 Run command in non-interactive mode
  --path=<value>                    Path to the .apk/.aab/.ipa file
  --profile=<value>                 Name of the submit profile from eas.json. Defaults to "production" if defined in
                                    eas.json.
  --url=<value>                     App archive url
  --verbose                         Always print logs from Submission Service
  --[no-]wait                       Wait for submission to complete

DESCRIPTION
  Submit build archive to App Store Connect

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

ALIASES
  $ eas build:submit

See code: src/commands/submit.ts

eas update

Publish an update group.

USAGE
  $ eas update [--branch <value>] [--message <value>] [--republish | --input-dir <value> | --skip-bundler]
    [--group <value> |  | ] [-p android|ios|all] [--json] [--auto]

FLAGS
  -p, --platform=(android|ios|all)  [default: all]
  --auto                            Use the current git branch and commit message for the EAS branch and update message
  --branch=<value>                  Branch to publish the update group on
  --group=<value>                   Update group to republish
  --input-dir=<value>               [default: dist] Location of the bundle
  --json                            Enable JSON output, non-JSON messages will be printed to stderr
  --message=<value>                 A short message describing the update
  --republish                       Republish an update group
  --skip-bundler                    Skip running Expo CLI to bundle the app before publishing

DESCRIPTION
  Publish an update group.

See code: src/commands/update/index.ts

eas update:configure

Configure the project to support EAS Update.

USAGE
  $ eas update:configure

DESCRIPTION
  Configure the project to support EAS Update.

See code: src/commands/update/configure.ts

eas update:delete GROUPID

Delete all the updates in an update Group.

USAGE
  $ eas update:delete [GROUPID] [--json]

ARGUMENTS
  GROUPID  The ID of an update group to delete.

FLAGS
  --json  Return a json with the group ID of the deleted updates.

DESCRIPTION
  Delete all the updates in an update Group.

See code: src/commands/update/delete.ts

eas update:view GROUPID

Update group details.

USAGE
  $ eas update:view [GROUPID] [--json]

ARGUMENTS
  GROUPID  The ID of an update group.

FLAGS
  --json  Return a json with the updates belonging to the group.

DESCRIPTION
  Update group details.

See code: src/commands/update/view.ts

eas webhook:create

Create a webhook on the current project.

USAGE
  $ eas webhook:create [--event BUILD|SUBMIT] [--url <value>] [--secret <value>]

FLAGS
  --event=(BUILD|SUBMIT)  Event type that triggers the webhook
  --secret=<value>        Secret used to create a hash signature of the request payload, provided in the
                          'Expo-Signature' header.
  --url=<value>           Webhook URL

DESCRIPTION
  Create a webhook on the current project.

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

eas webhook:delete [ID]

Delete a webhook on the current project.

USAGE
  $ eas webhook:delete [ID]

ARGUMENTS
  ID  ID of the webhook to delete

DESCRIPTION
  Delete a webhook on the current project.

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

eas webhook:list

List webhooks on the current project.

USAGE
  $ eas webhook:list [--event BUILD|SUBMIT]

FLAGS
  --event=(BUILD|SUBMIT)  Event type that triggers the webhook

DESCRIPTION
  List webhooks on the current project.

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

eas webhook:update

Create a webhook on the current project.

USAGE
  $ eas webhook:update --id <value> [--event BUILD|SUBMIT] [--url <value>] [--secret <value>]

FLAGS
  --event=(BUILD|SUBMIT)  Event type that triggers the webhook
  --id=<value>            (required) Webhook ID
  --secret=<value>        Secret used to create a hash signature of the request payload, provided in the
                          'Expo-Signature' header.
  --url=<value>           Webhook URL

DESCRIPTION
  Create a webhook on the current project.

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

eas webhook:view ID

View a webhook on the current project.

USAGE
  $ eas webhook:view [ID]

ARGUMENTS
  ID  ID of the webhook to view

DESCRIPTION
  View a webhook on the current project.

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

Changelog

0.42.3 - 2021-12-21

🐛 Bug fixes

• Allow select eas commands to be run outside of a project. (#851 by @jkhales)

🧹 Chores

• Replace all oclif dependencies with @oclif/core. (#858 by @dsokal)