Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wf001/github-insight
github-insight is a command-line tool for creating insight page of GitHub repository.
https://github.com/wf001/github-insight
cli command-line-tool github golang insights
Last synced: 14 days ago
JSON representation
github-insight is a command-line tool for creating insight page of GitHub repository.
- Host: GitHub
- URL: https://github.com/wf001/github-insight
- Owner: wf001
- License: mit
- Created: 2023-01-01T09:44:22.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-11T11:50:53.000Z (almost 2 years ago)
- Last Synced: 2024-12-08T21:40:01.436Z (14 days ago)
- Topics: cli, command-line-tool, github, golang, insights
- Language: Go
- Homepage:
- Size: 5.45 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# github-insight
github-insight is a command-line tool for creating insight page of GitHub repository.
## Features
- Generate GitHub insight page of specified repository.
- The insight include below data,
- Basic information
- Pie chart of distribution of languages
- Bar chart of daily commit.
- Latest commits
- Pie chart of distribution of committers
- Latest issues
- Issues of beginners
- Stack bar chart of issues.
## Getting started
``` sh
git clone https://github.com/wf001/github-insight
```
and create [Github Personal Access token](https://github.com/settings/tokens), run following command.
``` sh
export GIT_KEY=""
```
``` sh
make build
```
``` sh
./bin/ghi gen /
```
Bob's your uncle! Finally open `github-insight/generated/output.html` with your browser.
Example is [here](https://wf001.github.io/github-insight/)
```
$ ./bin/ghi -h
NAME:
ghi - Github insight page generator
USAGE:
ghi [global options] command [command options] [arguments...]
VERSION:
0.1.1
COMMANDS:
gen generate insight page
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--help, -h show help (default: false)
--version, -v print the version (default: false)
```
Note: GitHub's personal access token has an API call limit within a unit period.
The maximum fetching amount per calling is 100. Thus, for example, running this CLI against a repository with 500 commits and 1000 issues will consume 15, and 4985 API call is available in the remaining hour.
see also [official doc](https://docs.github.com/en/rest/rate-limit?apiVersion=2022-11-28)(this CLI uses only core API)
## Thanks
- [go-echarts/go-echarts](https://github.com/go-echarts/go-echarts)
- [google/go-github](https://github.com/google/go-github)
- [pterm/pterm](https://github.com/pterm/pterm)
## License
Licensed under the MIT License.