The Ritchie CLI project has been archived by Zup Innovation. It might start again eventually; however, we won't deliver support for now.

Table of contents

1. About

2. Getting Started

2.1. Installation

2.2 Initialize rit locally

2.3. Add your first formulas repository

2.4. Run the Hello World formula

2.5. Usage

3. Cheat Sheet

4. Documentation

5. Code of Conduct

6. Contributing

7. License

8. Community

About

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

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.

Getting started

Installation

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.

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

Usage

Cheat Sheet

Documentation

You can find Ritchie's documentation on our website.

Contributing

Feel free to use, recommend improvements, or contribute to new implementations.

Check out our contributing guide to learn about our development process, how to suggest bug fixes and improvements.

Check out other guides:

• Security

• Developer Guide

• Documentation repository

Developer Certificate of Origin - DCO

This is a security layer for the project and for the developers. It is mandatory.

Follow one of these two methods to add DCO to your commits:

1. Command line Follow the steps: Step 1: Configure your local git environment adding the same name and e-mail configured at your GitHub account. It helps to sign commits manually during reviews and suggestions.

git config --global user.name “Name”
git config --global user.email “email@domain.com.br”

Step 2: Add the Signed-off-by line with the '-s -S' flag in the git commit command:

$ git commit -s -S -m "This is my commit message"

2. GitHub website You can also manually sign your commits during GitHub reviews and suggestions, follow the steps below:

Step 1: When the commit changes box opens, manually type or paste your signature in the comment box, see the example:

$ git commit -m “My signed commit” Signed-off-by: username <email address>

For this method, your name and e-mail must be the same registered to your GitHub account.

Code of Conduct

Please follow the Code of Conduct in all your interactions with our project.

License

Apache License 2.0.

Community

Do you have any question or suggestion about Ritchie CLI? Let's chat in our forum.