gh-repo-stats

🚀 Overview

Welcome to gh-repo-stats, a refined GitHub CLI extension meticulously designed by Mohammed Aldaraji. This extension serves as a powerful tool in your CLI arsenal, offering instant access to essential statistics of any GitHub repository. With gh-repo-stats, key insights are merely a command away, providing you with a comprehensive overview of a repository's dynamics.

🎯 Purpose

Developed with a vision to streamline access to GitHub repository statistics, gh-repo-stats empowers developers, project managers, and open-source enthusiasts to retrieve crucial data swiftly and efficiently. Whether you're evaluating a project's engagement or monitoring its growth, gh-repo-stats provides the metrics you need directly in your command line.

✨ Key Features and Benefits

• Comprehensive Metrics: Gain insights into a repository's star count, fork count, open issues, watchers, and more.
• Enhanced Readability: With emojis and symbols, the output is not only informative but also visually appealing.
• Streamlined Workflow: gh-repo-stats optimizes your workflow by providing quick access to repository statistics, freeing up more time for development.
• Open Source Collaboration: As an open-source tool, gh-repo-stats welcomes contributions and enhancements from the community, fostering a collaborative environment for improvement.

🌟 Enhanced Repository Statistics

With gh-repo-stats, you can fetch a detailed set of repository statistics adorned with intuitive emojis and symbols, enhancing the interpretability and engagement of the output:

• 🌟 Stars: The number of stars the repository has received.
• 🍴 Forks: The count of forks indicating the repository's reach and collaboration.
• 🔓 Open Issues: The number of unresolved issues, reflecting the repository's activity and community engagement.
• 👀 Watchers: The watcher count, indicating the level of interest in the repository.
• 🔖 Default Branch: The name of the repository's default branch.
• 📦 Archived Status: Indicates whether the repository is archived.
• 👥 Contributors: The total number of contributors to the repository.
• 📌 Total Commits: The total number of commits, reflecting the repository's development activity.

🛠 Installation

Ensure you have the GitHub CLI installed on your system. If it's not yet installed, refer to the official installation guide.

Install gh-repo-stats using the following command:

gh extension install theslash84/gh-repo-stats

Experience the enhanced insights provided by gh-repo-stats with this simple installation!

🔍 Usage

To fetch repository statistics, execute:

gh repo-stats -owner <owner> -repo <repository name>

Example: To retrieve stats for the gh-repo-stats repository:

gh repo-stats -owner theslash84 -repo gh-repo-stats

The command outputs a set of statistics, making repository analysis straightforward and efficient.

🤝 Contributing

Your contributions are invaluable to the continuous evolution of gh-repo-stats. If you have ideas, bug reports, or enhancements, please share them through issues and pull requests. Together, we can make gh-repo-stats even more robust and feature-rich.

📜 License

gh-repo-stats is released under the MIT License. For more details, please refer to the LICENSE file.

🌐 Sharing with GitHub Extension Library

Enhance the visibility of gh-repo-stats by sharing it with the GitHub extension library:

1. Visit your repository on GitHub.
2. Click on the "About" section to the right.
3. Add gh-extension to the "Topics" field.

By incorporating this topic, gh-repo-stats becomes part of a broader collection of GitHub CLI extensions, increasing its discoverability and utility for the community.

Thank you for exploring gh-repo-stats. Here's to many insightful analyses!