mehdibo / goft

A CLI tool to use 42's API

goft

Goft makes it easier to interact with 42's API without having to deal with the authentication nor all the repetitive parsing and validation.

The tool comes with built in commands to do common tasks but also makes it easier to send raw requests.

• Installation
  • Install script
  • Compiling sources
• Configuration

Installation

Install script

You can use the provided script to easily install the latest version, just run:

curl https://raw.githubusercontent.com/mehdibo/goft/main/install.sh | bash

This script will download the binary and make it available globally, it will also download a sample config file if it doesn't already exist.

Compiling sources

If you want to compile from the source code, you need to have Golang installed in your machine.

Clone the repository:

git clone https://github.com/mehdibo/goft.git

Run:

# Or make all_platforms
# To compile for all platforms
make

# You can also use this to install the binary globally
make install

Configuration

After installing Goft you will have to modify ~/.config/goft/config.yml with your credentials.

This file makes it easier to run commands without having to pass the --config flag every time.