https://github.com/hedzr/awesome-tool

a command-line tool to retrieve the stars of all repos in an awesome-list
https://github.com/hedzr/awesome-tool

List: awesome-tool

awesome awesome-go awesome-list awesome-lists awesomeness cli cmdr command-line-tool golang mkd-preview stars

Last synced: about 2 months ago
JSON representation

a command-line tool to retrieve the stars of all repos in an awesome-list

• Host: GitHub
• URL: https://github.com/hedzr/awesome-tool
• Owner: hedzr
• License: mit
• Created: 2019-07-17T14:51:12.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-19T12:47:39.000Z (7 months ago)
• Last Synced: 2024-09-21T18:35:23.127Z (about 2 months ago)
• Topics: awesome, awesome-go, awesome-list, awesome-lists, awesomeness, cli, cmdr, command-line-tool, golang, mkd-preview, stars
• Language: Go
• Homepage:
• Size: 513 KB
• Stars: 10
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# awesome-tool

![Go](https://github.com/hedzr/awesome-tool/workflows/Go/badge.svg)

[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/hedzr/awesome-tool.svg?label=release)](https://github.com/hedzr/awesome-tool/releases)

[![go.dev](https://img.shields.io/badge/go-dev-green)](https://pkg.go.dev/github.com/hedzr/awesome-tool)

[![Docker Pulls](https://img.shields.io/docker/pulls/hedzr/awesome-tool.svg)](https://hub.docker.com/r/hedzr/awesome-tool)

`awesome-tool` is a command-line tool to retrieve the stars of all repos in an awesome-list (such as [awesome-go](https://github.com/avelino/awesome-go).

## Installation

### Release

Download the latest release at GitHub Releases Page, please.

### Homebrew (macOS)

```bash

brew install hedzr/brew/awesome-tool

# Or:

brew tap hedzr/brew

brew install awesome-tool

```

## Usage

```bash

awesome-tool build one \

    --name=awesome-go \

    --source=https://github.com/avelino/awesome-go \

    --work-dir=./output

# The results is stored in:

ls -la ./output/aweesome-go/

# open ./output/aweesome-go/output.md  # open it in default browser, such as chrome, ...

```

### Result

The main result is a markdown file `output/awesome-xxx/output.md`, its preview looks like:

![ago-mkd-preview](docs/images/ago-mkd-preview.png)

### Github name and passwd

As running `awesome-tool`, it'll ask for your github account name and password to authorize an access token for Github API. The name and password will be destroy after the token got. But your token will be saved into `$HOME/.asg.stats.token` for the next time, you could always erase the file safely.

The access token is used to request [Github API v3](https://developer.github.com/v3/) and [v4](https://developer.github.com/v4/).

### Contributors is 0 now

We can't query how many contributors via GitHub API v4, currently.

For saving your querying bandwidth, we ignore this count.

## LICENSE

MIT / Apache 2.0