Skip to content
Kogit is a small CLI application written fully in Bash. Its goal is to get information about a given GitHub repository and display its details in a pleasing manner.
Shell Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
kogit-modules
LICENSE
Makefile
README.md
kogit.sh

README.md

Title

Kogit is a small CLI application written fully in Bash. Its goal is to get information about a given GitHub repository and display its details in a pleasing manner. Kogit does this by formatting the output to look more appealing, such as using color and dynamic spacing.

Features

  • Display details about a given GitHub repository
    • Full name (owner's name + repo name)
    • Description
    • Website
    • Star count
    • Watcher count
    • Fork count
    • Privacy
    • Creation date
    • Primary language
  • Beautiful formatting
  • Support for a GitHub access token to enable viewing your private repos and a better ratelimit

Installation

  1. Download the latest release
  2. Extract the tarball
  3. Run make in the extracted directory

Usage

Fetch repo details

$ kogit APixelVisuals/kogit

Set a GitHub access token

Setting an access token is optional, but gives you a much higher rate limit. Here's how you can generate and set one:

  1. Go to your GitHub Settings
  2. Click on Developer Settings
  3. Click on Personal Access Tokens
  4. Click Generate New Token (GitHub might prompt you to enter your password)
  5. Enable the repo scope
  6. Click Generate Token at the bottom
  7. Copy your new access token and run the Kogit command with the -t or --token flag:
$ kogit -t ACCESS_TOKEN

Trello

You can view plans for the future of Kogit over on the Trello

Inspiration

Kogit is inspired by Neofetch

License

MIT

You can’t perform that action at this time.