Skip to content

antorm1/gh-profile-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

GH Profile CLI πŸ”

A beautiful command-line tool to analyze GitHub profiles and repositories.

Python License CLI

Features

  • πŸ“Š Profile Overview β€” Display user info, stats, and account age
  • ⭐ Top Repositories β€” View most-starred repos with details
  • πŸ—£οΈ Language Breakdown β€” Analyze code languages across repos
  • πŸ“ Export β€” Save analysis as Markdown

Installation

# Clone and install
git clone https://github.com/antorm1/gh-profile-cli.git
cd gh-profile-cli
pip install -e .

# Or install dependencies only
pip install -r requirements.txt

Usage

# Analyze any GitHub profile
gh-profile antorm1

# Show top 10 repos
gh-profile antorm1 --top 10

# Include language breakdown
gh-profile antorm1 --langs

# Export results to markdown
gh-profile antorm1 --langs --export report.md

# Combine options
gh-profile octocat --top 3 --langs --export octocat.md

Output Preview

The tool displays:

  • Profile card with bio, location, and stats
  • Top repositories table with stars, forks, and languages
  • Language breakdown with byte counts and percentages
  • Overall summary with account age

Requirements

  • Python 3.8+
  • requests β€” HTTP requests
  • rich β€” Beautiful terminal output
  • click β€” CLI framework

Project Structure

gh-profile-cli/
β”œβ”€β”€ gh_profile/
β”‚   β”œβ”€β”€ __init__.py      # Package metadata
β”‚   └── main.py          # CLI entry point
β”œβ”€β”€ pyproject.toml        # Build configuration
β”œβ”€β”€ requirements.txt      # Dependencies
└── README.md            # This file

License

MIT License β€” see LICENSE for details.

About

πŸ” Beautiful CLI tool to analyze GitHub profiles and repositories

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages