Skip to content

Latest commit

 

History

History
111 lines (82 loc) · 3.46 KB

README.md

File metadata and controls

111 lines (82 loc) · 3.46 KB
Raw

stars

Actions Test Workflow Widget GoReport Widget GoDocWidget

A command-line interface to your Github Stars. Some useful features:

  • Downloads metadata about all of your starred projects and saves it to disk
  • Unstars projects older than n months (by default, 2)
    • Also unstars projects that have been archived (by default - you can opt out).
  • Can let you display starred projects by criteria:
    • Language
    • Topics (labels)
    • Randomly
  • Can limit displayed results as specified
  • Can open queried starred projects in your browser for viewing

My personal workflow is to save all of my stars, prune old and archived ones, and display several random stars in my browser for me to view / explore. This is a type of Spaced Repetation Learning (think flash cards), that way I can stay relatively up-to-date on what my starred projects are. This is useful to me when I build software and need to know if there is a project already out there that solves my problems / fits my needs.

Development

To get started, you will need git and Go on your system. Then, you can run the following commands to build the binary:

git clone [email protected]:gkze/gh-stars.git
cd stars
go build # need Golang 1.11+

NOTE: As mentioned in the comment above, you will need to have Go 1.11 installed at minimum. This project utilizes Go modules, which are only supported in Go 1.11 and above.

Installation

There are various methods availabel to install stars on your system:

Homebrew

brew install gkze/gkze/gh-stars

Go

go get -u github.com/gkze/gh-stars/cmd/stars

Binaries are also available on the releases page.

Configuration

You will need a ~/.netrc with a personal access token configured:

$ cat ~/.netrc
machine api.github.com
    login [your github username here]
    password [your github token here]

Usage

A CLI written in Golang to facilitate efficient management of a user's
GitHub starred projects / repositories, a.k.a. "Stars"

Usage:
  stars [flags]
  stars [command]

Available Commands:
  add         Add (star) repositories
  cleanup     Clean up old stars
  clear       Clear local stars cache
  completion  Generate shell completion script
  help        Help about any command
  save        Save starred repositories
  show        Show stars
  topics      List all topics of all stars
  version     Show version of stars

Flags:
  -w, --concurrency int    Limit goroutines for network I/O operations (default 10)
  -h, --help               help for stars
  -o, --log-level string   Log level (default "info")

Use "stars [command] --help" for more information about a command.

License

MIT