Skip to content

Getting started

Requirements

  1. You must have Python 3.6 or later installed. For installation instructions, see the Downloading Python page in Python's Beginner Guide.

  2. An API Token with the following scopes: 

    1
2
3
4
5
6
7
8
        * me:list
    * river:execute
    * river:edit
    * river:list
    * river:delete
    * connection:edit
    * connection:list
    * connection:delete
    In order to create a new API token, please refer to our docs

Install

Install Rivery CLI, by using the next command:

1
> pip install rivery-cli

Check Installation

In order to see if Rivery CLI was installed in your client, check the version option by the next command:

1
> rivery --version

Result should be:

1
Rivery CLI, version ...

Initiate a new project

in order to start new project: 1. create new project directory, for example in linux base OS: 

1
> mkdir /home/my-project
or in windows: 
1
> mkdir c:\my-project

  1. Go into the my-project directory you've created: cd my-project
  2. run the next command and choose your project name. 
    1
    > rivery init

Create the first profile

Rivery CLI store defaults and credentials under an "entity" called profile.

Each profile has its name and the configurations under it. Due to every API token refers to specific account+environment inside your Rivery console, and every account+environment pair has its own credentials, it is likely you'll have a profile per each account+environment coupling.

For creating your first profile use the next command:

1
> rivery configure

And Follow the prompt: 

1
2
3
4
> Please enter your token. (******): ...
> Choose your Region () [...]: ...
> Thank you for entering auth credentials. 
> Please check your profile at: ~/.rivery/auth

And you're good to go!