Commands

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

• JSON output:

$ gmsaas --format json recipes list
{
    "recipes": [
        {
            "uuid": "b1e51193-4db8-43f7-b7cd-ae35eebb6bca",
            "name": "Custom Phone",
            "android_version": "4.4.4",
            "screen_width": 768,
            "screen_height": 1280,
            "screen_density": 320,
            "screen": "768 x 1280 dpi 320",
            "source": "genymotion"
        },
        ...
    ],
    "exit_code": 0,
    "exit_code_desc": "NO_ERROR"
}

Start an instance

Warning

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.

Important

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.

• Default output: <instance_uuid> is printed

  $ gmsaas instances start b9cf7b2c-4d11-4777-97c7-29d3b5c68d59 test
  62ec330e-47d2-4a6b-939f-122718505329
  

• JSON output:

$ gmsaas --format json instances start b9cf7b2c-4d11-4777-97c7-29d3b5c68d59 test
{
    "instance": {
        "uuid": "62ec330e-47d2-4a6b-939f-122718505329",
        "name": "test",
        "state": "ONLINE",
        "adbtunnel_state": "DISCONNECTED",
        "adb_serial": "0.0.0.0",
        "adb_serial_port": 0,
        "recipe": {
            "uuid": "b9cf7b2c-4d11-4777-97c7-29d3b5c68d59"
        }
    },
    "exit_code": 0,
    "exit_code_desc": "NO_ERROR"
}

$ gmsaas --format json instances start b9cf7b2c-4d11-4777-97c7-29d3b5c68d59 test
{
    "instance": {
        "uuid": "62ec330e-47d2-4a6b-939f-122718505329",
        "name": "test",
        "state": "ONLINE",
        "adbtunnel_state": "DISCONNECTED",
        "adb_serial": "0.0.0.0",
        "adb_serial_port": 0
    },
    "exit_code": 0,
    "exit_code_desc": "NO_ERROR"
}

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 --quiet is set, only instance UUIDs will be displayed.

• JSON output:

$ gmsaas --format json instances list
{
    "instances": [
        {
            "uuid": "5a4d74e6-e6b2-4dd3-8d6c-1eea275b5ea7",
            "name": "test1",
            "state": "ONLINE",
            "adbtunnel_state": "CONNECTED",
            "adb_serial": "localhost:39745",
            "adb_serial_port": 39745,
            "recipe": {
                "uuid": "b9cf7b2c-4d11-4777-97c7-29d3b5c68d59"
            }
        },
        {
            "uuid": "ab47b279-05ef-4896-9e45-bc6af0085022",
            "name": "test2",
            "state": "ONLINE",
            "adbtunnel_state": "CONNECTED",
            "adb_serial": "localhost:33455",
            "adb_serial_port": 33455,
            "recipe": {
                "uuid": "b9cf7b2c-4d11-4777-97c7-29d3b5c68d59"
            }
        },
        {
            "uuid": "099bd927-a0b9-4ff0-b4bc-d474175945b7",
            "name": "test3",
            "state": "ONLINE",
            "adbtunnel_state": "DISCONNECTED",
            "adb_serial": "0.0.0.0",
            "adb_serial_port": 0,
            "recipe": {
                "uuid": "b9cf7b2c-4d11-4777-97c7-29d3b5c68d59"
            }
        },
        ...
    ],
    "exit_code": 0,
    "exit_code_desc": "NO_ERROR"
}

$ gmsaas --format json instances list
{
    "instances": [
        {
            "uuid": "5a4d74e6-e6b2-4dd3-8d6c-1eea275b5ea7",
            "name": "test1",
            "state": "ONLINE",
            "adbtunnel_state": "CONNECTED",
            "adb_serial": "localhost:39745",
            "adb_serial_port": 39745
        },
        {
            "uuid": "ab47b279-05ef-4896-9e45-bc6af0085022",
            "name": "test2",
            "state": "ONLINE",
            "adbtunnel_state": "CONNECTED",
            "adb_serial": "localhost:33455",
            "adb_serial_port": 33455
        },
        {
            "uuid": "099bd927-a0b9-4ff0-b4bc-d474175945b7",
            "name": "test3",
            "state": "ONLINE",
            "adbtunnel_state": "DISCONNECTED",
            "adb_serial": "0.0.0.0",
            "adb_serial_port": 0
        },
        ...
    ],
    "exit_code": 0,
    "exit_code_desc": "NO_ERROR"
}

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.
If the --adb-serial-port <PORT> option is set, the instance will be connected to ADB on localhost:<PORT>.

Note

To easily connect all your running instances to ADB, you can combine this command with the --quiet or -q option and xargs.
For example:

gmsaas instances list -q | xargs -n1 gmsaas instances adbconnect

• Default output: <adb_serial> on which ADB is connected is printed. Since 1.5.0

  $ gmsaas instances adbconnect ab47b279-05ef-4496-9e45-bc6af0085122
  localhost:40249
  

• JSON output:

$ gmsaas --format json instances adbconnect 099bd927-a0b9-4ff0-b4bc-d474175945b7
{
    "instance": {
        "uuid": "099bd927-a0b9-4ff0-b4bc-d474175945b7",
        "name": "test3",
        "state": "ONLINE",
        "adbtunnel_state": "CONNECTED",
        "adb_serial": "localhost:37007",
        "adb_serial_port": 37007,
        "recipe": {
            "uuid": "b9cf7b2c-4d11-4777-97c7-29d3b5c68d59"
        }
    },
    "exit_code": 0,
    "exit_code_desc": "NO_ERROR"
}

$ gmsaas --format json instances adbconnect 099bd927-a0b9-4ff0-b4bc-d474175945b7
{
    "instance": {
        "uuid": "099bd927-a0b9-4ff0-b4bc-d474175945b7",
        "name": "test3",
        "state": "ONLINE",
        "adbtunnel_state": "CONNECTED",
        "adb_serial": "localhost:37007",
        "adb_serial_port": 37007
    },
    "exit_code": 0,
    "exit_code_desc": "NO_ERROR"
}

Stop an instance

Warning

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.

Note

To easily stop all your running instances, you can combine this command with --quiet or -q option and xargs. For example:

gmsaas instances list -q | xargs -n1 gmsaas instances stop --no-wait

• Default output: Nothing printed

• JSON output:

$ gmsaas --format json instances stop 62ec330e-47d2-4a6b-939f-222318505329
{
    "instance": {
        "uuid": "62ec330e-47d2-4a6b-939f-222318505329",
        "name": "test4",
        "state": "DELETED",
        "adbtunnel_state": "DISCONNECTED",
        "adb_serial": "0.0.0.0",
        "adb_serial_port": 0,
        "recipe": {
            "uuid": "b9cf7b2c-4d11-4777-97c7-29d3b5c68d59"
        }
    },
    "exit_code": 0,
    "exit_code_desc": "NO_ERROR"
}

$ gmsaas --format json instances stop 62ec330e-47d2-4a6b-939f-222318505329
{
    "instance": {
        "uuid": "62ec330e-47d2-4a6b-939f-222318505329",
        "name": "test4",
        "state": "DELETED",
        "adbtunnel_state": "DISCONNECTED",
        "adb_serial": "0.0.0.0",
        "adb_serial_port": 0
    },
    "exit_code": 0,
    "exit_code_desc": "NO_ERROR"
}