Metadata-Version: 2.1
Name: rivery-cli
Version: 0.2.2
Summary: UNKNOWN
Home-page: UNKNOWN
Author: Rivery
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: click (>=7.1.2)
Requires-Dist: jsonschema (>=3.2.0)
Requires-Dist: jsonschema-extended (>=0.6)
Requires-Dist: requests (>=2.25.1)
Requires-Dist: simplejson (>=3.17.2)
Requires-Dist: yaql (>=1.0.0)
Requires-Dist: colorama (>=0.4.3)
Requires-Dist: six (>=1.15.0)
Requires-Dist: urllib3 (>=1.26.3)
Requires-Dist: PyYAML (>=5.4.1)
Requires-Dist: attrs (>=20.3.0)
Requires-Dist: bson (>=0.5.10)

# Overview

Rivery CLI is an amazing way to manage, deploy, run and edit rivers inside Rivery.
The rivers are configured only by `.yaml` files, as a configuration files, makes this CLI as a basic
of Infrastructure As Code (IaC) methodology.

In order to start using the tool, go to the [Getting Started](getting-started.md) page.


# Getting started

## Requirements
1. You must have Python 3.6 or later installed.
   For installation instructions, see the [Downloading Python](https://www.python.org/downloads/) page in Python's Beginner Guide.

2. An API Token with the following scopes:
```
    * 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](https://rivery.io/docs/api-documentation)

## Install
Install Rivery CLI, by using the next command:

```bash
pip install -U rivery-cli
```

## Initiate a new project
in order to start new _project_:
1. create new project directory, for example in linux base OS:
```bash 
> mkdir /home/my-project
```
or in windows:
```shell
> mkdir c:\my-project
```

2. Go into the `my-project` directory you've created: `cd my-project`
3. run the next command and choose your project name.
```bash
> 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:

```bash
> rivery configure
```

And Follow the prompt:
```bash
> 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!






