Skip to main content

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 page.

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:

    * 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:

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:
> mkdir /home/my-project

or in windows:

> 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.
> 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:

> rivery configure

And Follow the prompt:

> 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!

Issues and Feature Requests

Rivery CLI and IaC engine is fully open source dir. We're getting in warm welcome any issues/features submitted to our end, and encourage the community to contribute in the solution. Please don't hesitate to add any issues/feature request using the repo's Issues section.

Getting start With Rivery

You can check out our product docs at https://docs.rivery.io in order to getting started.

Full documentation

You may find here the full documentation.

Metadata

Release files for rivery-cli 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rivery-cli 0.4.0
File Size Uploaded Provenance
rivery-cli-0.4.0.tar.gz 28.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for rivery-cli 0.4.0
File Interpreter ABI Platform
rivery_cli-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 65.1 kB

Release files / rivery-cli-0.4.0.tar.gz

Download URL rivery-cli-0.4.0.tar.gz
Size 28.9 kB
Tags Source
SHA-256 checksum
How to use checksums
4fdc678d3378e8ccbd2920dd45b14fd9ef951029407676f87837a56e38c3a33d
BLAKE2b-256 checksum
How to use checksums
9b2014e1ee354739678de90855def57639a4527a9586bebaaf98797edef8982e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.8.12

Release files / rivery_cli-0.4.0-py3-none-any.whl

Download URL rivery_cli-0.4.0-py3-none-any.whl
Size 36.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0fc1d154111ede1705977a9506ad6031e73a9984d66a140f4997b24c0ea34a83
BLAKE2b-256 checksum
How to use checksums
1a0bcd6abd7379746c96c80ef260307ddaa6dc12821914b017f41f4607f1eb82
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.8.12

Security for rivery-cli 0.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page