We use cookies to enhance user experience, analyze site usage, and assist in our marketing efforts. By continuing to browse or closing this banner, you acknowledge that you have read and agree to our Cookie Policy, Privacy Policy and Terms of Service.

Browserstack logo
  • Live for Teams
  • Pricing
    • Test your websites
    • Live
      Interactive cross browser testing
    • Automate
      Selenium testing at scale
    • Percy
      Visual testing & review
    • Test your mobile apps
    • App Live
      Interactive mobile app testing
    • App Automate
      Test automation for mobile apps
    • App Percy
      Visual testing for mobile apps
    • Test management & optimization
    • Test Observability
      Centralized & faster debugging
    • Test development
    • Nightwatch.js
      End-to-End testing framework

    Use BrowserStack with your favourite products. See our Integrations ⟶

    • For Teams
    • Enterprise
    • Tools
    • Screenshots
    • Responsive
    • SpeedLab
    • Documentation
    • Support
    • Status
    • Release Notes
    • Open Source
    • Events
    • Champions
  • Live for Teams
  • Pricing
  • Sign in
  • Free Trial
  • Test your websites
  • Live
    Interactive cross browser testing
  • Automate
    Selenium testing at scale
  • Percy
    Visual testing & review
  • Test your mobile apps
  • App Live
    Interactive mobile app testing
  • App Automate
    Test automation for mobile apps
  • App Percy
    Visual testing for mobile apps
  • Test management & optimization
  • Test Observability
    Centralized & faster debugging
  • Test development
  • Nightwatch.js
    End-to-End testing framework
  • For Teams
  • Enterprise
  • Tools
  • Screenshots
  • Responsive
  • SpeedLab
  • Documentation
  • Support
  • Status
  • Release Notes
  • Open Source
  • Events
  • Champions
  • Get help
  • Documentation
  • Appium
  • Espresso
  • XCUITest
  • EarlGrey
  • Test dev environments
  • Speed up your test suite
  • References
  • Features
  • Browsers & Devices
  • Emulator vs Real Device
  • Simulator vs Real Device
  • Security
  • Debugging
  • Device Features
  • Status
Home Documentation App Automate Browserstack Cli

CLI - App Automate (Beta)

The CLI provides a set of simple commands to upload apps, manage your test executions and much more. This guide will help you setup and use BrowserStack CLI for your automated mobile app testing.

Introduction

BrowserStack App Automate allows you to manage your app testing on our cloud-based infrastructure by providing full integration with the command-line interface (CLI). Follow the steps below to setup BrowserStack CLI on your machine:

  1. Download the BrowserStack binary for CLI:
    • OS X 32-bit (10.7 and above)
    • OS X 64-bit (10.7 and above)
    • Linux 32-bit
    • Linux 64-bit
    • Windows 32-bit (XP and above)
    • Windows 64-bit (XP and above)
  2. Open your terminal and navigate to the folder containing the BrowserStack CLI binary.
  3. Make the BrowserStack CLI executable by running the following command:
    • For MAC and Linux machines:
    • chmod +x browserstack

Getting Started

Give your users a seamless experience by testing on 3000+ real devices. To get started, run the command below to explore the list of available options.

USAGE

$ ./browserstack [commands] [flags]

COMMANDS

app-automate    Automated mobile app testing on Real Mobile devices
authenticate    Set/Update your BrowserStack credentials
help            Help about any command
update          Update browserstack-cli to the latest version
version         Print the version number of BrowserStack CLI

FLAGS

    --config  Config file for your tests. Default: $HOME/.browserstack-cli.yaml
-h, --help    help for browserstack

To know more about any specific command, use the help flag as shown below

./browserstack [command] --help

Authenticate

Before you can upload an app or manage your test executions, you first need to authenticate yourself with your BrowserStack username and access-key. You can view your credentials on App Automate dashboard or Account Summary page

USAGE

$ ./browserstack authenticate [flags]

FLAGS

--username    To identify you as a unique user on BrowserStack account. You can fetch the info from https://www.browserstack.com/accounts/settings
--access-key  Private BrowserStack key associated with your account. You can fetch the info from https://www.browserstack.com/accounts/settings
-h, --help    Help for authenticate

EXAMPLE

./browserstack authenticate --username=your_username --access-key=your_access_key

Once authenticated, you can explore CLI for App Automate using the command below :

./browserstack app-automate
apps         Manage your uploaded mobile apps on BrowserStack
testsuite    Manage your TestSuite for different Frameworks (Espresso/XCUITest/EarlGrey)
espresso     Run your Espresso mobile app tests
xcuitest     Run your XCUITest mobile app tests
appium       View and manage your appium tests executed on BrowserStack real devices.
plan-status  Get plan details - Number of parallels allowed, currently running and queued
devices      List of all Devices available for Testing

In This Article

  • Introduction
  • Getting Started
  • Authenticate
Related Articles

Capabilities

Local Testing

Rest API

Jenkins

Products

  • Live
  • Automate
  • Percy
  • App Live
  • App Automate
  • App Percy New
  • Test Observability New
  • Nightwatch
  • Enterprise

Tools

  • SpeedLab
  • Screenshots
  • Responsive

Platform

  • Browsers & Devices
  • Data Centers
  • Device Features
  • Security

Solutions

  • Test on iPhone
  • Test on iPad
  • Test on Galaxy
  • Test In IE
  • Android Testing
  • iOS Testing
  • Cross Browser Testing
  • Emulators & Simulators
  • Selenium
  • Cypress
  • Android Emulators
  • Visual Testing

Resources

  • Test on Right Devices
  • Support
  • Status
  • Release Notes
  • Case Studies
  • Blog
  • Events
  • Test UniversityBeta
  • Champions
  • Mobile Emulators
  • Guide
  • Responsive Design

Company

  • About Us
  • Customers
  • Careers We're hiring!
  • Open Source
  • Partners
  • Press
BrowserStack Logo An illustrated of BrowserStack Logo

Social

  • BrowserStack Twitter Account An illustrated of white twitter Logo
  • BrowserStack FaceBook Account An illustrated of white FaceBook Logo
  • BrowserStack LinkedIn Account An illustrated of white LinkedIn Logo
  • BrowserStack Youtube Channel An illustrated of white youtube Logo
  • BrowserStack Instagram Account An illustrated of white instagram Logo
BrowserStack Contact Us Icon An illustration of white contact us icon Contact Us

© 2023 BrowserStack. All rights reserved.

  • Terms of Service
  • Privacy Policy
  • Cookie Policy
  • Sitemap