Ritchie - One CLI to rule them all

Ritchie CLI is an open source product that allows you to create, store and share any kind of automations, executing them through command lines, to run operations or start workflows.

This repository contains the CLI core, which can execute formulas stored inside other repositories such as ritchie-formulas or ritchie-formulas-demo

In Ritchie's context, a formula is a script that can be executed automatically or interactively through a command line. Adapting an existing script to Ritchie structure allows you to run it locally or through Docker, and to share it on a Github or Gitlab repository.

Full Documentation

Gitbook

Quick start

Install rit

• Linux|MacOS

curl -fsSL https://commons-repo.ritchiecli.io/install.sh | bash

• Windows

Download the installer from (https://commons-repo.ritchiecli.io/latest/ritchiecli.msi)

Initialize rit

Once you made it, Ritchie will add all community formulas repository and create all the necessary configuration's files.

rit init

Run your first formula

After you finished the previous steps -installation and initialization - to access the "hello-world" formula to test Ritchie, you'll need to add the ritchie-formulas-demo repository locally.

To do so, you can use the rit add repo command, or execute the command line below:

echo '{"provider":"Github", "name":"demo", "version":"2.0.0", "url":"https://github.com/ZupIT/ritchie-formulas-demo", "token": null, "priority":1}' | rit add repo --stdin

Then, you'll be able to test Ritchie CLI with the "hello-world" formula through the command line below:

rit demo hello-world

Ritchie Legacy-1.x

With the release of version 2.0.0 of Ritchie, the previous version (Ritchie 1.x) has been deprecated. Therefore, only bugs fixes will be implemented in this version.

The legacy code is available at Ritchie Legacy-1.0.0.

Contributing

Contribute to the Ritchie community

Zup Products

Zup open source