gmsaas Command Line Interface

gmsaas is a command line interface to rule all your virtual devices hosted in Genymotion SaaS without opening an Internet browser. It allows to manage Android instances (create, list, start, save, stop etc). It securely connects instances to Android Debug Bridge. It is a lightweight binary, easy to install, easy to update. Badges are used to indicate that a specific feature is available since a specific gmsaas version. For example, means that the feature is available from gmsaas ver. 1.8.0 onwards.

Requirements

Python 3.8+
pip3 20.9+
Android SDK (platform-tools)

Supported operating system

Windows 10/11 x86_64
macOS 11 (Big Sur) or higher
Linux x86/x86_64: Ubuntu 20.04 or higher
Linux arm64: Ubuntu 24.04 or higher

Linux x86

Most x86/x86_64 Linux distributions having GLIBC 2.31 or above will work. Tested on: Ubuntu 20.04 / 22.04 / 24.04; Fedora 32 / 42; Debian 11 / 13

Linux arm64

Most arm64 Linux distributions having GLIBC 2.39 or above will work. Tested on: Ubuntu 24.04; Fedora 40 / 42; Debian 13

Installation

pip3 install [--user] gmsaas

Wait, I get: externally-managed-environment

It means you're using a Python interpreter managed by your system. This type of environment restrict direct install using pip3 to protect the system's dependencies.

To resolve this, you have several options: 1. Use a virtual Python environment (recommended), you can follow this tutorial. 2. Use pip3 install [--user] gmsaas --break-system-packages if you're aware of the consequences (not recommended). 3. Using pip3 with elevated privileges (strongly discouraged).

pip3 install [--user] --upgrade gmsaas

To benefit from ARM64 images, you need to use gmsaas 1.12.0 or above.

If you're using Python 3.12, you need to use gmsaas 1.11.0 or above.

Uninstallation

pip3 uninstall gmsaas

Local files

Remove the following directories to purge gmsaas:

Windows: %LOCALAPPDATA%\Genymobile\gmsaas
Linux: ~/.Genymobile/gmsaas and ~/.gmsaas.tmp
macOS: ~/.Genymobile/gmsaas

Get notified when a new version is out

You can add the RSS feed https://pypi.org/rss/project/gmsaas/releases.xml to your favorite RSS feed reader or to your corporate communication solution (Slack, Microsoft Teams, Discord and so on). There is no other communication than new gmsaas releases.

Configuration

Prerequisites

Two steps are required to use gmsaas properly:

1. Configure the path to your Android SDK:

gmsaas config set android-sdk-path <sdk_path>

<sdk_path> should point to the Android SDK installation directory, similar to the ANDROID_SDK_ROOT or deprecated ANDROID_HOME environment variables.

2. Authenticate: a. Create an API Token here and copy it to your clipboard. b. Then, to use it with gmsaas, you can either run the following command in a terminal:

gmsaas auth token <token>

or you can store the API Token in the environment variable GENYMOTION_API_TOKEN.

Using credentials to authenticate gmsaas has been deprecated since version 1.10.0.

If you have existing automated tests, please consider using an API Token instead of the tuple email / password for security reasons.

gmsaas auth token should be used in place of gmsaas auth login command.
gmsaas auth reset should be used in place of gmsaas auth logout command.

While these deprecated commands are still working with gmsaas 1.10.0, they are subject to removal in future releases.

For Bash, add this to your .bashrc:

eval "$(_GMSAAS_COMPLETE=source gmsaas)"

For Zsh, add this to your .zshrc:

eval "$(_GMSAAS_COMPLETE=source_zsh gmsaas)"

You must type at least one dash to complete command-line options.

---