Command line interface for Genymotion Cloud SaaS
Project description
gmsaas
Description
gmsaas
is a command line interface for Genymotion Cloud SaaS.
Requirements
- Python 3.5 or above
- pip3
- Android SDK
Installation
pip3 install gmsaas
Configuration
Prerequisites
Two steps are required to use gmsaas
properly:
-
Configure the path to your Android SDK with:
gmsaas config set android-sdk-path <sdk_path>
-
Authenticate with:
gmsaas auth login <email>
Proxy
If you are behind a corporate proxy, gmsaas
may not be able to access the Internet with its default settings.
HTTP/HTTPS proxy settings can be configured via gmsaas config
command.
gmsaas config set proxy http[s]://host:port
For an authenticated proxy, credentials can be passed in the URL:
gmsaas config set proxy http[s]://user:password@host: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
Note: Only HTTP/HTTPS proxies are supported.
Features
List recipes
gmsaas recipes list
Lists recipes that can be started with gmsaas instances start
.
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. Recipe UUID is the identifier used when starting an instance.
Start an instance
gmsaas instances start <recipe_uuid> <name> [--no-wait]
Creates and starts an instance <name>
based on the specified <recipe_uuid>
recipe. The command returns once the instance is started, unless the --no-wait
option has been set. In both cases the instance UUID is printed on standard output.
Connect an instance to ADB
gmsaas instances adbconnect <instance_uuid> [--adb-serial-port PORT]
Connects the instance <instance_uuid>
to ADB. The command returns once ADB is connected. If the --adb-serial-port <PORT>
option is set, the instance will be connected to ADB on localhost:<PORT>
.
List running instances
gmsaas instances list [--quiet/-q]
Lists running instances. This also provides the ADB serial used if the instance is connected to ADB. If --quiet
is set, only instance UUIDs will be displayed.
Stop an instance
gmsaas instances stop <instance_uuid> [--no-wait]
Stops the specified instance. The command returns once the instance is fully stopped, unless the --no-wait
option has been set.
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)"
Note: you must type at least one dash to complete command-line options.
Issues
Whatever your problem is, the Support Team will need logs to speed up the investigations. To generate them:
- Reproduce your issue
- Run
gmsaas logzip
: an archive namedgmsaas-logs-YYYYMMDD-HHMMSS.zip
will be created in the current directory - Contact us here, don't forget to attach the logs archive
Change Log
All notable changes of gmsaas
are documented in this file.
1.3.2
Fixed
- Fix
gmsaas
behavior when configuration and system proxy are both set: system proxy no longer interferes
1.3.1
Fixed
- Fix assertion when gmsaas is upgraded while an older ADB Tunnel is running
- Improve Socket.IO connection stability
1.3.0
Added
- HTTP/HTTPS proxy support with
gmsaas config set proxy
command --verbose/-v
global option to print logs to standard output
Changed
- Improve wording of error messages
- Improve password cyphering
Fixed
- Make ADB Tunnel more resilient: continue running when terminal is closed
1.2.0
Added
--quiet/-q
option togmsaas instances list
command to print instance UUIDs only
1.1.0
Added
gmsaas logzip
command to fetch all logs in one ZIP archive
Changed
- Improve
gmsaas auth login
output in case of failure
1.0.0 (initial release)
Added
- List device recipes available
- List running devices
- Start a device based on one recipe
- Stop a running device
- Connect a running device to ADB
- Disconnect a running device from ADB
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for gmsaas-1.3.2-py3-none-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28350be1f769ad9c174ce7fc7a841de972b570b929f149434c16e7de666b9263 |
|
MD5 | 509f25537d776ad6c66abeffc034210b |
|
BLAKE2b-256 | 8d2f8f6a7ae1888a1b932206e32c6656743426f4b0620260d752e8a897f497fc |
Hashes for gmsaas-1.3.2-py3-none-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e82fb454e2b79e0cda9d2ca44ee40eab2f41661c2b61edef85bcdd17c066a4e0 |
|
MD5 | 7ab921e9ebe10a8e1d6de5c01f8f07a0 |
|
BLAKE2b-256 | ac18412523e56d3788c9c5092d757cc1e864a15d366421f0f09a53fbcd4e0fe5 |
Hashes for gmsaas-1.3.2-py3-none-macosx_10_11_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f4f7af6ced2af705ab500166953178483ccc7b15578faeaaaf74a9b0a333064 |
|
MD5 | 64ae93ac73711937fedaf0ac77138350 |
|
BLAKE2b-256 | d696f340a2ef8f4b232a8a520edf435634f6f81c6248bbc53aa113591f25202d |