Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/irevenko/octotui
🐙🐱🖥️ GitHub stats in your terminal
https://github.com/irevenko/octotui
cli github github-api github-app githubapi go go-package golang tui
Last synced: 5 days ago
JSON representation
🐙🐱🖥️ GitHub stats in your terminal
- Host: GitHub
- URL: https://github.com/irevenko/octotui
- Owner: irevenko
- License: mit
- Created: 2021-03-09T09:45:13.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-05-29T06:46:35.000Z (over 3 years ago)
- Last Synced: 2024-08-01T15:11:01.714Z (3 months ago)
- Topics: cli, github, github-api, github-app, githubapi, go, go-package, golang, tui
- Language: Go
- Homepage:
- Size: 1.23 MB
- Stars: 211
- Watchers: 6
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - irevenko/octotui - 🐙🐱🖥️ GitHub stats in your terminal (Go)
README
# 🐙🐱🖥️ octotui - GitHub stats in terminal
> Inspired by metrics & github-profile-summary-cards & github-tui 💖
Data - irevenko/octostats
TUI - termui
# Installation 🔨
```go get -u github.com/irevenko/octotui```
## Token
To generate token go here: https://github.com/settings/tokens
Press ```Generate new token``` and select ```repo:status```, ```read:org```, ```read:user```,
and ```user:email``` fields
Put this token into ```HOMEDIR/.config/octotui/token```
# Usage 🔬
```octotui search ```
Press ```Enter``` to invert image to monochrome color and then ```Tab``` to monochrome invert
# 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](https://github.com/lowlighter/metrics#-metrics-)
# Contributing 🤝
Contributions, issues and feature requests are welcome! 👍
Feel free to check [open issues](https://github.com/irevenko/octotui/issues).
# Quick Start 🚀
```git clone https://github.com/irevenko/octotui.git```
```cd octotui```
```go get -d ./...```
```go build```
# What I Learned 🧠
- Advanced termui
# License 📑
(c) 2021 Ilya Revenko. [MIT License](https://tldrlegal.com/license/mit-license)