upvest-cli 0.1.dev0

Installation

To install the Upvest CLI, clone this repository and then using python >= 3.7, run:

pip install .

or alternatively without cloning:

pip install git+ssh://git@github.com/toknapp/upvest-cli

Basic usage

There are three ‘layers’ of the upvest CLI commands.

• upvest the starting point for commands to configure which endpoint to talk to

• app or user to decide between using the application (tenant) API or the user (clientele) API and include the necessary credentials

• commands : such as ‘createuser’ or ‘listassets’ or ‘createwallet’

For example:

Create a user:

upvest -e https://api.playground.upvest.co/ app -K keyid -S keysecret -P keypassphrase createuser username password

Configuration file

A configuration file will help to fill in most command line arguments, thus avoiding having to repeat several credentials and ensuring secrets and passwords do not linger in your bash history.

--help on each subcommand will show which environment variables to set in place of commandline arguments, however a configuration file can also be used.

This will be loaded by default from upvest.yaml or .upvest.yaml however this can be configured using the --configfile or -c flag to pass in the path to the configuration file.

The configuration file should take the following form:

endpoints:
  my_playground_name:
    base_url: https://api.playground.upvest.co/
    api_key: ...
    api_key_secret: ...
    api_key_passphrase: ...
    oauth_client_id: ...
    oauth_client_secret: ...

This can then be referenced from the command line to switch between environments or applications as you define them:

upvest -e my_playground_name user -l username -w password listwallets