Skip to content
ESB Docs

Emulator Automation CLI User Guide

Last updated 2 min read

On this page

Introduction

This guide will show you how to run the Emulator Automation CLI with just a few simple commands from the command line. No additional setup is needed beyond having the executable file and your login credentials.

Requirements

  • Windows PC
  • Emulator Automation CLI version 3.0.87 or greater
  • Valid username and password with a current subscription

Basic Usage

First, open the Command Prompt and navigate to the folder where Emulator Automation is installed. For example, if the installation folder is C:\EmulatorAutomation, you would use the following command:

cd C:\EmulatorAutomation

Once you are in the installation folder, you can run the Emulator Automation CLI.

2. Run the CLI Command

The Emulator Automation CLI offers several options. For each option, the username and password are the main required parameters. Here are the available options:

  • List the Available Profiles:

    Use this command to list all the profiles associated with your account:

    .\EmulatorAutomationCli.exe --username your_username --password your_password --listprofiles

  • List the Devices within a Profile:

    Use this command to list all the devices within a specified profile:

    .\EmulatorAutomationCli.exe --username your_username --password your_password --profile your_tab_profile_name --list-devices

  • Run the Application and Load a Specified Profile:

    This command logs into the application, loads your device profile, and automatically starts the devices:

    .\EmulatorAutomationCli.exe --username your_username --password your_password --profile your_tab_profile_name

  • Run the Application without a UI:

    To run the application without a graphical user interface (UI), saving system resources:

    .\EmulatorAutomationCli.exe --username your_username --password your_password --profile your_tab_profile_name --headless

    This will load the specified profile and start the devices automatically in the background.

3. All Supported Arguments

  • -h, --help: Show the help message and exit.
  • --username USERNAME: The username to use for login.
  • --password PASSWORD: The password to use for login.
  • --profile PROFILE: The profile to load.
  • --list-devices: List the devices within the specified profile and exit.
  • --headless: Run the application without a UI.
  • --list-profiles: List the available profiles and exit.

Error Codes

  • Exit Code 1: Indicates an error with your username, password, or profile. Double-check your inputs and try again.

Example Command

Here’s an example of how the command might look if your username is john_doe, your password is password123, and your profile is MyProfile:

.\EmulatorAutomationCli.exe --username john_doe --password password123 --profile MyProfile

Conclusion

With this guide, you should be able to easily run the Emulator Automation CLI without any complex setup. Just ensure you have your credentials and the correct profile name, and you’re ready to go!