zupit / ritchie-cli

Ritchie CLI is an open-source tool that allows to create, store and share any kind of automation, executing them through command lines, to run operations or start workflows ⚙️ 🖥 💡

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 protected]”

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.

ritchie-cli's Issues

[FEATURE] Add commons repository by default in Single version

What version of Rit are you using (rit --version)?

rit version 1.0.0-beta.2 (single)
  Build date: 04/09/20_21:41
  Built with: go1.13.9

Does this issue reproduce with the latest release?

yes

What operating system are you using?

OSX

What did you do?

$ rit list repo

What did you expect to see?

What did you see instead?

The server url is showing while running any commands

What version of Rit are you using (rit --version)?

ServerURL:  https://ritchie-server.zup.io
rit version 1.0.0-beta (team)
  Build date: 04/09/20_14:40
  Built with: go1.13.9

Does this issue reproduce with the latest release?

Yes

What operating system are you using?

OSx

What did you do?

I ran rit

What did you expect to see?

rit version 1.0.0-beta (team)
Build date: 04/09/20_14:40
Built with: go1.13.9

What did you see instead?

ServerURL: https://ritchie-server.zup.io
rit version 1.0.0-beta (team)
Build date: 04/09/20_14:40
Built with: go1.13.9

[FEATURE] Adding hello world template in KOTLIN (rit create formula)

What would you like to be added:

• A Hello World template to create a formula in KOTLIN with the rit create formula command

Why is this needed:

• Those templates are currently available for Java, Go, Python, Node and Shell. It would make it easier for KOTLIN programmers to create formulas and use Ritchie.

[FEATURE] Add golint in circleci

What would you like to be added:

Add golint in CircleCI

Why is this needed:
golint in ci

[BUG] Create formula error

What happened:
On command rit create formula;
if input a unallowed command, like only two words or without "rit", rit ask me the language and repo, and then output the error

What you expected to happen:
Error outputed right after i write formula's command

How to reproduce it (as minimally and precisely as possible):
rit create formula and type something like:
this command is wrong, or
rit tooShort

Anything else we need to know?:
A possible solution is to move the verifyCommand function from creator to create_formula

[FEATURE] STDIN Implementation on Ritchie-CLI

What would you like to be added:

• STDIN (Standard Inputs)

Why is this needed:

• To automate core commands & formulas in Ritchie.

[BUG] Error when adding kubeconfig too big

What happened:

What you expected to happen:

Kubeconfig credential saved!

How to reproduce it (as minimally and precisely as possible):

rit set credential
Provider: kubeconfig
credential: base64config="kubeconfig in base64 a long time"

Environment:

• Ritchie version (use rit --version):

rit version 1.0.0-beta.14 (single) Build date: 06/15/20_14:00 Built with: go1.14.4

• Operating System:

NAME="Ubuntu" VERSION="18.04.4 LTS (Bionic Beaver)" ID=ubuntu ID_LIKE=debian PRETTY_NAME="Ubuntu 18.04.4 LTS" VERSION_ID="18.04" HOME_URL="https://www.ubuntu.com/" SUPPORT_URL="https://help.ubuntu.com/" BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/" PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy" VERSION_CODENAME=bionic UBUNTU_CODENAME=bionic

[BUG] Getting error when running rit set server in Windows

What happened: I just have restored my Windows, and I was trying to set the Rit CLI. I've downloaded the team version for 1.0.0-beta.6, and added to my System PATH. When I tried to set my server as https://ritchie-server.zup.io I got the following:

panic: runtime error: invalid memory address or nil pointer dereference
[signal 0xc0000005 code=0x0 addr=0x8 pc=0xc05e69]

goroutine 1 [running]:
github.com/ZupIT/ritchie-cli/pkg/server.SetterManager.Set(0xc00002be20, 0x1a, 0xc00021a520, 0x1d, 0x0, 0x0)
        /workspace/pkg/server/setter.go:35 +0xd9
github.com/ZupIT/ritchie-cli/pkg/cmd.setServerCmd.runFunc.func1(0xc0001ff8c0, 0x15b1ee0, 0x0, 0x0, 0x0, 0x0)
        /workspace/pkg/cmd/set_server.go:41 +0x9a
github.com/spf13/cobra.(*Command).execute(0xc0001ff8c0, 0x15b1ee0, 0x0, 0x0, 0xc0001ff8c0, 0x15b1ee0)
        /home/circleci/go/pkg/mod/github.com/spf13/[email protected]/command.go:842 +0x45a
