tekleader

TekLeader

Tekleader is a POSIX compliant and multiplatforms CLI makes it possible to establish a rank between {EPITECH} students from any city and/or promotion, and much more.

Disclaimer

This is not an official project of EPITECH. Just a student who wants to add new cool stuff and features using intranet api.

Features

• Dynamic student GPA ranking from any city/promotion
• Intranet status access
• Dynamic API wrapper in Golang

Roadmap

• Improve promotion ranking with all cities
• Separate API wrapper and core project
• Improve benchmarks using more concurrency
• Define more preferences using config file
• Fix bocal.exe :noel:

Getting started

Installation

You have two ways to get it:

• Go get the app

go get github.com/w3st3ry/tekleader

• Build the Dockerfile

docker build -t tekleader .

And soon, just install the binary given in releases.

Configuration

You just have to add the cfg file .tekleader.yml in /etc/. or $HOME/. with your personal authkey can be founded here as the same format in exemple.

You can also set TEK_AUTHKEY as a env variable or directly as binary parameters.

Warn: If you use this app in a container, you must share the file or expose env variable for authentication.

Usage

Commands

• leader: leader establish a rank between students.
• status: give intranet status in continue.
• version: prints the tekleader version and any available update.

Options

Global options

• auth-key: your authentication key, available on the intranet.
• timeout: timeout (in sec) for check status requests (default: 2).

Leader options

• location: set your city (default: lyon).
• promotion: set your promotion (default: tek2).
• race: enable race condition to print users (default: false).

Hacking

With pleasure, fork with us 🚀