Skip to main content

EcHome CLI

Project description

ecHome CLI

This CLI is for use with interacting with the ecHome virtual machine manager.

The CLI allows for managing aspects of ecHome with commands. The CLI uses the ecHome Python SDK and is responsible for starting and authenticating user sessions, making the calls to the API, returning raw JSON responses, and in the future, objects based on the services.


This library works by using config/credentials in the user's home directory in .echome. Fill in the contents of the files with the following information:

File: ~/.echome/config


Replace <ECHOME-SERVER-IP> with the IP address of the server running ecHome. The format can either be table or json. This variable is only used in the ecHome CLI.

File: ~/.echome/credentials

access_id = <AUTH-ID>
secret_key = <AUTH-SECRET-KEY>

Alternatively, set the following environment variables at a minimum:


Example commands

$ echome
usage: echome <service> <subcommand> [<args>]

The most commonly used ecHome service commands are:
   vm         Interact with ecHome virtual machines.
   sshkeys    Interact with SSH keys used for virtual machines.

$ echome vm describe-all
Name                 Vm Id        Instance Size    State    IP              Image    Created
-------------------  -----------  ---------------  -------  --------------  -------  --------------------------
ansible_host         vm-b49c2840  standard.small   running           2020-05-25 03:06:22.727312
kubernetes_master    vm-29b73556  standard.medium  running           2020-05-27 01:11:51.596795
kubernetes_worker_1  vm-2bfecdf6  standard.medium  running           2020-05-27 01:12:48.866471
kubernetes_worker_2  vm-2e10d36e  standard.medium  running           2020-05-27 01:12:52.231098

$ echome sshkeys describe test_key --format json
        "fingerprint": "MD5:62:dd:13:e9:7f:a9:be:23:cf:df:64:ac:4b:63:77:d9",
        "key_id": "key-91c8cbd8",
        "key_name": "test_key"


Initialize your environment

Create your virtual environment and install libraries.

$ virtualenv -p python3.8 venv
$ source venv/bin/activate
$ pip install -r requirements.txt

Set up your ~/.echome directory with a config and credentials file that allows you to connect to the echome server (setup guide above).

Test commands with python cli/

(venv)$ python cli/ vm describe-all
Name              Vm Id        Instance Size    State    IP              Image                        Created
----------------  -----------  ---------------  -------  --------------  ---------------------------  --------------------------
RemoteDevServer   vm-30418752  standard.small   running     gmi-07b7e1e4 (Ubuntu 20.04)  2020-08-05 01:22:56.774008


See also the list of contributors who participated in this project.


This project is licensed under the MIT License - see the file for details

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for echome-cli, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size echome_cli-0.1.1-py3-none-any.whl (7.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size echome-cli-0.1.1.tar.gz (6.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page