Summary

All your automations in one place

Ritchie CLI is an open source project that allows to create, store and share automations, executing them through command lines.

Usage

A customizable CLI automation tool

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 Git repository.

📚 Full Documentation

🚀 Quick start 🤖

1️⃣ Install rit latest version

Linux

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

MacOS

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

Windows

Download the installer from ritchiecli.msi
Using Winget:

winget install Ritchie-CLI

You can also download rit packages or specific versions according to the OS on the documentation

2️⃣ Initialize rit locally

rit init

Note: You need to import the commons repository to be able to create formulas.

Sharing metrics anonymously will help us improving the tool. For any question, check our privacy policy.

3️⃣ Add your first formulas repository

To access the "hello-world" formula, you need to add the ritchie-formulas-demo repository locally.

To do so, you can use the rit add repo command manually on your terminal, or execute the command line below with input flags:

rit add repo --provider="Github" --name="demo" --repoUrl="https://github.com/ZupIT/ritchie-formulas-demo" --priority=1

4️⃣ Run the Hello World formula

Execute the "hello-world" formula through the command line below:

rit demo hello-world

Note: This formula has been implemented using Golang, so to use it locally you'll need Golang to be installed on your machine. If you don't have or don't want to install Golang, you can use the same command with Docker:

rit demo hello-world --docker

andrevtg/ritchie-cli