gh-grass

README

gh-grass

A CLI tool to check GitHub contribution counts from the terminal with an interactive TUI.

Features

• View GitHub contribution graphs in your terminal
• Check your own contributions
• Search and view other users' contributions
• View organization members' contributions
• Beautiful TUI interface powered by Bubble Tea

Installation

From GitHub Releases (binary)

Download the archive for your OS/architecture from the Releases page, then place gh-grass in your PATH.

From source

git clone https://github.com/umekikazuya/gh-grass.git
cd gh-grass
go install ./cmd/gh-grass

Or using go install:

go install github.com/umekikazuya/gh-grass/cmd/gh-grass@latest

Release

Tagging a version like v1.0.0 triggers GitHub Actions + GoReleaser and publishes multi-platform binaries to GitHub Releases.

Usage

Simply run:

gh-grass

The interactive TUI will guide you through:

1. Viewing your own contributions
2. Searching for other users
3. Viewing organization members

Requirements

• Go 1.25.5 or later (for building from source)
• GitHub CLI (gh command)
• GitHub authentication via gh auth login

Development

Prerequisites

• Go 1.25.5 or later
• GitHub personal access token

Build

go build -o gh-grass ./cmd/gh-grass

Run locally

go run ./cmd/gh-grass

Architecture

The project follows clean architecture principles:

internal/
├── domain/         # Domain models and interfaces
├── infrastructure/ # GitHub API client and authentication
├── ui/            # TUI and command-line interface
└── usecase/       # Business logic

License

See LICENSE file for details.