Crystal GitHub Analyzer

A modern CLI tool written in Crystal to analyze GitHub profiles and display key stats in a stylish, colored terminal output.

Features

• Colored ASCII logo and clean terminal output
• Shows name, followers, public repos, top 3 languages
• Top N repos by stars (with language and link, configurable)
• Total stars, forks, and most used license
• ASCII bar chart for repo activity per year
• Markdown export (--markdown)
• Help option (--help)
• Docker support (prebuilt image available)
• CI with GitHub Actions

Quick Start

With Docker (recommended)

Pull and run directly:

docker pull jakubbbdev/github-analyzer
# Analyze a user:
docker run --rm jakubbbdev/github-analyzer <github-username>
# Example:
docker run --rm jakubbbdev/github-analyzer jakubbbdev

Local (Crystal required)

git clone https://github.com/jakubbbdev/github-analyzer.git
cd github-analyzer
shards install
crystal run src/github_analyzer.cr -- <github-username>

CLI Options

Markdown Export

Generate a Markdown report:

docker run --rm jakubbbdev/github-analyzer --markdown <github-username>

Creates a file: github_<username>_analyse.md

Contributing

Contributions, issues and feature requests are welcome! Feel free to open a PR or issue.

License

MIT

Tips

• Use --no-color if you want plain output for scripts or logs.
• Combine --markdown with --top N to generate detailed reports for your GitHub profile.
• You can run the tool in Docker without installing Crystal locally.
• For large organizations, consider using the GitHub API token for higher rate limits (feature coming soon! (hope so)).
• You can use this tool in CI pipelines for automated GitHub profile reports.

BY JAKUBBBDEV