# gmsaas command line tool
gmsaas is a command line interface for Genymotion Cloud SaaS.
- Android SDK
pip3 install gmsaas
Two steps are required to use
Configure the path to your Android SDK:
gmsaas config set android-sdk-path <sdk_path>
gmsaas auth login <email>
--help option is suitable for every
gmsaas commands. It will provide you with all the supported commands, sub-commands, options, and a quick explanation of what those do.
# List recipes
gmsaas recipes list
A recipe is a template with a given Android version, display size, density and specifications (CPU, memory, storage) which generally match those of a real device.
# Start an instance
gmsaas instances start [--no-wait] <recipe_uuid> <name>
Creates and start an instance based on the specified
<recipe_uuid> recipe (cf. previous section).
<name> is the name you wish to give to the instance. The command returns to shell once the instance is started, unless the
--no-wait option has been set. In both cases the
<instance_uuid> is printed on standard output.
Please note that you need to use the
<instance_uuid> to refer to an instance when issuing commands via gmsaas.
<name> is only use as a tag for convenience.
# List running instances
gmsaas instances [--quiet/-q] list
Lists all running instances. This also provides the ADB serial used if the instance is connected to ADB.
--quiet is set, only instance UUIDs will be displayed.
# Connect an instance to ADB
gmsaas instances adbconnect [--adb-serial-port PORT] <instance_uuid>
Connects a running instance to ADB. The command returns to shell once ADB is connected.
--adb-serial-port <PORT> option is set, the instance will be connected to ADB on
To easily connect all your running instances to ADB, you can combine this command with the
-q option and
gmsaas instances list -q | xargs -n1 gmsaas instances adbconnect
# Stop an instance
gmsaas instances stop [--no-wait] <instance_uuid>
Stops the specified instance. The command returns to shell once the instance is fully stopped, unless the
--no-wait option is set.
Instances launched with gmsaas will not stop until this command is issued, or it is stopped from the Web user interface. If you forget to do so, your credit will be deducted as long as the instance is running and you may get extra charges.
To easily stop all your running instances, you can combine this command with
-q option and
gmsaas instances list -q | xargs -n1 gmsaas instances stop --no-wait
# 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
eval "$(_GMSAAS_COMPLETE=source gmsaas)"
For Zsh, add this to your
eval "$(_GMSAAS_COMPLETE=source_zsh gmsaas)"
You must type at least one dash to complete command-line options.
Whatever your problem is, the Support Team will need logs to speed up the investigations. To generate them:
- Reproduce your issue
gmsaas logzip: an archive named
gmsaas-logs-YYYYMMDD-HHMMSS.zipwill be created in the current directory
- Contact us here, don't forget to attach the logs archive