github.com/spf13/cobra.(*Command).ExecuteC(0xc0001b2840, 0x444c11, 0x1529480, 0xc00005ff78)
        /home/circleci/go/pkg/mod/github.com/spf13/[email protected]/command.go:950 +0x350
github.com/spf13/cobra.(*Command).Execute(...)
        /home/circleci/go/pkg/mod/github.com/spf13/[email protected]/command.go:887
main.main()
        /workspace/cmd/team/main.go:34 +0x32

What you expected to happen: I was expecting to have my server set.

How to reproduce it (as minimally and precisely as possible): I've described all the steps on the What Happened section.

Anything else we need to know?: This also happens if I try to set the server as my localhost

Environment:

• Ritchie version (use rit --version): it version 1.0.0-beta.6 (team)
• Operating System: Windows 10 Home
• Network plugin / Tool and version (if this is a network-related / tool bug): Tried in CMD and Powershell
• Others:

[FEATURE] Command for set serverURL and remove from build

What would you like to be added:
a command like $rit set server [URL] in Team Version

Why is this needed:
because the serverURL has been set by the build process in Makefile

[BUG] Windows colors

What happened:
Instead of printing colors, are printing numbers and caracters. Only windows.

What you expected to happen:
Print colors

How to reproduce it (as minimally and precisely as possible):
rit upgrade and check success message, or any other colored message.

Anything else we need to know?:
It happens on windows cmd or powershell

[FEATURE] Adding hello world template in RUBY (rit create formula)

What would you like to be added:

A Hello World template to create a formula in RUBY with the rit create formula command

Why is this needed:

Those templates are currently available for Java, Go, Python, Node and Shell. It would make it easier for RUBY programmers to create formulas and use Ritchie.

[BUG]Error on login when password contains special character

What happened:

Error when password contains special characters on windows

What you expected to happen:

Password accepts all characters

How to reproduce it (as minimally and precisely as possible):

Login with any user with password with character ! (exclamation)

Anything else we need to know?:

Error reported by windows user on cygwin, prompt and powershell

Environment:

• Ritchie version (use rit --version): 1.0.0-beta-14(team)
• Operating System: Windows
• Network plugin / Tool and version (if this is a network-related / tool bug):
• Others:

Evidences:

[FEATURE] Update RIT CREATE FORMULA command

What would you like to be added:
The option to add a repo instead of use ritchie-formulas-local
Formulas variable composed by the two last words instead of one

Why is this needed:
Use another formula repositories
Avoid formula conflicts

[BUG] the formula should know where the user call it.

What happened:
Formulas who use the current PWD are broking, because when running the formula the PWD is set to /.rit/tmp/4c4de087-27ca-47c5-9a8d-0bcb8344b6b9
What you expected to happen:
the formula should know where the user call it.
How to reproduce it (as minimally and precisely as possible):
example:

• on folder: /home/vinicius.sousa/Documents/zup/realwave-zupper-bff
• run: rit github fast-merge
• description: the formula fail, then a print the PWD
  • and return:
    /home/vinicius.sousa/.rit/tmp/4c4de087-27ca-47c5-9a8d-0bcb8344b6b9/github/fast-merge
  • but on the old version of rit returns:
    /home/vinicius.sousa/Documents/zup/realwave-zupper-bff

Environment:

• Ritchie version (use rit --version):
  rit version 1.0.0-beta.6 (team)
• Operating System:
  ubuntu 18.4

[FEATURE] Create new languages in create formula.

What would you like to be added:

rit create formula

go
java
node
python
shell

Why is this needed:

Improve formula creation

[FEATURE] Create a beautiful screen after login and logout

What version of Rit are you using (rit --version)?

rit version 1.0.0-beta.2 (team)
  Build date: 04/09/20_21:41
  Built with: go1.13.9

Does this issue reproduce with the latest release?

Yes

What operating system are you using?

Linux

What did you do?

I ran the rit login and rit logout command

What did you expect to see?

a beautiful screen after login and logout

What did you see instead?

[FEATURE] Adding hello world template in PHP (rit create formula)

What would you like to be added:

A Hello World template to create a formula in PHP with the rit create formula command

Why is this needed:

Those templates are currently available for Java, Go, Python, Node and Shell. It would make it easier for PHP programmers to create formulas and use Ritchie.

