Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/azur1s/octofetch

Github user information on terminal :D
https://github.com/azur1s/octofetch

command-line github prompt rust terminal

Last synced: about 1 month ago
JSON representation

Github user information on terminal :D

Awesome Lists containing this project

README

        

# octofetch

### Table of Contents

1. [Usage](#usage)
2. [Installation](#installation)
3. [Features](#features)
4. [FAQ](#faq)

A CLI tool for fetching GitHub stats, kinda like `neofetch`

# Usage

`octofetch `

with custom config file

`octofetch -c path\to\config `

# Installation

### Windows

1. Get the latest `.exe` file from [here](https://github.com/azur1s/octofetch/releases)
2. Place the file somewhere you can access and open terminal at that directory
3. Do `./octofetch.exe `
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

[![Packaging status](https://repology.org/badge/vertical-allrepos/octofetch.svg)](https://repology.org/project/octofetch/versions)

# 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