Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gkze/gh-stars
:star: Keep your Github Stars fresh!
https://github.com/gkze/gh-stars
automation cli github go golang star tool
Last synced: about 1 month ago
JSON representation
:star: Keep your Github Stars fresh!
- Host: GitHub
- URL: https://github.com/gkze/gh-stars
- Owner: gkze
- License: mit
- Created: 2018-05-16T17:15:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T22:35:04.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T15:10:47.825Z (8 months ago)
- Topics: automation, cli, github, go, golang, star, tool
- Language: Go
- Homepage:
- Size: 5.62 MB
- Stars: 122
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - gkze/gh-stars - :star: Keep your Github Stars fresh! (Go)
README
# stars
[![Actions Test Workflow Widget]][Actions Test Workflow Status]
[![GoReport Widget]][GoReport Status]
[![GoDocWidget]][GoDocReference]
[Actions Test Workflow Status]: https://github.com/gkze/gh-stars/actions?query=workflow%3Aci
[Actions Test Workflow Widget]: https://github.com/gkze/gh-stars/workflows/ci/badge.svg
[GoReport Status]: https://goreportcard.com/report/github.com/gkze/gh-stars
[GoReport Widget]: https://goreportcard.com/badge/github.com/gkze/gh-stars
[GoDocWidget]: https://godoc.org/github.com/gkze/gh-stars?status.svg
[GoDocReference]:https://godoc.org/github.com/gkze/gh-stars
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](https://en.wikipedia.org/wiki/Spaced_repetition)
(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](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
and [Go](https://golang.org/doc/install) on your system. Then, you can run the
following commands to build the binary:
```bash
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](https://github.com/golang/go/wiki/Modules),
which are only supported in Go 1.11 and above.
## Installation
There are various methods availabel to install `stars` on your system:
### Homebrew
```bash
brew install gkze/gkze/gh-stars
```
### Go
```bash
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](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) configured:
```bash
$ 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](LICENSE)