[FEATURE] Check the possibility of using vendor

What would you like to be added:

Use the vendor structure for all project dependencies.

Why is this needed:

Greater reliability and better organization of your facilities.

[FEATURE] Adding hello world template in PERL (rit create formula)

What would you like to be added:

A Hello World template to create a formula in PERL with the rit create formula command

Why is this needed:

Those templates are currently available for Java, Go, Python, Node and Shell. It would make it easier for PERL programmers to create formulas and use Ritchie.

[FEATURE] Adding hello world template in SWIFT (rit create formula)

What would you like to be added:

A Hello World template to create a formula in Swift with the rit create formula command

Why is this needed:

Those templates are currently available for Java, Go, Python, Node and Shell. It would make it easier for Swift programmers to create formulas and use Ritchie.

[BUG] Using rit build formula appends to application.bat instead of replacing

What happened:
Buildin a formula with rit build formula creates appends the command to application.bat instead of regenerating it:

python main.py
python main.py
python main.py
python main.py

What you expected to happen:
The application.bat file should container only one command.

How to reproduce it (as minimally and precisely as possible):
Create a new formula and run rit build formula on it twice.

Environment:

• Ritchie version: 1.0.0-beta.17 (single)
• Operating System:

  Operating System: Pop!_OS 20.04 LTS
            Kernel: Linux 5.4.0-7634-generic
      Architecture: x86-64
  

[FEATURE] rit list credential command

What would you like to be added:

