/ritchie-gitbook

This repository contains the documentation you can find on https://docs.ritchiecli.io. 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 ⚙️ 🖥 💡

description
In this section, you'll find initial information about Ritchie before delving into the product.

Overview

What is Ritchie?

Ritchie is an automation tool which allows to create, store and share automation efficiently and securely with a team or with the whole community.

What does Ritchie do?

The tool allows you to create formulas that, in other terms, represent programs and/or commands that will facilitate your daily programming work. Ritchie works as a single formulas repository.

{% embed url="https://youtu.be/PtKFco2pIqs" %}

Installation

Ritchie is a cross-plataform CLI. For more information on how to install, just choose your operating system below:

{% page-ref page="getting-started/installation/linux.md" %}

{% page-ref page="getting-started/installation/windows.md" %}

{% page-ref page="getting-started/installation/macos.md" %}

Programming Languages

{% hint style="info" %} Ritchie has been developed using the Golang language. {% endhint %}

However, formulas can be written using any programming language.

Tools

{% hint style="info" %} Ritchie works with any tool you could use for automations. {% endhint %}

How does Ritchie work?

{% hint style="warning" %} The tool allows you to create formulas that, in other terms, represent programs and /or commands that will facilitate the daily programming work. {% endhint %}

In general, the common process for executing a project is to create a whole previous infrastructure, defining a language in the system that will be programmed, downloading dependencies and defining the rules that should be used for the project.

WITHOUT Ritchie

With Ritchie, it's possible to define this configuration using a formula, creating this infrastructure directly by a command line, which in this case will delivered all the structure of the project with all files automatically configured. That helps on avoiding an important time spent on infrastructure and configurations.

WITH Ritchie