ghstars

command module
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 30, 2022 License: MIT Imports: 3 Imported by: 0

README

Version Go Documentation Go Report Card Go Build Status GolangCI-Lint Status codecov Docker Lint Status Docker Pulls Docker Size Docker Build Status

ghstars

Do you want to know how many stars you have? or want to know how many stars another user has? ghstars provides that little functionality for ya!

If you create your own GitHub Access Token you can calculate all of your repo stargazers count too!

All you need is to set GITHUB_ACCESS_TOKEN environment variable if you want to fetch all of your repo’s star count!

Installation

go install github.com/vigo/ghstars@latest

Usage

You can check command help:

ghstars -h

ghstars fatih                # public stars count of fatih user
ghstars tj                   # public stars count of fatih tj
ghstars -s vigo              # just how public stars amount of vigo
ghstars -verbose vigo        # public stars count of vigo in debug mode

GITHUB_ACCESS_TOKEN="<your-token>" ghstars  # your repos count

How count is done ?

  • Public access; star count should be greater than zero and repo fork must be false
  • Token access; you must be admin in that repo, star count should be greater than zero and repo fork must be false

Long story short, forks are not counted!

According to GitHub;

  • For unauthenticated requests, the rate limit allows for up to 60 requests per hour.
  • 5000 requests per hour and per authenticated user.

Docker

https://hub.docker.com/r/vigo/ghstars/

# latest
docker run vigo/ghstars -h
docker run vigo/ghstars fatih

Contributor(s)


Contribute

All PR’s are welcome!

  1. fork (https://github.com/vigo/ghstars/fork)
  2. Create your branch (git checkout -b my-feature)
  3. commit yours (git commit -am 'add some functionality')
  4. push your branch (git push origin my-feature)
  5. Than create a new Pull Request!

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.


License

This project is licensed under MIT

Documentation

Overview

Package NAME OF YOUR PACKAGES implements ....

Build with: go version go1.19.2 darwin/arm64
Created by Uğur Özyılmazel on 2022-10-29.
Copyright (c) 2022 VB YAZILIM. All rights reserved.

Directories

Path Synopsis
src

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL