Octotui
🐙🐱🖥️ GitHub stats in your terminal
Install / Use
/learn @irevenko/OctotuiREADME
🐙🐱🖥️ octotui - GitHub stats in terminal
<p align="center"> Data - <a href="https://github.com/irevenko/octostats">irevenko/octostats</a> TUI - <a href="https://github.com/gizak/termui">termui</a> </p> <br> <img src="preview.png">Inspired by <a href="https://github.com/lowlighter/metrics">metrics</a> & <a href="https://github.com/vn7n24fzkq/github-profile-summary-cards">github-profile-summary-cards</a> & <a href="https://github.com/skanehira/github-tui">github-tui</a> 💖
Installation 🔨
go get -u github.com/irevenko/octotui <br>
Token
To generate token go here: https://github.com/settings/tokens <br>
Press Generate new token and select repo:status, read:org, read:user,
and user:email fields<br>
Put this token into HOMEDIR/.config/octotui/token
Usage 🔬
octotui search <USER_OR_ORGANIZATION> <br>
Press Enter to invert image to monochrome color and then Tab to monochrome invert <br>
<img src="avatar.gif" width="250">
TUI
- [x] Profile Image & user basic info/stats
- [x] Most starred, forked repos
- [x] Languages, by repo, commits, stars, forks
- [x] Activity sparkline
- [x] Spinner (while fetching stats)
- [ ] Reconsider colors
- [ ] Tabs with another data like metrics plugins
Contributing 🤝
Contributions, issues and feature requests are welcome! 👍 <br> Feel free to check open issues.
Quick Start 🚀
git clone https://github.com/irevenko/octotui.git <br>
cd octotui <br>
go get -d ./... <br>
go build <br>
What I Learned 🧠
- Advanced termui
License 📑
(c) 2021 Ilya Revenko. MIT License
