azur1s / octofetch

Github user information on terminal :D

octofetch

Table of Contents

1. Usage
2. Installation
3. Features
4. FAQ

A CLI tool for fetching GitHub stats, kinda like neofetch

Usage

octofetch <username>

with custom config file

octofetch -c path\to\config <username>

Installation

Windows

1. Get the latest .exe file from here
2. Place the file somewhere you can access and open terminal at that directory
3. Do ./octofetch.exe <username>
4. Add to PATH variables for easier usage (optional)

Local install with cargo

Run cargo install --git https://github.com/azur1s/octofetch

Manual install with cargo

1. Clone git repos: git clone https://github.com/azur1s/octofetch
2. Change directory: cd octofetch
3. Build binary make build or cargo build
4. Change directory to ./target/debug and then run it!

Linux

Features

fetch github user stats lol

FAQ

Why rust? that language can also do the same thing!

Yes, I agree with that but, This is my first project on rust and I might implement some more feature in the future too. Pretty proud of it ngl :D

octofetch's Issues

License statement

Currently there is no license statement. Could you please add a LICENSE file that contains the license text.

Thanks.

Some improvements/fixes

1-FIXED-#13.

Look at the output. There's a useless newline. I have no exclusive/special knowledge in Rust, so I don't know the various macros in the program. I think there could be a fix.

It happens here too.
2.
How about displaying the profile picture on the left of the box? Looks like the viuer crate could do the job.
3.

This never happens if the terminal size is sufficient, but when the terminal is small, the output becomes garbled in a very unfashionable way. Neofetch solves the problem by detecting the terminal size and cutting the output. Looks like https://docs.rs/term_size/0.3.2/term_size/ could help you out.

Expects Name as String

octofetch/src/main.rs

Line 16 in d584513

name: String,

Fun little tool! I hadn't set my name on my profile and it complained about receiving null value, if you feel like adding some more error checking 😄

Add contribution history graph

I've looked into this, apparently github doesn't have an endpoint for fetching the contribution calendar however you can get the data with GraphQL https://docs.github.com/en/graphql/reference/objects#contributionscollection noted here, we could use some boxes such as ■ to display the history

Would look something like this:
■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■