• To know which credentials have been added on the current context (it won't be necessary to see the values, but at least the field_name to know how to manipulate those variables inside a formula).

Why is this needed:

• There is no way to know what credentials are defined on the context today.

[BUG] PWD environment variable error passed by formula runner

What happened:
When I run a formula in a shell script that needs the PWD environment variable passed by formula runner, it gets the tmp dir PWD of formula.
What you expected to happen:
I expected my current PWD and not the tmp dir PWD

How to reproduce it (as minimally and precisely as possible):
Create a formula in the shell script, echo the $PWD variable and execute it inside Ritchie-CLI

Anything else we need to know?:
$PWD variable works in Golang formulas

Environment:

• Ritchie version (use rit --version): 1.0.0-beta.13
• Operating System: MX Linux

[BUG]Local Formula

What happened:
When I try execute a local Formula, it try start download and get a error:

~ >>> rit challenge test
2020/06/05 13:33:42 Download formula...
Error: Get "/challenge/test/linux.zip": unsupported protocol scheme ""

This formula is the default.
I think it shouldn't make a http request here.

What you expected to happen:
Start the Formula.

How to reproduce it (as minimally and precisely as possible):
-Create new system
-install Go and Ritchie-cli
-init Ritchie-cli (rit init)
-create new formula (rit create formula)
-go to ritchie-formula-local repository
-execute the make (make test-local)
-check if the new formula is available (rit --help)
-call the new formula

Environment:

• Ritchie version (use rit --version): rit version 1.0.0-beta.13 (single)
• Operating System: Linux - Manjaro kernel 5.6.15-1

[FEATURE] rit build formula command

What would you like to be added:

• O command to build a formula instead of having to enter inside the repository to execute the make test-local command.

Why is this needed:

• To make the test of a new implementation easier.

[FEATURE] Adding a new input type : SELECTOR

What would you like to be added:

• A new input type to allow the user to choose more than 1 option in a list of entries (checkbox).

Why is this needed:

• It's a commons way of selecting options through CLIs and it would allow more flexibilities to implement formulas.

[FEATURE] CircleCI pipeline

What would you like to be added:

Add pipeline to allow running ritchie-cli builds using circleci instead

Why is this needed:

To decouple our builds from Zup's infrastructure

[BUG] lint doesn't fail pipeline when find issue

Just like what tittle says.

The autocomplete to create formula doesn't work

What version of Rit are you using (rit --version)?

rit version 1.0.0-beta.1 (single)
  Build date: 04/09/20_17:15
  Built with: go1.13.9

Does this issue reproduce with the latest release?

Yes

What operating system are you using?

Linux (Manajaro)

What did you do?

When I ran the command rit create formula, the autocomplete doesn't work.

[FEATURE] Add to command `rit create formula` the build formula command

What would you like to be added:
When I run the command rit create formula, I would like to create and build my new formula.

Why is this needed:
So I can now execute my new formula inside Ritchie-CLI without need execute the command rit build formula.

[FEATURE] Group commands by core/repo

What would you like to be added:
Organize the commands by group where core is presented first, and the repos will be presented by priority

Why is this needed:
For better visualization and identification of the commands

[FEATURE] - Access control for formula

What would you like to be added:
Access control in tree.json per roles.

Example:

{
  "commands": [
    {
      "usage": "aws",
      "help": "Apply Aws objects",
      "parent": "root",
     "roles" : ["RIT_ADMIN"]
    },
    {
      "usage": "apply",
      "help": "Apply Aws objects",
      "parent": "root_aws"
    }
  "version": "1.0.0"
}

User with role rit_admin view all tree, other user view only apply command.
For this is necessary send repo name to server.

Why is this needed:
Allow access control in repository for team version

[FEATURE] Global credential by organization

What would you like to be added:
I would like to add global credentials for organizations in the vault.
Why is this needed:
Because my organization may have a credential that serves multiple employees.

[BUG] Changelog generation not working properly

What happened:
The last release is showing as unreleased inside the cnangelog file

What you expected to happen:
The release should be shown correctly

How to reproduce it (as minimally and precisely as possible):
Run the release pipeline

[FEATURE] Adding hello world template in C# (rit create formula)

What would you like to be added:

• A Hello World template to create a formula in C# with the rit create formula command

Why is this needed:

• Those templates are currently available for Java, Go, Python, Node and Shell. It would make it easier for C# programmers to create formulas and use Ritchie.

Create journey tips

What would you like to be added:

• To guide a novice user (in the tool) in the process of knowing the functionalities of the ritchie. As a tutorial.

Why is this needed:

• There is no way to know the sequence of steps to be taken without looking at the documentation.

[BUG] Slash in new formula's command generate a path error

What happened: When trying to create a new formula, if you specify a command like rit teste teste_sub/teste in the "new formula's command" prompt, the resulting path is malformed and you receive a path not found error.

What you expected to happen: Either explicitly block backslash and forward slash in command or properly address them.

How to reproduce it (as minimally and precisely as possible):
rit create formula > rit teste teste/sub
rit create firmula > rit teste teste\sub

Anything else we need to know?: Tested in windows only.

Environment:

• Ritchie version (use rit --version): 1.0.0-beta.6
• Operating System: windows 10
• Network plugin / Tool and version (if this is a network-related / tool bug):
• Others:

[FEATURE] Resize website layout

Feature

• The page is not well dimensioned horizontally. Resize the width

Why

• It breaks the layout and UX

Proof

Enhancement test for pkg/cmd

[BUG] make test-local doesn't work with space in PATH obtained with PWD command

What happened:

• The following line in the make test-local script returned an error :
  for formula in $(FORMULAS); do cd $$formula/src && make build && cd $(PWD_INITIAL); done

What you expected to happen:

• Execute the make test-local command without any error.

How to reproduce it (as minimally and precisely as possible):

• Execute the command make test-local with a space in the PATH when executing the PWD command :
  Example : /Users/Name Firstname/ritchie-formulas-local

Anything else we need to know?:

• A solution could be to add " around the PWD value inside the test-local script.

• This correction needs to be implemented on the template for creating new formulas as well as in each formula repository.

Environment:

• Ritchie version (use rit --version): rit version 1.0.0-beta.14 (team)
• Operating System: WINDOWS
• Network plugin / Tool and version (if this is a network-related / tool bug): N/A
• Others: N/A

[FEATURE] Allow running any language

What would you like to be added:

Allow running formulas inside a workspace, like the following image:

Why is this needed:

To increase the amount of languages supported by ritchie.

[BUG] Create formula with specific words

What happened:

Error after create formula with specific words like:
go
java
python
test
formula
form

What you expected to happen:
Be warned about unallowed words

How to reproduce it (as minimally and precisely as possible):
rit create formula
enter the new command like: rit go go
and choose go language

errors came while building formula:

Build error:
main.go:5:2:
pkg/go/go.go:1:9: expected 'IDENT', found 'go'
pkg/go/go.go:3:1: expected ';', found 'import'
make: *** [Makefile:19: build] Error 1

Environment:

• Ritchie version: Building master
• Operating System: Linux Ubuntu 20.04

[FEATURE] Run formulas inside a docker container

What would you like to be added:
Allow running formulas inside a docker container, following the example:

Why is this needed:
Not to depend on the host machine to execute the formulas, because the host machine may not have the necessary dependencies to run a formula.

[BUG] Creating python formulas with dependencies

Tried to use rit to create a simple CLI to read my google calendar using this code:
https://developers.google.com/calendar/quickstart/python

Works on standalone but on rit errors:
ModuleNotFoundError: No module named 'googleapiclient'

Not sure how if this is a documentation issue about building python formulas or something else.

Halp?

[BUG] Requirements golint

What happened:
Code does not pass the lint in Circleci.

Environment:

• Ritchie version (use rit --version):
  rit version 1.0.0-beta.2 (team)
  Build date: 04/09/20_21:41
  Built with: go1.13.9
• Operating System:

[FEATURE] Enhancement of the rit set credential command on single version

What would you like to be added:

• Turn the rit set credential command easier on the Single version. Listing available providers the same it's done on the Team version

➜ rit set credential
✔ ME (for you)
Use the arrow keys to navigate: ↓ ↑ → ←
Provider:
▸ darwin
email-org
github
gitlab
jenkins
kubeconfig
aws

This list of provider configurations could be updating according to community needs by opening a PR on the ritchie-cli repository.

Why is this needed:

• It's a bit complicated to manipulate credentials on the Single version as it is now.

[BUG] RIT Team: set server with invalid URL

What happened:
Return a exception:
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x8 pc=0xbe1f55]

What you expected to happen:
Message show the URL is invalid

How to reproduce it (as minimally and precisely as possible):
1 - rit set server
2 - https://localhost:8080

Anything else we need to know?:
rit set server
URL of the server [http(s)://host] https://localhost:8080█
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x8 pc=0xbe1f55]

goroutine 1 [running]:
github.com/ZupIT/ritchie-cli/pkg/server.SetterManager.Set(0xc000035800, 0x18, 0xc0000a6260, 0x16, 0x0, 0x0)
/workspace/pkg/server/setter.go:35 +0xd5
github.com/ZupIT/ritchie-cli/pkg/cmd.setServerCmd.runFunc.func1(0xc0001f5600, 0x15790b0, 0x0, 0x0, 0x0, 0x0)
/workspace/pkg/cmd/set_server.go:41 +0x93
github.com/spf13/cobra.(*Command).execute(0xc0001f5600, 0x15790b0, 0x0, 0x0, 0xc0001f5600, 0x15790b0)
/home/circleci/go/pkg/mod/github.com/spf13/[email protected]/command.go:842 +0x453
github.com/spf13/cobra.(*Command).ExecuteC(0xc0001a2580, 0x4420aa, 0x14f32c0, 0xc00005e778)
/home/circleci/go/pkg/mod/github.com/spf13/[email protected]/command.go:950 +0x349
github.com/spf13/cobra.(*Command).Execute(...)
/home/circleci/go/pkg/mod/github.com/spf13/[email protected]/command.go:887
main.main()
/workspace/cmd/team/main.go:34 +0x2b

Environment:

• Ritchie version (use rit --version):
  rit version 1.0.0-beta.6 (team)
  Build date: 05/06/20_18:00
  Built with: go1.14.2
• Operating System:
  Linux/Ubuntu
• Network plugin / Tool and version (if this is a network-related / tool bug):
• Others:

[FEATURE] Command for publishing a new formula

What would you like to be added:

• a command $ rit publish formula for both version.

Why is this needed:

• to make it easier for the user to publish a new formula he created locally (through the $ rit create formula command on the ritchie-formulas-local repository)

[FEATURE] Adding hello world template in RUST (rit create formula)

What would you like to be added:

A Hello World template to create a formula in Rust with the rit create formula command

Why is this needed:

Those templates are currently available for Java, Go, Python, Node and Shell. It would make it easier for Rust programmers to create formulas and use Ritchie.

[BUG]Module Axios not found.

What happened:
When I create a formula in node using module Axios the execution result in not found the module.

What you expected to happen:
The execution occur normally.

How to reproduce it (as minimally and precisely as possible):
Create a formula using node and the module Axios and execute it.

Anything else we need to know?:
I test the code and it work normally.
I new in the open source community, if it isn't the correct local to post this I am sorry.
I opened a other bug issue that is close but the problem wasn't resolve, I don't know if the correct is open a new issue but I comment in that issue after it close. Please check it #148

Environment:
Ritchie version (use rit --version): rit version 1.0.0-beta.13 (single)
Operating System: Linux - Ubunto