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.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.0-py3-none-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ca27abbf802592b5ac919d1dad8361120ac0ef62c0cc435fd708df20e2a4427 |
|
MD5 | 48d5ea5ba9896d522331b008afd71adb |
|
BLAKE2b-256 | ede5e557fa621f92e4d18183e8d17f8ffc3aa1c05c1b9ed867b911f9b46f335a |
Hashes for gmsaas-1.3.0-py3-none-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0635024998bdbd20be05391914f030a7e6665c95c9ffa58321abbb38cefe9d2 |
|
MD5 | 75a9d799ebe82c39d96c2b4fe4ea107f |
|
BLAKE2b-256 | 91cfe52809bc4610aa5bd95f7d39d92faf2cdaa1741558ed1a4197b37183d81b |
Hashes for gmsaas-1.3.0-py3-none-macosx_10_11_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 763d1de4e534771ec215f6a3cf071fedbb7d7e6507b67cded8f4d691bfcd681c |
|
MD5 | 9dbad30d1de90685306fc114636e3e06 |
|
BLAKE2b-256 | 6eb62131b3382d7249c82af364e61d591468a21dc2829eabfef997f53de75716 |