github-streak-stats

Simple CLI to show GitHub contribution streak for specified user.

Installation

$ cargo install --git https://github.com/0x6b/github-streak-stats github-streak-stats-cli

Setup

Export GITHUB_TOKEN environment variable with your GitHub personal access token which has read:user scope. You can pass it as an argument as well.

Usage

$ github-streak-stats
╭──────────────────────────────────────────────────────────────────────────────────╮
│   🔥 GitHub contribution stats for https://github.com/0x6b since 2023-08-13 🔥   │
├────────────────────────────────────────┬─────────────────────────────────────────┤
│ Total contributions                    │                                    4170 │
├────────────────────────────────────────┼─────────────────────────────────────────┤
│ Longest and latest streak              │ 253 days, from 2023-12-03 to 2024-08-11 │
├────────────────────────────────────────┼─────────────────────────────────────────┤
│ Current streak                         │ 253 days, from 2023-12-03 to 2024-08-11 │
╰────────────────────────────────────────┴─────────────────────────────────────────╯

Or

See help for detail.

$ github-streak-stats -h
Show GitHub contribution streak. Export `GITHUB_TOKEN` environment variable with your GitHub personal
access token which has `read:user` scope.

Usage: github-streak-stats [OPTIONS] --github-token <GITHUB_TOKEN> [LOGIN]

Arguments:
  [LOGIN]  GitHub login name. Defaults to the login name of the GitHub API token owner

Options:
  -g, --github-token <GITHUB_TOKEN>  GitHub personal access token [env:
                                     GITHUB_TOKEN=ghp_...]
  -f, --from <FROM>                  Start date, in YYYY-MM-DD format. Default value will be the first
                                     Sunday before 52 weeks ago. If specified, it will be the first
                                     Sunday before the specified date
  -t, --to <TO>                      End date, in YYYY-MM-DD format. Please note that the total time
                                     spanned by 'from' and 'to' must not exceed 1 year. Default value
                                     will be the first Saturday after today. If specified, it will be
                                     the first Saturday after the specified date
  -o, --offset <OFFSET>              Offset from UTC, in (+|-)HHMM format [default: +0900]
  -r, --display-public-repositories  Display number of public repositories owned
  -m, --display-matrix               Display contribution matrix
  -e, --theme <THEME>                Theme for the contribution matrix. Possible values: dark, light
                                     [default: dark]
  -h, --help                         Print help
  -V, --version                      Print version

License

MIT. See LICENSE for details.

Reference

• Creating a personal access token - GitHub Docs