# Get started

# Requirements

  • Python
  • pip3
  • Android SDK

# Installation

pip3 install gmsaas

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


    Relative paths are not supported, it is necessary to use absolute paths.
    For example: sdktools/ or ./sdktools will not work, but ~/sdktools or /home/user/sdktools is OK.

  2. Authenticate with:

    gmsaas auth login <email>

# Proxy Since 1.3.0

If you are behind a corporate proxy, gmsaas may not be able to access the Internet with its default settings.

HTTP/HTTPS and SOCKS5 Since 1.4.0 proxy settings can be configured via gmsaas config command.

gmsaas config set proxy (http[s]|socks5)://host:port

For an authenticated proxy, credentials can be passed in the URL:

gmsaas config set proxy (http[s]|socks5)://user:[email protected]:port

Alternatively, to avoid having the proxy credentials stored in gmsaas configuration file, you can set the credentials using environment variables:

GMSAAS_PROXY_USERNAME: the username used to connect to the proxy
GMSAAS_PROXY_PASSWORD: the password of given user

# Bash/Zsh auto-completion

gmsaas supports Bash and Zsh auto-completion. To activate it, you need to inform your shell that completion is available.

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.