|
| 1 | +# gitgame |
| 2 | + |
| 3 | +Gamify your GitHub productivity. Compete with yourself or others! |
| 4 | + |
| 5 | +## Installation |
| 6 | + |
| 7 | +```bash |
| 8 | +# macOS |
| 9 | +brew install langtind/tap/gitgame |
| 10 | + |
| 11 | +# From source |
| 12 | +go install github.com/langtind/gitgame@latest |
| 13 | +``` |
| 14 | + |
| 15 | +**Requires:** [GitHub CLI](https://cli.github.com/) (`gh`) installed and authenticated. |
| 16 | + |
| 17 | +## Usage |
| 18 | + |
| 19 | +### Your Stats |
| 20 | + |
| 21 | +```bash |
| 22 | +$ gitgame me |
| 23 | + |
| 24 | + langtind's GitHub Stats |
| 25 | + ───────────────────────────── |
| 26 | + Total Contributions 4182 |
| 27 | + Commits 214 |
| 28 | + Pull Requests 8 |
| 29 | + Issues 4 |
| 30 | + Repositories 8 |
| 31 | +
|
| 32 | + Current Streak 16 days |
| 33 | + Longest Streak 39 days |
| 34 | +
|
| 35 | + Last 7 Days |
| 36 | + ───────────────────────────── |
| 37 | + Mon Tue Wed Thu Fri Sat Sun |
| 38 | + 52 55 14 24 45 43 13 |
| 39 | +``` |
| 40 | +
|
| 41 | +### Streak Tracking |
| 42 | +
|
| 43 | +```bash |
| 44 | +$ gitgame streak |
| 45 | +
|
| 46 | + Current Streak: 16 days (Nice!) |
| 47 | + Longest Streak: 39 days |
| 48 | +
|
| 49 | + Progress to record: [======== ] 16/39 days |
| 50 | + 24 days to beat your record! |
| 51 | +``` |
| 52 | +
|
| 53 | +### Compare Periods |
| 54 | +
|
| 55 | +```bash |
| 56 | +$ gitgame compare --period week |
| 57 | +
|
| 58 | + Week Comparison |
| 59 | + ═══════════════════════════════════════════════ |
| 60 | + This Week Last Week Change |
| 61 | + ──────── ──────── ────── |
| 62 | + Contributions 13 284 -271 |
| 63 | + Commits 12 3 +9 |
| 64 | + PRs 0 0 = |
| 65 | + Issues 0 0 = |
| 66 | +
|
| 67 | + You're down 271 contributions (-95%). Time to catch up! |
| 68 | +``` |
| 69 | + |
| 70 | +Options: `--period week`, `--period month`, `--period year` |
| 71 | + |
| 72 | +### Repository Leaderboard |
| 73 | + |
| 74 | +```bash |
| 75 | +$ gitgame leaderboard facebook/react |
| 76 | + |
| 77 | + Leaderboard: facebook/react |
| 78 | + ═══════════════════════════════════════════════════════ |
| 79 | + # User Commits Additions Deletions |
| 80 | + ─ ──── ─────── ───────── ───────── |
| 81 | + 1 acdlite [1st] 33 +96348 -76017 |
| 82 | + 2 gnoff [2nd] 28 +80 -80 |
| 83 | + 3 eps1lon [3rd] 27 +1159 -192 |
| 84 | +``` |
| 85 | + |
| 86 | +## Commands |
| 87 | + |
| 88 | +| Command | Description | |
| 89 | +|---------|-------------| |
| 90 | +| `gitgame me` | Show your GitHub stats | |
| 91 | +| `gitgame streak` | Show contribution streak | |
| 92 | +| `gitgame compare` | Compare periods (week/month/year) | |
| 93 | +| `gitgame leaderboard <repo>` | Show repo contributors | |
| 94 | +| `gitgame version` | Print version info | |
| 95 | + |
| 96 | +## License |
| 97 | + |
| 98 | +MIT |
0 commit comments