--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
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.
gmsaas recipes list
Default output: recipes list formatted as a table
# Start an instance
Time out will not apply to instances launched with this command (see Administration interface - Settings). To avoid extra charges, the instance must be stopped from the Web user interface or using the stop command.
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.
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.
$ gmsaas instances start b9cf7b2c-4d11-4777-97c7-29d3b5c68d59 test 62ec330e-47d2-4a6b-939f-122718505329
# List running instances
gmsaas instances [--quiet/-q] list
Default output: running instances list formatted as a table. This also provides the ADB serial used if the instance is connected to ADB. If
--quietis 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
<adb_serial>on which ADB is connected is printed. 1.5.0+
$ gmsaas instances adbconnect ab47b279-05ef-4496-9e45-bc6af0085122 localhost:40249
# Stop an instance
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.
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.
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
Default output: Nothing printed